all: autogenerated update (2018-01-09) Update: - cloudbilling/v1 - people/v1 - slides/v1 - testing/v1 - youtubereporting/v1
diff --git a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json index 9fbfe71..727a976 100644 --- a/abusiveexperiencereport/v1/abusiveexperiencereport-api.json +++ b/abusiveexperiencereport/v1/abusiveexperiencereport-api.json
@@ -1,10 +1,156 @@ { + "ownerName": "Google", + "resources": { + "sites": { + "methods": { + "get": { + "parameters": { + "name": { + "location": "path", + "description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.", + "required": true, + "type": "string", + "pattern": "^sites/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/xapi.zoo" + ], + "flatPath": "v1/sites/{sitesId}", + "path": "v1/{+name}", + "id": "abusiveexperiencereport.sites.get", + "description": "Gets a summary of the abusive experience rating of a site.", + "response": { + "$ref": "SiteSummaryResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET" + } + } + }, + "violatingSites": { + "methods": { + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ViolatingSitesResponse" + }, + "parameterOrder": [], + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/xapi.zoo" + ], + "flatPath": "v1/violatingSites", + "id": "abusiveexperiencereport.violatingSites.list", + "path": "v1/violatingSites", + "description": "Lists sites with Abusive Experience Report statuses of \"Failing\"." + } + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "type": "string", + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + } + }, + "version": "v1", + "baseUrl": "https://abusiveexperiencereport.googleapis.com/", + "servicePath": "", + "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.", + "kind": "discovery#restDescription", + "basePath": "", + "documentationLink": "https://developers.google.com/abusive-experience-report/", + "id": "abusiveexperiencereport:v1", + "revision": "20171129", "discoveryVersion": "v1", "version_module": true, "schemas": { "ViolatingSitesResponse": { - "id": "ViolatingSitesResponse", - "description": "Response message for ListViolatingSites.", "type": "object", "properties": { "violatingSites": { @@ -14,15 +160,15 @@ "$ref": "SiteSummaryResponse" } } - } + }, + "id": "ViolatingSitesResponse", + "description": "Response message for ListViolatingSites." }, "SiteSummaryResponse": { "description": "Response message for GetSiteSummary.", "type": "object", "properties": { "filterStatus": { - "description": "The abusive experience enforcement status of the site.", - "type": "string", "enumDescriptions": [ "N/A.", "Ad filtering is on.", @@ -36,7 +182,9 @@ "OFF", "PAUSED", "PENDING" - ] + ], + "description": "The abusive experience enforcement status of the site.", + "type": "string" }, "underReview": { "description": "Whether the site is currently under review.", @@ -56,8 +204,6 @@ "type": "string" }, "abusiveStatus": { - "description": "The status of the site reviewed for the abusive experiences.", - "type": "string", "enumDescriptions": [ "Not reviewed.", "Passing.", @@ -67,7 +213,9 @@ "UNKNOWN", "PASSING", "FAILING" - ] + ], + "description": "The status of the site reviewed for the abusive experiences.", + "type": "string" }, "enforcementTime": { "description": "The date on which enforcement begins.", @@ -98,153 +246,5 @@ "name": "abusiveexperiencereport", "batchPath": "batch", "fullyEncodeReservedExpansion": true, - "title": "Google Abusive Experience Report API", - "ownerName": "Google", - "resources": { - "violatingSites": { - "methods": { - "list": { - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/xapi.zoo" - ], - "flatPath": "v1/violatingSites", - "id": "abusiveexperiencereport.violatingSites.list", - "path": "v1/violatingSites", - "description": "Lists sites with Abusive Experience Report statuses of \"Failing\".", - "httpMethod": "GET", - "response": { - "$ref": "ViolatingSitesResponse" - }, - "parameterOrder": [] - } - } - }, - "sites": { - "methods": { - "get": { - "path": "v1/{+name}", - "id": "abusiveexperiencereport.sites.get", - "description": "Gets a summary of the abusive experience rating of a site.", - "response": { - "$ref": "SiteSummaryResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The required site name. This is the site property whose abusive\nexperiences have been reviewed, and it must be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field\nreturned by the API will lead to the verification page, prompting the user\nto go through that process before they can gain access to the Abusive\nExperience Report.", - "required": true, - "type": "string", - "pattern": "^sites/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/xapi.zoo" - ], - "flatPath": "v1/sites/{sitesId}" - } - } - } - }, - "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - } - }, - "version": "v1", - "baseUrl": "https://abusiveexperiencereport.googleapis.com/", - "servicePath": "", - "description": "View Abusive Experience Report data, and get a list of sites that have a significant number of abusive experiences.", - "kind": "discovery#restDescription", - "basePath": "", - "documentationLink": "https://developers.google.com/abusive-experience-report/", - "id": "abusiveexperiencereport:v1", - "revision": "20171129" + "title": "Google Abusive Experience Report API" }
diff --git a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json index ff9587e..0380c8b 100644 --- a/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json +++ b/acceleratedmobilepageurl/v1/acceleratedmobilepageurl-api.json
@@ -1,69 +1,60 @@ { - "kind": "discovery#restDescription", - "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n", - "servicePath": "", "rootUrl": "https://acceleratedmobilepageurl.googleapis.com/", "basePath": "", "ownerDomain": "google.com", "name": "acceleratedmobilepageurl", "batchPath": "batch", - "revision": "20171202", - "documentationLink": "https://developers.google.com/amp/cache/", "id": "acceleratedmobilepageurl:v1", + "documentationLink": "https://developers.google.com/amp/cache/", + "revision": "20171202", "title": "Accelerated Mobile Pages (AMP) URL API", - "ownerName": "Google", "discoveryVersion": "v1", + "ownerName": "Google", "version_module": true, "resources": { "ampUrls": { "methods": { "batchGet": { - "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).", "request": { "$ref": "BatchGetAmpUrlsRequest" }, + "description": "Returns AMP URL(s) and equivalent\n[AMP Cache URL(s)](/amp/cache/overview#amp-cache-url-format).", + "httpMethod": "POST", + "parameterOrder": [], "response": { "$ref": "BatchGetAmpUrlsResponse" }, - "parameterOrder": [], - "httpMethod": "POST", "parameters": {}, "flatPath": "v1/ampUrls:batchGet", - "path": "v1/ampUrls:batchGet", - "id": "acceleratedmobilepageurl.ampUrls.batchGet" + "id": "acceleratedmobilepageurl.ampUrls.batchGet", + "path": "v1/ampUrls:batchGet" } } } }, "parameters": { "upload_protocol": { - "type": "string", "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" }, "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query", - "description": "Returns response with indentations and line breaks." - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "default": "true" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" }, "$.xgafv": { - "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -73,10 +64,15 @@ "1", "2" ], - "description": "V1 error format." + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "alt": { - "location": "query", "description": "Data format for response.", "default": "json", "enum": [ @@ -89,22 +85,23 @@ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" - ] + ], + "location": "query" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" }, "key": { "location": "query", "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.", "type": "string" }, - "access_token": { - "type": "string", - "location": "query", - "description": "OAuth access token." - }, "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.", "type": "string", - "location": "query", - "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" }, "pp": { "location": "query", @@ -112,97 +109,41 @@ "type": "boolean", "default": "true" }, - "bearer_token": { - "type": "string", - "location": "query", - "description": "OAuth bearer token." - }, "oauth_token": { - "location": "query", "description": "OAuth 2.0 token for the current user.", - "type": "string" + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" } }, "schemas": { - "BatchGetAmpUrlsRequest": { - "description": "AMP URL request for a batch of URLs.", - "type": "object", - "properties": { - "urls": { - "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).", - "type": "array", - "items": { - "type": "string" - } - }, - "lookupStrategy": { - "type": "string", - "enumDescriptions": [ - "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.", - "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended." - ], - "enum": [ - "FETCH_LIVE_DOC", - "IN_INDEX_DOC" - ], - "description": "The lookup_strategy being requested." - } - }, - "id": "BatchGetAmpUrlsRequest" - }, - "BatchGetAmpUrlsResponse": { - "description": "Batch AMP URL response.", - "type": "object", - "properties": { - "ampUrls": { - "type": "array", - "items": { - "$ref": "AmpUrl" - }, - "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once." - }, - "urlErrors": { - "description": "The errors for requested URLs that have no AMP URL.", - "type": "array", - "items": { - "$ref": "AmpUrlError" - } - } - }, - "id": "BatchGetAmpUrlsResponse" - }, "AmpUrl": { + "description": "AMP URL response for a requested URL.", "type": "object", "properties": { "cdnAmpUrl": { - "type": "string", - "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache." + "description": "The [AMP Cache URL](/amp/cache/overview#amp-cache-url-format) pointing to\nthe cached document in the Google AMP Cache.", + "type": "string" }, "originalUrl": { - "type": "string", - "description": "The original non-AMP URL." + "description": "The original non-AMP URL.", + "type": "string" }, "ampUrl": { "description": "The AMP URL pointing to the publisher's web server.", "type": "string" } }, - "id": "AmpUrl", - "description": "AMP URL response for a requested URL." + "id": "AmpUrl" }, "AmpUrlError": { - "description": "AMP URL Error resource for a requested URL that couldn't be found.", - "type": "object", "properties": { - "originalUrl": { - "description": "The original non-AMP URL.", - "type": "string" - }, - "errorMessage": { - "type": "string", - "description": "An optional descriptive error message." - }, "errorCode": { + "description": "The error code of an API call.", "type": "string", "enumDescriptions": [ "Not specified error.", @@ -219,18 +160,77 @@ "APPLICATION_ERROR", "URL_IS_VALID_AMP", "URL_IS_INVALID_AMP" - ], - "description": "The error code of an API call." + ] + }, + "originalUrl": { + "description": "The original non-AMP URL.", + "type": "string" + }, + "errorMessage": { + "description": "An optional descriptive error message.", + "type": "string" } }, - "id": "AmpUrlError" + "id": "AmpUrlError", + "description": "AMP URL Error resource for a requested URL that couldn't be found.", + "type": "object" + }, + "BatchGetAmpUrlsRequest": { + "description": "AMP URL request for a batch of URLs.", + "type": "object", + "properties": { + "lookupStrategy": { + "enumDescriptions": [ + "FETCH_LIVE_DOC strategy involves live document fetch of URLs not found in\nthe index. Any request URL not found in the index is crawled in realtime\nto validate if there is a corresponding AMP URL. This strategy has higher\ncoverage but with extra latency introduced by realtime crawling. This is\nthe default strategy. Applications using this strategy should set higher\nHTTP timeouts of the API calls.", + "IN_INDEX_DOC strategy skips fetching live documents of URL(s) not found\nin index. For applications which need low latency use of IN_INDEX_DOC\nstrategy is recommended." + ], + "enum": [ + "FETCH_LIVE_DOC", + "IN_INDEX_DOC" + ], + "description": "The lookup_strategy being requested.", + "type": "string" + }, + "urls": { + "description": "List of URLs to look up for the paired AMP URLs.\nThe URLs are case-sensitive. Up to 50 URLs per lookup\n(see [Usage Limits](/amp/cache/reference/limits)).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "BatchGetAmpUrlsRequest" + }, + "BatchGetAmpUrlsResponse": { + "properties": { + "ampUrls": { + "description": "For each URL in BatchAmpUrlsRequest, the URL response. The response might\nnot be in the same order as URLs in the batch request.\nIf BatchAmpUrlsRequest contains duplicate URLs, AmpUrl is generated\nonly once.", + "type": "array", + "items": { + "$ref": "AmpUrl" + } + }, + "urlErrors": { + "description": "The errors for requested URLs that have no AMP URL.", + "type": "array", + "items": { + "$ref": "AmpUrlError" + } + } + }, + "id": "BatchGetAmpUrlsResponse", + "description": "Batch AMP URL response.", + "type": "object" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "version": "v1", - "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/" + "baseUrl": "https://acceleratedmobilepageurl.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Retrieves the list of AMP URLs (and equivalent AMP Cache URLs) for a given list of public URL(s).\n", + "servicePath": "" }
diff --git a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json index 2d35037..dd36ab6 100644 --- a/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json +++ b/adexchangebuyer2/v2beta1/adexchangebuyer2-api.json
@@ -1,1983 +1,539 @@ { - "ownerName": "Google", - "resources": { - "bidders": { - "resources": { - "filterSets": { - "methods": { - "get": { - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", - "id": "adexchangebuyer2.bidders.filterSets.get", - "path": "v2beta1/{+name}", - "description": "Retrieves the requested filter set for the account with the given account\nID.", - "httpMethod": "GET", - "response": { - "$ref": "FilterSet" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "location": "path", - "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ] - }, - "list": { - "flatPath": "v2beta1/bidders/{biddersId}/filterSets", - "id": "adexchangebuyer2.bidders.filterSets.list", - "path": "v2beta1/{+ownerName}/filterSets", - "description": "Lists all filter sets for the account with the given account ID.", - "httpMethod": "GET", - "response": { - "$ref": "ListFilterSetsResponse" - }, - "parameterOrder": [ - "ownerName" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - }, - "ownerName": { - "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ] - }, - "create": { - "description": "Creates the specified filter set for the account with the given account ID.", - "request": { - "$ref": "FilterSet" - }, - "response": { - "$ref": "FilterSet" - }, - "parameterOrder": [ - "ownerName" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "isTransient": { - "location": "query", - "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.", - "type": "boolean" - }, - "ownerName": { - "location": "path", - "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+$" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/filterSets", - "path": "v2beta1/{+ownerName}/filterSets", - "id": "adexchangebuyer2.bidders.filterSets.create" - }, - "delete": { - "description": "Deletes the requested filter set from the account with the given account\nID.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", - "id": "adexchangebuyer2.bidders.filterSets.delete", - "path": "v2beta1/{+name}" - } - }, - "resources": { - "bidResponseErrors": { - "methods": { - "list": { - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors", - "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list", - "path": "v2beta1/{+filterSetName}/bidResponseErrors", - "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.", - "httpMethod": "GET", - "response": { - "$ref": "ListBidResponseErrorsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ] - } - } - }, - "bidResponsesWithoutBids": { - "methods": { - "list": { - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", - "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids", - "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list", - "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.", - "response": { - "$ref": "ListBidResponsesWithoutBidsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ] - } - } - }, - "filteredBidRequests": { - "methods": { - "list": { - "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.", - "response": { - "$ref": "ListFilteredBidRequestsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests", - "path": "v2beta1/{+filterSetName}/filteredBidRequests", - "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list" - } - } - }, - "nonBillableWinningBids": { - "methods": { - "list": { - "response": { - "$ref": "ListNonBillableWinningBidsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.", - "type": "string" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids", - "path": "v2beta1/{+filterSetName}/nonBillableWinningBids", - "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list", - "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason." - } - } - }, - "filteredBids": { - "methods": { - "list": { - "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.", - "httpMethod": "GET", - "parameterOrder": [ - "filterSetName" - ], - "response": { - "$ref": "ListFilteredBidsResponse" - }, - "parameters": { - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - }, - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids", - "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list", - "path": "v2beta1/{+filterSetName}/filteredBids" - } - }, - "resources": { - "creatives": { - "methods": { - "list": { - "httpMethod": "GET", - "response": { - "$ref": "ListCreativeStatusBreakdownByCreativeResponse" - }, - "parameterOrder": [ - "filterSetName", - "creativeStatusId" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - }, - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "creativeStatusId": { - "location": "path", - "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).", - "format": "int32", - "required": true, - "type": "integer" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", - "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list", - "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives", - "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative." - } - } - }, - "details": { - "methods": { - "list": { - "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.", - "httpMethod": "GET", - "parameterOrder": [ - "filterSetName", - "creativeStatusId" - ], - "response": { - "$ref": "ListCreativeStatusBreakdownByDetailResponse" - }, - "parameters": { - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - }, - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$" - }, - "creativeStatusId": { - "location": "path", - "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", - "format": "int32", - "required": true, - "type": "integer" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", - "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list", - "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details" - } - } - } - } - }, - "losingBids": { - "methods": { - "list": { - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids", - "id": "adexchangebuyer2.bidders.filterSets.losingBids.list", - "path": "v2beta1/{+filterSetName}/losingBids", - "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.", - "httpMethod": "GET", - "parameterOrder": [ - "filterSetName" - ], - "response": { - "$ref": "ListLosingBidsResponse" - }, - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ] - } - } - }, - "bidMetrics": { - "methods": { - "list": { - "description": "Lists all metrics that are measured in terms of number of bids.", - "httpMethod": "GET", - "parameterOrder": [ - "filterSetName" - ], - "response": { - "$ref": "ListBidMetricsResponse" - }, - "parameters": { - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics", - "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list", - "path": "v2beta1/{+filterSetName}/bidMetrics" - } - } - }, - "impressionMetrics": { - "methods": { - "list": { - "description": "Lists all metrics that are measured in terms of number of impressions.", - "response": { - "$ref": "ListImpressionMetricsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics", - "path": "v2beta1/{+filterSetName}/impressionMetrics", - "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list" - } - } - } - } - }, - "accounts": { - "resources": { - "filterSets": { - "methods": { - "get": { - "response": { - "$ref": "FilterSet" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", - "path": "v2beta1/{+name}", - "id": "adexchangebuyer2.bidders.accounts.filterSets.get", - "description": "Retrieves the requested filter set for the account with the given account\nID." - }, - "list": { - "description": "Lists all filter sets for the account with the given account ID.", - "httpMethod": "GET", - "parameterOrder": [ - "ownerName" - ], - "response": { - "$ref": "ListFilterSetsResponse" - }, - "parameters": { - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - }, - "ownerName": { - "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", - "id": "adexchangebuyer2.bidders.accounts.filterSets.list", - "path": "v2beta1/{+ownerName}/filterSets" - }, - "create": { - "description": "Creates the specified filter set for the account with the given account ID.", - "request": { - "$ref": "FilterSet" - }, - "response": { - "$ref": "FilterSet" - }, - "parameterOrder": [ - "ownerName" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "isTransient": { - "location": "query", - "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.", - "type": "boolean" - }, - "ownerName": { - "location": "path", - "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+$" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", - "path": "v2beta1/{+ownerName}/filterSets", - "id": "adexchangebuyer2.bidders.accounts.filterSets.create" - }, - "delete": { - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", - "path": "v2beta1/{+name}", - "id": "adexchangebuyer2.bidders.accounts.filterSets.delete", - "description": "Deletes the requested filter set from the account with the given account\nID.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "name": { - "location": "path", - "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - } - } - } - }, - "resources": { - "nonBillableWinningBids": { - "methods": { - "list": { - "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.", - "response": { - "$ref": "ListNonBillableWinningBidsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids", - "path": "v2beta1/{+filterSetName}/nonBillableWinningBids", - "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list" - } - } - }, - "filteredBids": { - "methods": { - "list": { - "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.", - "response": { - "$ref": "ListFilteredBidsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids", - "path": "v2beta1/{+filterSetName}/filteredBids", - "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list" - } - }, - "resources": { - "creatives": { - "methods": { - "list": { - "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.", - "httpMethod": "GET", - "response": { - "$ref": "ListCreativeStatusBreakdownByCreativeResponse" - }, - "parameterOrder": [ - "filterSetName", - "creativeStatusId" - ], - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - }, - "creativeStatusId": { - "location": "path", - "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).", - "format": "int32", - "required": true, - "type": "integer" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", - "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list", - "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives" - } - } - }, - "details": { - "methods": { - "list": { - "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.", - "response": { - "$ref": "ListCreativeStatusBreakdownByDetailResponse" - }, - "parameterOrder": [ - "filterSetName", - "creativeStatusId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "creativeStatusId": { - "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", - "format": "int32", - "required": true, - "type": "integer", - "location": "path" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", - "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details", - "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list" - } - } - } - } - }, - "losingBids": { - "methods": { - "list": { - "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.", - "response": { - "$ref": "ListLosingBidsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids", - "path": "v2beta1/{+filterSetName}/losingBids", - "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list" - } - } - }, - "bidMetrics": { - "methods": { - "list": { - "description": "Lists all metrics that are measured in terms of number of bids.", - "httpMethod": "GET", - "response": { - "$ref": "ListBidMetricsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics", - "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list", - "path": "v2beta1/{+filterSetName}/bidMetrics" - } - } - }, - "impressionMetrics": { - "methods": { - "list": { - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics", - "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list", - "path": "v2beta1/{+filterSetName}/impressionMetrics", - "description": "Lists all metrics that are measured in terms of number of impressions.", - "httpMethod": "GET", - "parameterOrder": [ - "filterSetName" - ], - "response": { - "$ref": "ListImpressionMetricsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.", - "type": "string" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - } - } - } - }, - "bidResponseErrors": { - "methods": { - "list": { - "response": { - "$ref": "ListBidResponseErrorsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "filterSetName": { - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.", - "type": "string" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors", - "path": "v2beta1/{+filterSetName}/bidResponseErrors", - "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list", - "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason." - } - } - }, - "bidResponsesWithoutBids": { - "methods": { - "list": { - "httpMethod": "GET", - "response": { - "$ref": "ListBidResponsesWithoutBidsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", - "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list", - "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids", - "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason." - } - } - }, - "filteredBidRequests": { - "methods": { - "list": { - "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.", - "httpMethod": "GET", - "response": { - "$ref": "ListFilteredBidRequestsResponse" - }, - "parameterOrder": [ - "filterSetName" - ], - "parameters": { - "filterSetName": { - "location": "path", - "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", - "required": true, - "type": "string", - "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests", - "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list", - "path": "v2beta1/{+filterSetName}/filteredBidRequests" - } - } - } - } - } - } - } - } - }, - "accounts": { - "resources": { - "clients": { - "methods": { - "get": { - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", - "id": "adexchangebuyer2.accounts.clients.get", - "description": "Gets a client buyer with a given client account ID.", - "response": { - "$ref": "Client" - }, - "parameterOrder": [ - "accountId", - "clientAccountId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "description": "Numerical account ID of the client's sponsor buyer. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - }, - "clientAccountId": { - "description": "Numerical account ID of the client buyer to retrieve. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "list": { - "description": "Lists all the clients for the current sponsor buyer.", - "response": { - "$ref": "ListClientsResponse" - }, - "parameterOrder": [ - "accountId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.", - "type": "string", - "location": "query" - }, - "partnerClientId": { - "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response.", - "type": "string", - "location": "query" - }, - "accountId": { - "description": "Unique numerical account ID of the sponsor buyer to list the clients for.", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/clients", - "path": "v2beta1/accounts/{accountId}/clients", - "id": "adexchangebuyer2.accounts.clients.list" - }, - "update": { - "request": { - "$ref": "Client" - }, - "description": "Updates an existing client buyer.", - "httpMethod": "PUT", - "parameterOrder": [ - "accountId", - "clientAccountId" - ], - "response": { - "$ref": "Client" - }, - "parameters": { - "accountId": { - "location": "path", - "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)", - "format": "int64", - "required": true, - "type": "string" - }, - "clientAccountId": { - "location": "path", - "description": "Unique numerical account ID of the client to update. (required)", - "format": "int64", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", - "id": "adexchangebuyer2.accounts.clients.update", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}" - }, - "create": { - "description": "Creates a new client buyer.", - "request": { - "$ref": "Client" - }, - "response": { - "$ref": "Client" - }, - "parameterOrder": [ - "accountId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)", - "format": "int64", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/clients", - "path": "v2beta1/accounts/{accountId}/clients", - "id": "adexchangebuyer2.accounts.clients.create" - } - }, - "resources": { - "invitations": { - "methods": { - "get": { - "description": "Retrieves an existing client user invitation.", - "response": { - "$ref": "ClientUserInvitation" - }, - "parameterOrder": [ - "accountId", - "clientAccountId", - "invitationId" - ], - "httpMethod": "GET", - "parameters": { - "accountId": { - "location": "path", - "description": "Numerical account ID of the client's sponsor buyer. (required)", - "format": "int64", - "required": true, - "type": "string" - }, - "clientAccountId": { - "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - }, - "invitationId": { - "description": "Numerical identifier of the user invitation to retrieve. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}", - "id": "adexchangebuyer2.accounts.clients.invitations.get" - }, - "list": { - "description": "Lists all the client users invitations for a client\nwith a given account ID.", - "httpMethod": "GET", - "response": { - "$ref": "ListClientUserInvitationsResponse" - }, - "parameterOrder": [ - "accountId", - "clientAccountId" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "Numerical account ID of the client's sponsor buyer. (required)", - "format": "int64", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "clientAccountId": { - "location": "path", - "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", - "id": "adexchangebuyer2.accounts.clients.invitations.list", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations" - }, - "create": { - "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.", - "request": { - "$ref": "ClientUserInvitation" - }, - "httpMethod": "POST", - "parameterOrder": [ - "accountId", - "clientAccountId" - ], - "response": { - "$ref": "ClientUserInvitation" - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "Numerical account ID of the client's sponsor buyer. (required)", - "format": "int64", - "required": true, - "type": "string" - }, - "clientAccountId": { - "location": "path", - "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", - "format": "int64", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", - "id": "adexchangebuyer2.accounts.clients.invitations.create", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations" - } - } - }, - "users": { - "methods": { - "list": { - "description": "Lists all the known client users for a specified\nsponsor buyer account ID.", - "response": { - "$ref": "ListClientUsersResponse" - }, - "parameterOrder": [ - "accountId", - "clientAccountId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.", - "type": "string", - "location": "query" - }, - "accountId": { - "location": "path", - "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)", - "format": "int64", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "clientAccountId": { - "location": "path", - "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", - "id": "adexchangebuyer2.accounts.clients.users.list" - }, - "get": { - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", - "id": "adexchangebuyer2.accounts.clients.users.get", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", - "description": "Retrieves an existing client user.", - "httpMethod": "GET", - "response": { - "$ref": "ClientUser" - }, - "parameterOrder": [ - "accountId", - "clientAccountId", - "userId" - ], - "parameters": { - "accountId": { - "description": "Numerical account ID of the client's sponsor buyer. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - }, - "clientAccountId": { - "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - }, - "userId": { - "description": "Numerical identifier of the user to retrieve. (required)", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ] - }, - "update": { - "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", - "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", - "id": "adexchangebuyer2.accounts.clients.users.update", - "description": "Updates an existing client user.\nOnly the user status can be changed on update.", - "request": { - "$ref": "ClientUser" - }, - "response": { - "$ref": "ClientUser" - }, - "parameterOrder": [ - "accountId", - "clientAccountId", - "userId" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "Numerical account ID of the client's sponsor buyer. (required)", - "format": "int64", - "required": true, - "type": "string" - }, - "clientAccountId": { - "location": "path", - "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)", - "format": "int64", - "required": true, - "type": "string" - }, - "userId": { - "location": "path", - "description": "Numerical identifier of the user to retrieve. (required)", - "format": "int64", - "required": true, - "type": "string" - } - } - } - } - } - } - }, - "creatives": { - "methods": { - "list": { - "description": "Lists creatives.", - "response": { - "$ref": "ListCreativesResponse" - }, - "parameterOrder": [ - "accountId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "pageToken": { - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.", - "type": "string", - "location": "query" - }, - "accountId": { - "location": "path", - "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.", - "required": true, - "type": "string" - }, - "pageSize": { - "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "query": { - "location": "query", - "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason}\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'", - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/creatives", - "path": "v2beta1/accounts/{accountId}/creatives", - "id": "adexchangebuyer2.accounts.creatives.list" - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "accountId" - ], - "response": { - "$ref": "Creative" - }, - "parameters": { - "duplicateIdMode": { - "location": "query", - "enum": [ - "NO_DUPLICATES", - "FORCE_ENABLE_DUPLICATE_IDS" - ], - "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative).", - "type": "string" - }, - "accountId": { - "location": "path", - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "required": true, - "type": "string" - }, - "accountId1": { - "location": "query", - "description": "The account the creative belongs to.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/accounts/{accountId}/creatives", - "id": "adexchangebuyer2.accounts.creatives.create", - "path": "v2beta1/accounts/{accountId}/creatives", - "request": { - "$ref": "Creative" - }, - "description": "Creates a creative." - }, - "stopWatching": { - "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status.", - "request": { - "$ref": "StopWatchingCreativeRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "description": "The account of the creative to stop notifications for.", - "required": true, - "type": "string", - "location": "path" - }, - "creativeId": { - "location": "path", - "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching", - "id": "adexchangebuyer2.accounts.creatives.stopWatching" - }, - "get": { - "response": { - "$ref": "Creative" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "The account the creative belongs to.", - "required": true, - "type": "string" - }, - "creativeId": { - "location": "path", - "description": "The ID of the creative to retrieve.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}", - "id": "adexchangebuyer2.accounts.creatives.get", - "description": "Gets a creative." - }, - "watch": { - "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.", - "request": { - "$ref": "WatchCreativeRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "description": "The account of the creative to watch.", - "required": true, - "type": "string", - "location": "path" - }, - "creativeId": { - "location": "path", - "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", - "id": "adexchangebuyer2.accounts.creatives.watch" - }, - "update": { - "request": { - "$ref": "Creative" - }, - "description": "Updates a creative.", - "response": { - "$ref": "Creative" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "PUT", - "parameters": { - "accountId": { - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "required": true, - "type": "string", - "location": "path" - }, - "creativeId": { - "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "required": true, - "type": "string", - "location": "path" - }, - "accountId1": { - "location": "query", - "description": "The account the creative belongs to.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}", - "id": "adexchangebuyer2.accounts.creatives.update" - } - }, - "resources": { - "dealAssociations": { - "methods": { - "list": { - "description": "List all creative-deal associations.", - "response": { - "$ref": "ListDealAssociationsResponse" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "GET", - "parameters": { - "accountId": { - "location": "path", - "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.", - "required": true, - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.", - "format": "int32", - "type": "integer" - }, - "query": { - "location": "query", - "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'", - "type": "string" - }, - "creativeId": { - "location": "path", - "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations", - "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list" - }, - "add": { - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add", - "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add", - "description": "Associate an existing deal with a creative.", - "request": { - "$ref": "AddDealAssociationRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "The account the creative belongs to.", - "required": true, - "type": "string" - }, - "creativeId": { - "description": "The ID of the creative associated with the deal.", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "remove": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "accountId", - "creativeId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/adexchange.buyer" - ], - "parameters": { - "accountId": { - "location": "path", - "description": "The account the creative belongs to.", - "required": true, - "type": "string" - }, - "creativeId": { - "location": "path", - "description": "The ID of the creative associated with the deal.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove", - "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove", - "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove", - "description": "Remove the association between a deal and a creative.", - "request": { - "$ref": "RemoveDealAssociationRequest" - } - } - } - } - } - } - } - } - }, - "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "key": { - "location": "query", - "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.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - } - }, - "version": "v2beta1", - "baseUrl": "https://adexchangebuyer.googleapis.com/", - "servicePath": "", - "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.", - "kind": "discovery#restDescription", "basePath": "", - "revision": "20180104", + "revision": "20180105", "documentationLink": "https://developers.google.com/ad-exchange/buyer-rest/reference/rest/", "id": "adexchangebuyer2:v2beta1", "discoveryVersion": "v1", "version_module": true, "schemas": { + "ListFilterSetsResponse": { + "description": "Response message for listing filter sets.", + "type": "object", + "properties": { + "filterSets": { + "description": "The filter sets belonging to the buyer.", + "type": "array", + "items": { + "$ref": "FilterSet" + } + }, + "nextPageToken": { + "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.", + "type": "string" + } + }, + "id": "ListFilterSetsResponse" + }, + "BidResponseWithoutBidsStatusRow": { + "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.", + "type": "object", + "properties": { + "impressionCount": { + "$ref": "MetricValue", + "description": "The number of impressions for which there was a bid response with the\nspecified status." + }, + "status": { + "enumDescriptions": [ + "A placeholder for an undefined status.\nThis value will never be returned in responses.", + "The response had no bids.", + "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.", + "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "RESPONSES_WITHOUT_BIDS", + "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", + "RESPONSES_WITHOUT_BIDS_FOR_DEAL" + ], + "description": "The status specifying why the bid responses were considered to have no\napplicable bids.", + "type": "string" + }, + "rowDimensions": { + "$ref": "RowDimensions", + "description": "The values of all dimensions associated with metric values in this row." + } + }, + "id": "BidResponseWithoutBidsStatusRow" + }, + "ClientUserInvitation": { + "properties": { + "email": { + "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.", + "type": "string" + }, + "clientAccountId": { + "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.", + "format": "int64", + "type": "string" + }, + "invitationId": { + "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.", + "format": "int64", + "type": "string" + } + }, + "id": "ClientUserInvitation", + "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.", + "type": "object" + }, + "ListClientUsersResponse": { + "type": "object", + "properties": { + "users": { + "description": "The returned list of client users.", + "type": "array", + "items": { + "$ref": "ClientUser" + } + }, + "nextPageToken": { + "type": "string", + "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results." + } + }, + "id": "ListClientUsersResponse" + }, + "ListCreativeStatusBreakdownByDetailResponse": { + "description": "Response message for listing all details associated with a given filtered bid\nreason.", + "type": "object", + "properties": { + "filteredBidDetailRows": { + "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.", + "type": "array", + "items": { + "$ref": "FilteredBidDetailRow" + } + }, + "nextPageToken": { + "type": "string", + "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.list\nmethod to retrieve the next page of results." + }, + "detailType": { + "description": "The type of detail that the detail IDs represent.", + "type": "string", + "enumDescriptions": [ + "A placeholder for an undefined status.\nThis value will never be returned in responses.", + "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).", + "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", + "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).", + "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).", + "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)." + ], + "enum": [ + "DETAIL_TYPE_UNSPECIFIED", + "CREATIVE_ATTRIBUTE", + "VENDOR", + "SENSITIVE_CATEGORY", + "PRODUCT_CATEGORY", + "DISAPPROVAL_REASON" + ] + } + }, + "id": "ListCreativeStatusBreakdownByDetailResponse" + }, + "ListClientUserInvitationsResponse": { + "type": "object", + "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", + "type": "string" + }, + "invitations": { + "description": "The returned list of client users.", + "type": "array", + "items": { + "$ref": "ClientUserInvitation" + } + } + }, + "id": "ListClientUserInvitationsResponse" + }, + "LocationContext": { + "description": "@OutputOnly The Geo criteria the restriction applies to.", + "type": "object", + "properties": { + "geoCriteriaIds": { + "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "id": "LocationContext" + }, + "PlatformContext": { + "description": "@OutputOnly The type of platform the restriction applies to.", + "type": "object", + "properties": { + "platforms": { + "enumDescriptions": [ + "Desktop platform.", + "Android platform.", + "iOS platform." + ], + "description": "The platforms this restriction applies to.", + "type": "array", + "items": { + "enum": [ + "DESKTOP", + "ANDROID", + "IOS" + ], + "type": "string" + } + } + }, + "id": "PlatformContext" + }, + "MetricValue": { + "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).", + "type": "object", + "properties": { + "variance": { + "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value", + "format": "int64", + "type": "string" + }, + "value": { + "description": "The expected value of the metric.", + "format": "int64", + "type": "string" + } + }, + "id": "MetricValue" + }, + "ClientUser": { + "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.", + "type": "object", + "properties": { + "clientAccountId": { + "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.", + "format": "int64", + "type": "string" + }, + "status": { + "enumDescriptions": [ + "A placeholder for an undefined user status.", + "A user who was already created but hasn't accepted the invitation yet.", + "A user that is currently active.", + "A user that is currently disabled." + ], + "enum": [ + "USER_STATUS_UNSPECIFIED", + "PENDING", + "ACTIVE", + "DISABLED" + ], + "description": "The status of the client user.", + "type": "string" + }, + "userId": { + "type": "string", + "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.", + "format": "int64" + }, + "email": { + "description": "User's email address. The value of this field\nis ignored in an update operation.", + "type": "string" + } + }, + "id": "ClientUser" + }, + "CreativeDealAssociation": { + "description": "The association between a creative and a deal.", + "type": "object", + "properties": { + "accountId": { + "description": "The account the creative belongs to.", + "type": "string" + }, + "creativeId": { + "description": "The ID of the creative associated with the deal.", + "type": "string" + }, + "dealsId": { + "description": "The externalDealId for the deal associated with the creative.", + "type": "string" + } + }, + "id": "CreativeDealAssociation" + }, + "Creative": { + "description": "A creative and its classification data.", + "type": "object", + "properties": { + "filteringStats": { + "$ref": "FilteringStats", + "description": "@OutputOnly The filtering stats for this creative." + }, + "attributes": { + "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "type": "array", + "items": { + "enum": [ + "ATTRIBUTE_UNSPECIFIED", + "IS_TAGGED", + "IS_COOKIE_TARGETED", + "IS_USER_INTEREST_TARGETED", + "EXPANDING_DIRECTION_NONE", + "EXPANDING_DIRECTION_UP", + "EXPANDING_DIRECTION_DOWN", + "EXPANDING_DIRECTION_LEFT", + "EXPANDING_DIRECTION_RIGHT", + "EXPANDING_DIRECTION_UP_LEFT", + "EXPANDING_DIRECTION_UP_RIGHT", + "EXPANDING_DIRECTION_DOWN_LEFT", + "EXPANDING_DIRECTION_DOWN_RIGHT", + "EXPANDING_DIRECTION_UP_OR_DOWN", + "EXPANDING_DIRECTION_LEFT_OR_RIGHT", + "EXPANDING_DIRECTION_ANY_DIAGONAL", + "EXPANDING_ACTION_ROLLOVER_TO_EXPAND", + "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH", + "RICH_MEDIA_CAPABILITY_TYPE_MRAID", + "RICH_MEDIA_CAPABILITY_TYPE_SSL", + "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL", + "NATIVE_ELIGIBILITY_ELIGIBLE", + "NATIVE_ELIGIBILITY_NOT_ELIGIBLE", + "RENDERING_SIZELESS_ADX" + ], + "type": "string" + }, + "enumDescriptions": [ + "Do not use. This is a placeholder value only.", + "The creative is tagged.", + "The creative is cookie targeted.", + "The creative is user interest targeted.", + "The creative does not expand.", + "The creative expands up.", + "The creative expands down.", + "The creative expands left.", + "The creative expands right.", + "The creative expands up and left.", + "The creative expands up and right.", + "The creative expands down and left.", + "The creative expands down and right.", + "The creative expands up or down.", + "The creative expands left or right.", + "The creative expands on any diagonal.", + "The creative expands when rolled over.", + "The instream vast video type is vpaid flash.", + "The creative is MRAID", + "The creative is SSL.", + "The creative is an interstitial.", + "The creative is eligible for native.", + "The creative is not eligible for native.", + "The creative can dynamically resize to fill a variety of slot sizes." + ] + }, + "apiUpdateTime": { + "description": "@OutputOnly The last update timestamp of the creative via API.", + "format": "google-datetime", + "type": "string" + }, + "detectedLanguages": { + "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.", + "type": "array", + "items": { + "type": "string" + } + }, + "creativeId": { + "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "type": "string" + }, + "accountId": { + "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "type": "string" + }, + "native": { + "$ref": "NativeContent", + "description": "A native creative." + }, + "servingRestrictions": { + "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).", + "type": "array", + "items": { + "$ref": "ServingRestriction" + } + }, + "video": { + "description": "A video creative.", + "$ref": "VideoContent" + }, + "agencyId": { + "description": "The agency ID for this creative.", + "format": "int64", + "type": "string" + }, + "clickThroughUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of destination URLs for the creative." + }, + "adChoicesDestinationUrl": { + "description": "The link to AdChoices destination page.", + "type": "string" + }, + "detectedSensitiveCategories": { + "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "restrictedCategories": { + "enumDescriptions": [ + "The ad has no restricted categories", + "The alcohol restricted category." + ], + "description": "All restricted categories for the ads that may be shown from this creative.", + "type": "array", + "items": { + "enum": [ + "NO_RESTRICTED_CATEGORIES", + "ALCOHOL" + ], + "type": "string" + } + }, + "corrections": { + "description": "@OutputOnly Shows any corrections that were applied to this creative.", + "type": "array", + "items": { + "$ref": "Correction" + } + }, + "version": { + "description": "@OutputOnly The version of this creative.", + "format": "int32", + "type": "integer" + }, + "vendorIds": { + "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "impressionTrackingUrls": { + "description": "The set of URLs to be called to record an impression.", + "type": "array", + "items": { + "type": "string" + } + }, + "html": { + "description": "An HTML creative.", + "$ref": "HtmlContent" + }, + "dealsStatus": { + "enumDescriptions": [ + "The status is unknown.", + "The creative has not been checked.", + "The creative has been conditionally approved.\nSee serving_restrictions for details.", + "The creative has been approved.", + "The creative has been disapproved." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_CHECKED", + "CONDITIONALLY_APPROVED", + "APPROVED", + "DISAPPROVED" + ], + "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "type": "string" + }, + "detectedProductCategories": { + "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + }, + "openAuctionStatus": { + "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "type": "string", + "enumDescriptions": [ + "The status is unknown.", + "The creative has not been checked.", + "The creative has been conditionally approved.\nSee serving_restrictions for details.", + "The creative has been approved.", + "The creative has been disapproved." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "NOT_CHECKED", + "CONDITIONALLY_APPROVED", + "APPROVED", + "DISAPPROVED" + ] + }, + "advertiserName": { + "description": "The name of the company being advertised in the creative.", + "type": "string" + }, + "detectedAdvertiserIds": { + "description": "@OutputOnly Detected advertiser IDs, if any.", + "type": "array", + "items": { + "format": "int64", + "type": "string" + } + }, + "detectedDomains": { + "type": "array", + "items": { + "type": "string" + }, + "description": "@OutputOnly\nThe detected domains for this creative." + } + }, + "id": "Creative" + }, + "FilteringStats": { + "id": "FilteringStats", + "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).", + "type": "object", + "properties": { + "reasons": { + "description": "The set of filtering reasons for this date.", + "type": "array", + "items": { + "$ref": "Reason" + } + }, + "date": { + "$ref": "Date", + "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24." + } + } + }, "RemoveDealAssociationRequest": { "description": "A request for removing the association between a deal and a creative.", "type": "object", "properties": { "association": { - "description": "The association between a creative and a deal that should be removed.", - "$ref": "CreativeDealAssociation" + "$ref": "CreativeDealAssociation", + "description": "The association between a creative and a deal that should be removed." } }, "id": "RemoveDealAssociationRequest" }, - "ListCreativeStatusBreakdownByCreativeResponse": { - "description": "Response message for listing all creatives associated with a given filtered\nbid reason.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results.", - "type": "string" - }, - "filteredBidCreativeRows": { - "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative.", - "type": "array", - "items": { - "$ref": "FilteredBidCreativeRow" - } - } - }, - "id": "ListCreativeStatusBreakdownByCreativeResponse" - }, "Client": { "description": "A client resource represents a client buyer—an agency,\na brand, or an advertiser customer of the sponsor buyer.\nUsers associated with the client buyer have restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the client buyer.\nAll fields are required unless otherwise specified.", "type": "object", "properties": { "entityType": { + "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", + "type": "string", "enumDescriptions": [ "A placeholder for an undefined client entity type. Should not be used.", "An advertiser.", @@ -1989,17 +545,13 @@ "ADVERTISER", "BRAND", "AGENCY" - ], - "description": "The type of the client entity: `ADVERTISER`, `BRAND`, or `AGENCY`.", - "type": "string" + ] }, "clientName": { "description": "Name used to represent this client to publishers.\nYou may have multiple clients that map to the same entity,\nbut for each client the combination of `clientName` and entity\nmust be unique.\nYou can specify this field as empty.", "type": "string" }, "role": { - "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", - "type": "string", "enumDescriptions": [ "A placeholder for an undefined client role.", "Users associated with this client can see publisher deal offers\nin the Marketplace.\nThey can neither negotiate proposals nor approve deals.\nIf this client is visible to publishers, they can send deal proposals\nto this client.", @@ -2011,7 +563,9 @@ "CLIENT_DEAL_VIEWER", "CLIENT_DEAL_NEGOTIATOR", "CLIENT_DEAL_APPROVER" - ] + ], + "description": "The role which is assigned to the client buyer. Each role implies a set of\npermissions granted to the client. Must be one of `CLIENT_DEAL_VIEWER`,\n`CLIENT_DEAL_NEGOTIATOR` or `CLIENT_DEAL_APPROVER`.", + "type": "string" }, "visibleToSeller": { "description": "Whether the client buyer will be visible to sellers.", @@ -2052,32 +606,29 @@ }, "id": "Client" }, + "ListCreativeStatusBreakdownByCreativeResponse": { + "description": "Response message for listing all creatives associated with a given filtered\nbid reason.", + "type": "object", + "properties": { + "nextPageToken": { + "type": "string", + "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByCreativeRequest.pageToken\nfield in the subsequent call to the filteredBids.creatives.list\nmethod to retrieve the next page of results." + }, + "filteredBidCreativeRows": { + "type": "array", + "items": { + "$ref": "FilteredBidCreativeRow" + }, + "description": "List of rows, with counts of bids with a given creative status aggregated\nby creative." + } + }, + "id": "ListCreativeStatusBreakdownByCreativeResponse" + }, "Correction": { "description": "@OutputOnly Shows any corrections that were applied to this creative.", "type": "object", "properties": { - "details": { - "description": "Additional details about what was corrected.", - "type": "array", - "items": { - "type": "string" - } - }, "type": { - "enumDescriptions": [ - "The correction type is unknown. Refer to the details for more information.", - "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.", - "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.", - "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.", - "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.", - "The ad did not declare a required creative attribute.\nThe attribute was added.", - "The ad did not declare a required technology vendor.\nThe technology vendor was added.", - "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.", - "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.", - "The ad makes calls to the MRAID API so the MRAID attribute was added.", - "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.", - "The ad contains video content." - ], "enum": [ "CORRECTION_TYPE_UNSPECIFIED", "VENDOR_IDS_ADDED", @@ -2093,7 +644,21 @@ "VIDEO_IN_SNIPPET_ATTRIBUTE_ADDED" ], "description": "The type of correction that was applied to the creative.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "The correction type is unknown. Refer to the details for more information.", + "The ad's declared vendors did not match the vendors that were detected.\nThe detected vendors were added.", + "The ad had the SSL attribute declared but was not SSL-compliant.\nThe SSL attribute was removed.", + "The ad was declared as Flash-free but contained Flash, so the Flash-free\nattribute was removed.", + "The ad was not declared as Flash-free but it did not reference any flash\ncontent, so the Flash-free attribute was added.", + "The ad did not declare a required creative attribute.\nThe attribute was added.", + "The ad did not declare a required technology vendor.\nThe technology vendor was added.", + "The ad did not declare the SSL attribute but was SSL-compliant, so the\nSSL attribute was added.", + "Properties consistent with In-banner video were found, so an\nIn-Banner Video attribute was added.", + "The ad makes calls to the MRAID API so the MRAID attribute was added.", + "The ad unnecessarily declared the Flash attribute, so the Flash attribute\nwas removed.", + "The ad contains video content." + ] }, "contexts": { "description": "The contexts for the correction.", @@ -2101,6 +666,13 @@ "items": { "$ref": "ServingContext" } + }, + "details": { + "description": "Additional details about what was corrected.", + "type": "array", + "items": { + "type": "string" + } } }, "id": "Correction" @@ -2109,86 +681,32 @@ "description": "A set of filters that is applied to a request for data.\nWithin a filter set, an AND operation is performed across the filters\nrepresented by each field. An OR operation is performed across the filters\nrepresented by the multiple values of a repeated field. E.g.\n\"format=VIDEO AND deal_id=12 AND (seller_network_id=34 OR\nseller_network_id=56)\"", "type": "object", "properties": { - "dealId": { - "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.", - "format": "int64", - "type": "string" - }, - "format": { - "enumDescriptions": [ - "A placeholder for an undefined format; indicates that no format filter\nwill be applied.", - "The ad impression is display format (i.e. an image).", - "The ad impression is video format." - ], - "enum": [ - "FORMAT_UNSPECIFIED", - "DISPLAY", - "VIDEO" - ], - "description": "DEPRECATED: use repeated formats field instead.\nThe format on which to filter; optional.", - "type": "string" - }, - "timeSeriesGranularity": { - "enumDescriptions": [ - "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.", - "Indicates that data will be broken down by the hour.", - "Indicates that data will be broken down by the day." - ], - "enum": [ - "TIME_SERIES_GRANULARITY_UNSPECIFIED", - "HOURLY", - "DAILY" - ], - "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.", - "type": "string" - }, - "realtimeTimeRange": { - "$ref": "RealtimeTimeRange", - "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp." - }, - "formats": { - "description": "The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e. if non-empty,\nresults must match any one of the formats).", - "type": "array", - "items": { - "type": "string", - "enum": [ - "FORMAT_UNSPECIFIED", - "DISPLAY", - "VIDEO" - ] - }, - "enumDescriptions": [ - "A placeholder for an undefined format; indicates that no format filter\nwill be applied.", - "The ad impression is display format (i.e. an image).", - "The ad impression is video format." - ] - }, "creativeId": { "description": "The ID of the creative on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.", "type": "string" }, + "relativeDateRange": { + "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone.", + "$ref": "RelativeDateRange" + }, "platforms": { - "enumDescriptions": [ - "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.", - "The ad impression appears on a desktop.", - "The ad impression appears on a tablet.", - "The ad impression appears on a mobile device." - ], "description": "The list of platforms on which to filter; may be empty. The filters\nrepresented by multiple platforms are ORed together (i.e. if non-empty,\nresults must match any one of the platforms).", "type": "array", "items": { - "type": "string", "enum": [ "PLATFORM_UNSPECIFIED", "DESKTOP", "TABLET", "MOBILE" - ] - } - }, - "relativeDateRange": { - "description": "A relative date range, defined by an offset from today and a duration.\nInterpreted relative to Pacific time zone.", - "$ref": "RelativeDateRange" + ], + "type": "string" + }, + "enumDescriptions": [ + "A placeholder for an undefined platform; indicates that no platform\nfilter will be applied.", + "The ad impression appears on a desktop.", + "The ad impression appears on a tablet.", + "The ad impression appears on a mobile device." + ] }, "name": { "description": "A user-defined name of the filter set. Filter set names must be unique\nglobally and match one of the patterns:\n\n- `bidders/*/filterSets/*` (for accessing bidder-level troubleshooting\ndata)\n- `bidders/*/accounts/*/filterSets/*` (for accessing account-level\ntroubleshooting data)\n\nThis field is required in create operations.", @@ -2219,27 +737,63 @@ ], "description": "The environment on which to filter; optional.", "type": "string" - } - }, - "id": "FilterSet" - }, - "ListDealAssociationsResponse": { - "description": "A response for listing creative and deal associations", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results.", + }, + "format": { + "type": "string", + "enumDescriptions": [ + "A placeholder for an undefined format; indicates that no format filter\nwill be applied.", + "The ad impression is display format (i.e. an image).", + "The ad impression is video format." + ], + "enum": [ + "FORMAT_UNSPECIFIED", + "DISPLAY", + "VIDEO" + ], + "description": "DEPRECATED: use repeated formats field instead.\nThe format on which to filter; optional." + }, + "dealId": { + "description": "The ID of the deal on which to filter; optional. This field may be set\nonly for a filter set that accesses account-level troubleshooting data,\ni.e. one whose name matches the `bidders/*/accounts/*/filterSets/*`\npattern.", + "format": "int64", "type": "string" }, - "associations": { - "description": "The list of associations.", + "timeSeriesGranularity": { + "enumDescriptions": [ + "A placeholder for an unspecified interval; no time series is applied.\nAll rows in response will contain data for the entire requested time range.", + "Indicates that data will be broken down by the hour.", + "Indicates that data will be broken down by the day." + ], + "enum": [ + "TIME_SERIES_GRANULARITY_UNSPECIFIED", + "HOURLY", + "DAILY" + ], + "description": "The granularity of time intervals if a time series breakdown is desired;\noptional.", + "type": "string" + }, + "realtimeTimeRange": { + "$ref": "RealtimeTimeRange", + "description": "An open-ended realtime time range, defined by the aggregation start\ntimestamp." + }, + "formats": { + "enumDescriptions": [ + "A placeholder for an undefined format; indicates that no format filter\nwill be applied.", + "The ad impression is display format (i.e. an image).", + "The ad impression is video format." + ], + "description": "The list of formats on which to filter; may be empty. The filters\nrepresented by multiple formats are ORed together (i.e. if non-empty,\nresults must match any one of the formats).", "type": "array", "items": { - "$ref": "CreativeDealAssociation" + "enum": [ + "FORMAT_UNSPECIFIED", + "DISPLAY", + "VIDEO" + ], + "type": "string" } } }, - "id": "ListDealAssociationsResponse" + "id": "FilterSet" }, "CalloutStatusRow": { "description": "The number of impressions with the specified dimension values where the\ncorresponding bid request or bid response was not successful, as described by\nthe specified callout status.", @@ -2261,6 +815,30 @@ }, "id": "CalloutStatusRow" }, + "ListDealAssociationsResponse": { + "description": "A response for listing creative and deal associations", + "type": "object", + "properties": { + "associations": { + "description": "The list of associations.", + "type": "array", + "items": { + "$ref": "CreativeDealAssociation" + } + }, + "nextPageToken": { + "type": "string", + "description": "A token to retrieve the next page of results.\nPass this value in the\nListDealAssociationsRequest.page_token\nfield in the subsequent call to 'ListDealAssociation' method to retrieve\nthe next page of results." + } + }, + "id": "ListDealAssociationsResponse" + }, + "StopWatchingCreativeRequest": { + "description": "A request for stopping notifications for changes to creative Status.", + "type": "object", + "properties": {}, + "id": "StopWatchingCreativeRequest" + }, "Disapproval": { "description": "@OutputOnly The reason and details for a disapproval.", "type": "object", @@ -2273,7 +851,6 @@ } }, "reason": { - "description": "The categorized reason for disapproval.", "type": "string", "enumDescriptions": [ "The length of the image animation is longer than allowed.", @@ -2466,35 +1043,16 @@ "MAXIMUM_NUMBER_OF_COOKIES_EXCEEDED", "PERSONAL_LOANS", "UNSUPPORTED_FLASH_CONTENT" - ] + ], + "description": "The categorized reason for disapproval." } }, "id": "Disapproval" }, - "StopWatchingCreativeRequest": { - "description": "A request for stopping notifications for changes to creative Status.", - "type": "object", - "properties": {}, - "id": "StopWatchingCreativeRequest" - }, "ServingRestriction": { "description": "@OutputOnly A representation of the status of an ad in a\nspecific context. A context here relates to where something ultimately serves\n(for example, a user or publisher geo, a platform, an HTTPS vs HTTP request,\nor the type of auction).", "type": "object", "properties": { - "status": { - "enumDescriptions": [ - "The status is not known.", - "The ad was disapproved in this context.", - "The ad is pending review in this context." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "DISAPPROVAL", - "PENDING_REVIEW" - ], - "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).", - "type": "string" - }, "disapprovalReasons": { "description": "Any disapprovals bound to this restriction.\nOnly present if status=DISAPPROVED.\nCan be used to filter the response of the\ncreatives.list\nmethod.", "type": "array", @@ -2508,6 +1066,20 @@ "items": { "$ref": "ServingContext" } + }, + "status": { + "enum": [ + "STATUS_UNSPECIFIED", + "DISAPPROVAL", + "PENDING_REVIEW" + ], + "description": "The status of the creative in this context (for example, it has been\nexplicitly disapproved or is pending review).", + "type": "string", + "enumDescriptions": [ + "The status is not known.", + "The ad was disapproved in this context.", + "The ad is pending review in this context." + ] } }, "id": "ServingRestriction" @@ -2539,8 +1111,8 @@ "type": "object", "properties": { "timeInterval": { - "$ref": "TimeInterval", - "description": "The time interval that this row represents." + "description": "The time interval that this row represents.", + "$ref": "TimeInterval" } }, "id": "RowDimensions" @@ -2559,11 +1131,11 @@ "description": "The app types this restriction applies to.", "type": "array", "items": { + "type": "string", "enum": [ "NATIVE", "WEB" - ], - "type": "string" + ] }, "enumDescriptions": [ "Native app context.", @@ -2574,44 +1146,44 @@ "id": "AppContext" }, "ListFilteredBidsResponse": { - "description": "Response message for listing all reasons that bids were filtered from the\nauction.", - "type": "object", "properties": { - "creativeStatusRows": { - "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status).", - "type": "array", - "items": { - "$ref": "CreativeStatusRow" - } - }, "nextPageToken": { "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidsRequest.pageToken\nfield in the subsequent call to the filteredBids.list\nmethod to retrieve the next page of results.", "type": "string" - } - }, - "id": "ListFilteredBidsResponse" - }, - "SecurityContext": { - "description": "@OutputOnly A security context.", - "type": "object", - "properties": { - "securities": { - "description": "The security types in this context.", + }, + "creativeStatusRows": { "type": "array", "items": { - "type": "string", - "enum": [ - "INSECURE", - "SSL" - ] + "$ref": "CreativeStatusRow" }, + "description": "List of rows, with counts of filtered bids aggregated by filtering reason\n(i.e. creative status)." + } + }, + "id": "ListFilteredBidsResponse", + "description": "Response message for listing all reasons that bids were filtered from the\nauction.", + "type": "object" + }, + "SecurityContext": { + "properties": { + "securities": { "enumDescriptions": [ "Matches impressions that require insecure compatibility.", "Matches impressions that require SSL compatibility." - ] + ], + "description": "The security types in this context.", + "type": "array", + "items": { + "enum": [ + "INSECURE", + "SSL" + ], + "type": "string" + } } }, - "id": "SecurityContext" + "id": "SecurityContext", + "description": "@OutputOnly A security context.", + "type": "object" }, "HtmlContent": { "description": "HTML content for a creative.", @@ -2635,7 +1207,6 @@ "id": "HtmlContent" }, "ListCreativesResponse": { - "description": "A response for listing creatives.", "type": "object", "properties": { "creatives": { @@ -2650,11 +1221,10 @@ "type": "string" } }, - "id": "ListCreativesResponse" + "id": "ListCreativesResponse", + "description": "A response for listing creatives." }, "ListFilteredBidRequestsResponse": { - "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.", - "type": "object", "properties": { "calloutStatusRows": { "description": "List of rows, with counts of filtered bid requests aggregated by callout\nstatus.", @@ -2664,13 +1234,16 @@ } }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the filteredBidRequests.list\nmethod to retrieve the next page of results.", - "type": "string" + "type": "string", + "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilteredBidRequestsRequest.pageToken\nfield in the subsequent call to the filteredBidRequests.list\nmethod to retrieve the next page of results." } }, - "id": "ListFilteredBidRequestsResponse" + "id": "ListFilteredBidRequestsResponse", + "description": "Response message for listing all reasons that bid requests were filtered and\nnot sent to the buyer.", + "type": "object" }, "ListBidMetricsResponse": { + "id": "ListBidMetricsResponse", "description": "Response message for listing the metrics that are measured in number of bids.", "type": "object", "properties": { @@ -2682,11 +1255,10 @@ } }, "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the bidMetrics.list\nmethod to retrieve the next page of results.", - "type": "string" + "type": "string", + "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidMetricsRequest.pageToken\nfield in the subsequent call to the bidMetrics.list\nmethod to retrieve the next page of results." } - }, - "id": "ListBidMetricsResponse" + } }, "Reason": { "description": "A specific filtering status and how many times it occurred.", @@ -2724,6 +1296,7 @@ "id": "ListNonBillableWinningBidsResponse" }, "ListLosingBidsResponse": { + "id": "ListLosingBidsResponse", "description": "Response message for listing all reasons that bids lost in the auction.", "type": "object", "properties": { @@ -2738,8 +1311,7 @@ "description": "A token to retrieve the next page of results.\nPass this value in the\nListLosingBidsRequest.pageToken\nfield in the subsequent call to the losingBids.list\nmethod to retrieve the next page of results.", "type": "string" } - }, - "id": "ListLosingBidsResponse" + } }, "VideoContent": { "description": "Video content for a creative.", @@ -2757,8 +1329,8 @@ "type": "object", "properties": { "successfulResponses": { - "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange.", - "$ref": "MetricValue" + "$ref": "MetricValue", + "description": "The number of impressions for which the buyer successfully sent a response\nto Ad Exchange." }, "rowDimensions": { "$ref": "RowDimensions", @@ -2784,14 +1356,9 @@ "id": "ImpressionMetricsRow" }, "AuctionContext": { - "description": "@OutputOnly The auction type the restriction applies to.", "type": "object", "properties": { "auctionTypes": { - "enumDescriptions": [ - "The restriction applies to open auction.", - "The restriction applies to direct deals." - ], "description": "The auction types this restriction applies to.", "type": "array", "items": { @@ -2800,36 +1367,45 @@ "DIRECT_DEALS" ], "type": "string" - } + }, + "enumDescriptions": [ + "The restriction applies to open auction.", + "The restriction applies to direct deals." + ] } }, - "id": "AuctionContext" + "id": "AuctionContext", + "description": "@OutputOnly The auction type the restriction applies to." }, "ListImpressionMetricsResponse": { - "description": "Response message for listing the metrics that are measured in number of\nimpressions.", - "type": "object", "properties": { + "nextPageToken": { + "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.", + "type": "string" + }, "impressionMetricsRows": { "description": "List of rows, each containing a set of impression metrics.", "type": "array", "items": { "$ref": "ImpressionMetricsRow" } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListImpressionMetricsRequest.pageToken\nfield in the subsequent call to the impressionMetrics.list\nmethod to retrieve the next page of results.", - "type": "string" } }, - "id": "ListImpressionMetricsResponse" + "id": "ListImpressionMetricsResponse", + "description": "Response message for listing the metrics that are measured in number of\nimpressions.", + "type": "object" }, "BidMetricsRow": { "description": "The set of metrics that are measured in numbers of bids, representing how\nmany bids with the specified dimension values were considered eligible at\neach stage of the bidding funnel;", "type": "object", "properties": { + "measurableImpressions": { + "$ref": "MetricValue", + "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)." + }, "bids": { - "description": "The number of bids that Ad Exchange received from the buyer.", - "$ref": "MetricValue" + "$ref": "MetricValue", + "description": "The number of bids that Ad Exchange received from the buyer." }, "billedImpressions": { "description": "The number of bids for which the buyer was billed.", @@ -2840,25 +1416,22 @@ "description": "The number of bids that were permitted to compete in the auction." }, "rowDimensions": { - "description": "The values of all dimensions associated with metric values in this row.", - "$ref": "RowDimensions" + "$ref": "RowDimensions", + "description": "The values of all dimensions associated with metric values in this row." }, "impressionsWon": { - "$ref": "MetricValue", - "description": "The number of bids that won an impression." + "description": "The number of bids that won an impression.", + "$ref": "MetricValue" }, "viewableImpressions": { - "$ref": "MetricValue", - "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View)." - }, - "measurableImpressions": { - "$ref": "MetricValue", - "description": "The number of bids for which the corresponding impression was measurable\nfor viewability (as defined by Active View)." + "description": "The number of bids for which the corresponding impression was viewable (as\ndefined by Active View).", + "$ref": "MetricValue" } }, "id": "BidMetricsRow" }, "ListBidResponseErrorsResponse": { + "id": "ListBidResponseErrorsResponse", "description": "Response message for listing all reasons that bid responses resulted in an\nerror.", "type": "object", "properties": { @@ -2873,32 +1446,29 @@ "description": "A token to retrieve the next page of results.\nPass this value in the\nListBidResponseErrorsRequest.pageToken\nfield in the subsequent call to the bidResponseErrors.list\nmethod to retrieve the next page of results.", "type": "string" } - }, - "id": "ListBidResponseErrorsResponse" + } }, "CreativeStatusRow": { "description": "The number of bids with the specified dimension values that did not win the\nauction (either were filtered pre-auction or lost the auction), as described\nby the specified creative status.", "type": "object", "properties": { - "bidCount": { - "$ref": "MetricValue", - "description": "The number of bids with the specified status." - }, "rowDimensions": { - "description": "The values of all dimensions associated with metric values in this row.", - "$ref": "RowDimensions" + "$ref": "RowDimensions", + "description": "The values of all dimensions associated with metric values in this row." }, "creativeStatusId": { "description": "The ID of the creative status.\nSee [creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).", "format": "int32", "type": "integer" + }, + "bidCount": { + "description": "The number of bids with the specified status.", + "$ref": "MetricValue" } }, "id": "CreativeStatusRow" }, "RealtimeTimeRange": { - "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.", - "type": "object", "properties": { "startTimestamp": { "description": "The start timestamp of the real-time RTB metrics aggregation.", @@ -2906,10 +1476,11 @@ "type": "string" } }, - "id": "RealtimeTimeRange" + "id": "RealtimeTimeRange", + "description": "An open-ended realtime time range specified by the start timestamp.\nFor filter sets that specify a realtime time range RTB metrics continue to\nbe aggregated throughout the lifetime of the filter set.", + "type": "object" }, "NonBillableWinningBidStatusRow": { - "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status.", "type": "object", "properties": { "status": { @@ -2931,28 +1502,29 @@ "description": "The values of all dimensions associated with metric values in this row." }, "bidCount": { - "description": "The number of bids with the specified status.", - "$ref": "MetricValue" + "$ref": "MetricValue", + "description": "The number of bids with the specified status." } }, - "id": "NonBillableWinningBidStatusRow" + "id": "NonBillableWinningBidStatusRow", + "description": "The number of winning bids with the specified dimension values for which the\nbuyer was not billed, as described by the specified status." }, "FilteredBidDetailRow": { "description": "The number of filtered bids with the specified dimension values, among those\nfiltered due to the requested filtering reason (i.e. creative status), that\nhave the specified detail.", "type": "object", "properties": { + "rowDimensions": { + "$ref": "RowDimensions", + "description": "The values of all dimensions associated with metric values in this row." + }, "bidCount": { - "description": "The number of bids with the specified detail.", - "$ref": "MetricValue" + "$ref": "MetricValue", + "description": "The number of bids with the specified detail." }, "detailId": { "description": "The ID of the detail. The associated value can be looked up in the\ndictionary file corresponding to the DetailType in the response message.", "format": "int32", "type": "integer" - }, - "rowDimensions": { - "$ref": "RowDimensions", - "description": "The values of all dimensions associated with metric values in this row." } }, "id": "FilteredBidDetailRow" @@ -2962,12 +1534,12 @@ "type": "object", "properties": { "startDate": { - "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date.", - "$ref": "Date" + "$ref": "Date", + "description": "The start date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor before end_date." }, "endDate": { - "$ref": "Date", - "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date." + "description": "The end date of the range (inclusive).\nMust be within the 30 days leading up to current date, and must be equal to\nor after start_date.", + "$ref": "Date" } }, "id": "AbsoluteDateRange" @@ -2977,13 +1549,14 @@ "type": "object", "properties": { "association": { - "description": "The association between a creative and a deal that should be added.", - "$ref": "CreativeDealAssociation" + "$ref": "CreativeDealAssociation", + "description": "The association between a creative and a deal that should be added." } }, "id": "AddDealAssociationRequest" }, "WatchCreativeRequest": { + "id": "WatchCreativeRequest", "description": "A request for watching changes to creative Status.", "type": "object", "properties": { @@ -2991,20 +1564,19 @@ "description": "The Pub/Sub topic to publish notifications to.\nThis topic must already exist and must give permission to\nad-exchange-buyside-reports@google.com to write to the topic.\nThis should be the full resource name in\n\"projects/{project_id}/topics/{topic_id}\" format.", "type": "string" } - }, - "id": "WatchCreativeRequest" + } }, "TimeInterval": { "description": "An interval of time, with an absolute start and end.", "type": "object", "properties": { - "endTime": { - "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.", + "startTime": { + "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.", "format": "google-datetime", "type": "string" }, - "startTime": { - "description": "The timestamp marking the start of the range (inclusive) for which data is\nincluded.", + "endTime": { + "description": "The timestamp marking the end of the range (exclusive) for which data is\nincluded.", "format": "google-datetime", "type": "string" } @@ -3012,23 +1584,23 @@ "id": "TimeInterval" }, "FilteredBidCreativeRow": { - "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative.", "type": "object", "properties": { - "rowDimensions": { - "$ref": "RowDimensions", - "description": "The values of all dimensions associated with metric values in this row." - }, "bidCount": { - "description": "The number of bids with the specified creative.", - "$ref": "MetricValue" + "$ref": "MetricValue", + "description": "The number of bids with the specified creative." }, "creativeId": { "description": "The ID of the creative.", "type": "string" + }, + "rowDimensions": { + "description": "The values of all dimensions associated with metric values in this row.", + "$ref": "RowDimensions" } }, - "id": "FilteredBidCreativeRow" + "id": "FilteredBidCreativeRow", + "description": "The number of filtered bids with the specified dimension values that have the\nspecified creative." }, "RelativeDateRange": { "description": "A relative date range, specified by an offset and a duration.\nThe supported range of dates begins 30 days before today and ends today.\nI.e. the limits for these values are:\noffset_days \u003e= 0\nduration_days \u003e= 1\noffset_days + duration_days \u003c= 30", @@ -3051,30 +1623,18 @@ "description": "Native content for a creative.", "type": "object", "properties": { - "storeUrl": { - "description": "The URL to the app store to purchase/download the promoted app.", - "type": "string" - }, - "headline": { - "description": "A short title for the ad.", - "type": "string" - }, - "appIcon": { - "description": "The app icon, for app download ads.", - "$ref": "Image" - }, "callToAction": { - "description": "A label for the button that the user is supposed to click.", - "type": "string" + "type": "string", + "description": "A label for the button that the user is supposed to click." }, "body": { "description": "A long description of the ad.", "type": "string" }, "starRating": { + "type": "number", "description": "The app rating in the app store. Must be in the range [0-5].", - "format": "double", - "type": "number" + "format": "double" }, "videoUrl": { "description": "The URL to fetch a native video ad.", @@ -3092,17 +1652,29 @@ "description": "The price of the promoted app including currency info.", "type": "string" }, + "image": { + "description": "A large image.", + "$ref": "Image" + }, "clickTrackingUrl": { "description": "The URL to use for click tracking.", "type": "string" }, - "image": { - "$ref": "Image", - "description": "A large image." - }, "advertiserName": { "description": "The name of the advertiser or sponsor, to be displayed in the ad creative.", "type": "string" + }, + "storeUrl": { + "description": "The URL to the app store to purchase/download the promoted app.", + "type": "string" + }, + "headline": { + "description": "A short title for the ad.", + "type": "string" + }, + "appIcon": { + "$ref": "Image", + "description": "The app icon, for app download ads." } }, "id": "NativeContent" @@ -3143,41 +1715,41 @@ "id": "ListBidResponsesWithoutBidsResponse" }, "ServingContext": { - "description": "The serving context for this restriction.", "type": "object", "properties": { "all": { - "description": "Matches all contexts.", - "type": "string", "enumDescriptions": [ "A simple context." ], "enum": [ "SIMPLE_CONTEXT" - ] + ], + "description": "Matches all contexts.", + "type": "string" }, "appType": { - "description": "Matches impressions for a particular app type.", - "$ref": "AppContext" + "$ref": "AppContext", + "description": "Matches impressions for a particular app type." }, "securityType": { - "description": "Matches impressions for a particular security type.", - "$ref": "SecurityContext" + "$ref": "SecurityContext", + "description": "Matches impressions for a particular security type." }, "platform": { - "$ref": "PlatformContext", - "description": "Matches impressions coming from a particular platform." + "description": "Matches impressions coming from a particular platform.", + "$ref": "PlatformContext" }, "location": { - "description": "Matches impressions coming from users *or* publishers in a specific\nlocation.", - "$ref": "LocationContext" + "$ref": "LocationContext", + "description": "Matches impressions coming from users *or* publishers in a specific\nlocation." }, "auctionType": { - "description": "Matches impressions for a particular auction type.", - "$ref": "AuctionContext" + "$ref": "AuctionContext", + "description": "Matches impressions for a particular auction type." } }, - "id": "ServingContext" + "id": "ServingContext", + "description": "The serving context for this restriction." }, "Image": { "description": "An image resource. You may provide a larger image than was requested,\nso long as the aspect ratio is preserved.", @@ -3189,8 +1761,8 @@ "type": "integer" }, "url": { - "description": "The URL of the image.", - "type": "string" + "type": "string", + "description": "The URL of the image." }, "height": { "description": "Image height in pixels.", @@ -3199,521 +1771,11 @@ } }, "id": "Image" - }, - "ListFilterSetsResponse": { - "description": "Response message for listing filter sets.", - "type": "object", - "properties": { - "filterSets": { - "description": "The filter sets belonging to the buyer.", - "type": "array", - "items": { - "$ref": "FilterSet" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListFilterSetsRequest.pageToken\nfield in the subsequent call to the\naccounts.filterSets.list\nmethod to retrieve the next page of results.", - "type": "string" - } - }, - "id": "ListFilterSetsResponse" - }, - "BidResponseWithoutBidsStatusRow": { - "description": "The number of impressions with the specified dimension values that were\nconsidered to have no applicable bids, as described by the specified status.", - "type": "object", - "properties": { - "impressionCount": { - "description": "The number of impressions for which there was a bid response with the\nspecified status.", - "$ref": "MetricValue" - }, - "status": { - "enumDescriptions": [ - "A placeholder for an undefined status.\nThis value will never be returned in responses.", - "The response had no bids.", - "The response had no bids for the specified account, though it may have\nincluded bids on behalf of other accounts.", - "The response had no bids for the specified deal, though it may have\nincluded bids on other deals on behalf of the account to which the deal\nbelongs." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "RESPONSES_WITHOUT_BIDS", - "RESPONSES_WITHOUT_BIDS_FOR_ACCOUNT", - "RESPONSES_WITHOUT_BIDS_FOR_DEAL" - ], - "description": "The status specifying why the bid responses were considered to have no\napplicable bids.", - "type": "string" - }, - "rowDimensions": { - "description": "The values of all dimensions associated with metric values in this row.", - "$ref": "RowDimensions" - } - }, - "id": "BidResponseWithoutBidsStatusRow" - }, - "ClientUserInvitation": { - "description": "An invitation for a new client user to get access to the Ad Exchange\nBuyer UI.\nAll fields are required unless otherwise specified.", - "type": "object", - "properties": { - "invitationId": { - "description": "The unique numerical ID of the invitation that is sent to the user.\nThe value of this field is ignored in create operations.", - "format": "int64", - "type": "string" - }, - "email": { - "description": "The email address to which the invitation is sent. Email\naddresses should be unique among all client users under each sponsor\nbuyer.", - "type": "string" - }, - "clientAccountId": { - "description": "Numerical account ID of the client buyer\nthat the invited user is associated with.\nThe value of this field is ignored in create operations.", - "format": "int64", - "type": "string" - } - }, - "id": "ClientUserInvitation" - }, - "ListClientUserInvitationsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUserInvitationsRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", - "type": "string" - }, - "invitations": { - "description": "The returned list of client users.", - "type": "array", - "items": { - "$ref": "ClientUserInvitation" - } - } - }, - "id": "ListClientUserInvitationsResponse" - }, - "ListClientUsersResponse": { - "type": "object", - "properties": { - "users": { - "description": "The returned list of client users.", - "type": "array", - "items": { - "$ref": "ClientUser" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListClientUsersRequest.pageToken\nfield in the subsequent call to the\nclients.invitations.list\nmethod to retrieve the next\npage of results.", - "type": "string" - } - }, - "id": "ListClientUsersResponse" - }, - "ListCreativeStatusBreakdownByDetailResponse": { - "description": "Response message for listing all details associated with a given filtered bid\nreason.", - "type": "object", - "properties": { - "detailType": { - "description": "The type of detail that the detail IDs represent.", - "type": "string", - "enumDescriptions": [ - "A placeholder for an undefined status.\nThis value will never be returned in responses.", - "Indicates that the detail ID refers to a creative attribute; see\n[publisher-excludable-creative-attributes](https://developers.google.com/ad-exchange/rtb/downloads/publisher-excludable-creative-attributes).", - "Indicates that the detail ID refers to a vendor; see\n[vendors](https://developers.google.com/ad-exchange/rtb/downloads/vendors).", - "Indicates that the detail ID refers to a sensitive category; see\n[ad-sensitive-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-sensitive-categories).", - "Indicates that the detail ID refers to a product category; see\n[ad-product-categories](https://developers.google.com/ad-exchange/rtb/downloads/ad-product-categories).", - "Indicates that the detail ID refers to a disapproval reason; see\nDisapprovalReason enum in [snippet-status-report-proto](https://developers.google.com/ad-exchange/rtb/downloads/snippet-status-report-proto)." - ], - "enum": [ - "DETAIL_TYPE_UNSPECIFIED", - "CREATIVE_ATTRIBUTE", - "VENDOR", - "SENSITIVE_CATEGORY", - "PRODUCT_CATEGORY", - "DISAPPROVAL_REASON" - ] - }, - "filteredBidDetailRows": { - "description": "List of rows, with counts of bids with a given creative status aggregated\nby detail.", - "type": "array", - "items": { - "$ref": "FilteredBidDetailRow" - } - }, - "nextPageToken": { - "description": "A token to retrieve the next page of results.\nPass this value in the\nListCreativeStatusBreakdownByDetailRequest.pageToken\nfield in the subsequent call to the filteredBids.details.list\nmethod to retrieve the next page of results.", - "type": "string" - } - }, - "id": "ListCreativeStatusBreakdownByDetailResponse" - }, - "LocationContext": { - "description": "@OutputOnly The Geo criteria the restriction applies to.", - "type": "object", - "properties": { - "geoCriteriaIds": { - "description": "IDs representing the geo location for this context.\nPlease refer to the\n[geo-table.csv](https://storage.googleapis.com/adx-rtb-dictionaries/geo-table.csv)\nfile for different geo criteria IDs.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - } - }, - "id": "LocationContext" - }, - "PlatformContext": { - "description": "@OutputOnly The type of platform the restriction applies to.", - "type": "object", - "properties": { - "platforms": { - "enumDescriptions": [ - "Desktop platform.", - "Android platform.", - "iOS platform." - ], - "description": "The platforms this restriction applies to.", - "type": "array", - "items": { - "enum": [ - "DESKTOP", - "ANDROID", - "IOS" - ], - "type": "string" - } - } - }, - "id": "PlatformContext" - }, - "MetricValue": { - "description": "A metric value, with an expected value and a variance; represents a count\nthat may be either exact or estimated (i.e. when sampled).", - "type": "object", - "properties": { - "variance": { - "description": "The variance (i.e. square of the standard deviation) of the metric value.\nIf value is exact, variance is 0.\nCan be used to calculate margin of error as a percentage of value, using\nthe following formula, where Z is the standard constant that depends on the\ndesired size of the confidence interval (e.g. for 90% confidence interval,\nuse Z = 1.645):\n\n marginOfError = 100 * Z * sqrt(variance) / value", - "format": "int64", - "type": "string" - }, - "value": { - "description": "The expected value of the metric.", - "format": "int64", - "type": "string" - } - }, - "id": "MetricValue" - }, - "ClientUser": { - "description": "A client user is created under a client buyer and has restricted access to\nthe Ad Exchange Marketplace and certain other sections\nof the Ad Exchange Buyer UI based on the role\ngranted to the associated client buyer.\n\nThe only way a new client user can be created is via accepting an\nemail invitation\n(see the\naccounts.clients.invitations.create\nmethod).\n\nAll fields are required unless otherwise specified.", - "type": "object", - "properties": { - "clientAccountId": { - "description": "Numerical account ID of the client buyer\nwith which the user is associated; the\nbuyer must be a client of the current sponsor buyer.\nThe value of this field is ignored in an update operation.", - "format": "int64", - "type": "string" - }, - "status": { - "enumDescriptions": [ - "A placeholder for an undefined user status.", - "A user who was already created but hasn't accepted the invitation yet.", - "A user that is currently active.", - "A user that is currently disabled." - ], - "enum": [ - "USER_STATUS_UNSPECIFIED", - "PENDING", - "ACTIVE", - "DISABLED" - ], - "description": "The status of the client user.", - "type": "string" - }, - "userId": { - "description": "The unique numerical ID of the client user\nthat has accepted an invitation.\nThe value of this field is ignored in an update operation.", - "format": "int64", - "type": "string" - }, - "email": { - "description": "User's email address. The value of this field\nis ignored in an update operation.", - "type": "string" - } - }, - "id": "ClientUser" - }, - "CreativeDealAssociation": { - "description": "The association between a creative and a deal.", - "type": "object", - "properties": { - "dealsId": { - "description": "The externalDealId for the deal associated with the creative.", - "type": "string" - }, - "accountId": { - "description": "The account the creative belongs to.", - "type": "string" - }, - "creativeId": { - "description": "The ID of the creative associated with the deal.", - "type": "string" - } - }, - "id": "CreativeDealAssociation" - }, - "Creative": { - "description": "A creative and its classification data.", - "type": "object", - "properties": { - "filteringStats": { - "$ref": "FilteringStats", - "description": "@OutputOnly The filtering stats for this creative." - }, - "attributes": { - "description": "All attributes for the ads that may be shown from this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "type": "array", - "items": { - "enum": [ - "ATTRIBUTE_UNSPECIFIED", - "IS_TAGGED", - "IS_COOKIE_TARGETED", - "IS_USER_INTEREST_TARGETED", - "EXPANDING_DIRECTION_NONE", - "EXPANDING_DIRECTION_UP", - "EXPANDING_DIRECTION_DOWN", - "EXPANDING_DIRECTION_LEFT", - "EXPANDING_DIRECTION_RIGHT", - "EXPANDING_DIRECTION_UP_LEFT", - "EXPANDING_DIRECTION_UP_RIGHT", - "EXPANDING_DIRECTION_DOWN_LEFT", - "EXPANDING_DIRECTION_DOWN_RIGHT", - "EXPANDING_DIRECTION_UP_OR_DOWN", - "EXPANDING_DIRECTION_LEFT_OR_RIGHT", - "EXPANDING_DIRECTION_ANY_DIAGONAL", - "EXPANDING_ACTION_ROLLOVER_TO_EXPAND", - "INSTREAM_VAST_VIDEO_TYPE_VPAID_FLASH", - "RICH_MEDIA_CAPABILITY_TYPE_MRAID", - "RICH_MEDIA_CAPABILITY_TYPE_SSL", - "RICH_MEDIA_CAPABILITY_TYPE_INTERSTITIAL", - "NATIVE_ELIGIBILITY_ELIGIBLE", - "NATIVE_ELIGIBILITY_NOT_ELIGIBLE", - "RENDERING_SIZELESS_ADX" - ], - "type": "string" - }, - "enumDescriptions": [ - "Do not use. This is a placeholder value only.", - "The creative is tagged.", - "The creative is cookie targeted.", - "The creative is user interest targeted.", - "The creative does not expand.", - "The creative expands up.", - "The creative expands down.", - "The creative expands left.", - "The creative expands right.", - "The creative expands up and left.", - "The creative expands up and right.", - "The creative expands down and left.", - "The creative expands down and right.", - "The creative expands up or down.", - "The creative expands left or right.", - "The creative expands on any diagonal.", - "The creative expands when rolled over.", - "The instream vast video type is vpaid flash.", - "The creative is MRAID", - "The creative is SSL.", - "The creative is an interstitial.", - "The creative is eligible for native.", - "The creative is not eligible for native.", - "The creative can dynamically resize to fill a variety of slot sizes." - ] - }, - "apiUpdateTime": { - "description": "@OutputOnly The last update timestamp of the creative via API.", - "format": "google-datetime", - "type": "string" - }, - "detectedLanguages": { - "description": "@OutputOnly\nThe detected languages for this creative. The order is arbitrary. The codes\nare 2 or 5 characters and are documented at\nhttps://developers.google.com/adwords/api/docs/appendix/languagecodes.", - "type": "array", - "items": { - "type": "string" - } - }, - "creativeId": { - "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "type": "string" - }, - "accountId": { - "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "type": "string" - }, - "native": { - "description": "A native creative.", - "$ref": "NativeContent" - }, - "video": { - "description": "A video creative.", - "$ref": "VideoContent" - }, - "servingRestrictions": { - "description": "@OutputOnly The granular status of this ad in specific contexts.\nA context here relates to where something ultimately serves (for example,\na physical location, a platform, an HTTPS vs HTTP request, or the type\nof auction).", - "type": "array", - "items": { - "$ref": "ServingRestriction" - } - }, - "agencyId": { - "description": "The agency ID for this creative.", - "format": "int64", - "type": "string" - }, - "clickThroughUrls": { - "description": "The set of destination URLs for the creative.", - "type": "array", - "items": { - "type": "string" - } - }, - "adChoicesDestinationUrl": { - "description": "The link to AdChoices destination page.", - "type": "string" - }, - "detectedSensitiveCategories": { - "description": "@OutputOnly Detected sensitive categories, if any.\nSee the ad-sensitive-categories.txt file in the technical documentation for\na list of IDs. You should use these IDs along with the\nexcluded-sensitive-category field in the bid request to filter your bids.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "restrictedCategories": { - "enumDescriptions": [ - "The ad has no restricted categories", - "The alcohol restricted category." - ], - "description": "All restricted categories for the ads that may be shown from this creative.", - "type": "array", - "items": { - "enum": [ - "NO_RESTRICTED_CATEGORIES", - "ALCOHOL" - ], - "type": "string" - } - }, - "corrections": { - "description": "@OutputOnly Shows any corrections that were applied to this creative.", - "type": "array", - "items": { - "$ref": "Correction" - } - }, - "version": { - "description": "@OutputOnly The version of this creative.", - "format": "int32", - "type": "integer" - }, - "vendorIds": { - "description": "All vendor IDs for the ads that may be shown from this creative.\nSee https://storage.googleapis.com/adx-rtb-dictionaries/vendors.txt\nfor possible values.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "impressionTrackingUrls": { - "description": "The set of URLs to be called to record an impression.", - "type": "array", - "items": { - "type": "string" - } - }, - "html": { - "$ref": "HtmlContent", - "description": "An HTML creative." - }, - "detectedProductCategories": { - "description": "@OutputOnly Detected product categories, if any.\nSee the ad-product-categories.txt file in the technical documentation\nfor a list of IDs.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "dealsStatus": { - "description": "@OutputOnly The top-level deals status of this creative.\nIf disapproved, an entry for 'auctionType=DIRECT_DEALS' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "type": "string", - "enumDescriptions": [ - "The status is unknown.", - "The creative has not been checked.", - "The creative has been conditionally approved.\nSee serving_restrictions for details.", - "The creative has been approved.", - "The creative has been disapproved." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "NOT_CHECKED", - "CONDITIONALLY_APPROVED", - "APPROVED", - "DISAPPROVED" - ] - }, - "openAuctionStatus": { - "description": "@OutputOnly The top-level open auction status of this creative.\nIf disapproved, an entry for 'auctionType = OPEN_AUCTION' (or 'ALL') in\nserving_restrictions will also exist. Note\nthat this may be nuanced with other contextual restrictions, in which case,\nit may be preferable to read from serving_restrictions directly.\nCan be used to filter the response of the\ncreatives.list\nmethod.", - "type": "string", - "enumDescriptions": [ - "The status is unknown.", - "The creative has not been checked.", - "The creative has been conditionally approved.\nSee serving_restrictions for details.", - "The creative has been approved.", - "The creative has been disapproved." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "NOT_CHECKED", - "CONDITIONALLY_APPROVED", - "APPROVED", - "DISAPPROVED" - ] - }, - "advertiserName": { - "description": "The name of the company being advertised in the creative.", - "type": "string" - }, - "detectedAdvertiserIds": { - "description": "@OutputOnly Detected advertiser IDs, if any.", - "type": "array", - "items": { - "format": "int64", - "type": "string" - } - }, - "detectedDomains": { - "description": "@OutputOnly\nThe detected domains for this creative.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "Creative" - }, - "FilteringStats": { - "description": "@OutputOnly Filtering reasons for this creative during a period of a single\nday (from midnight to midnight Pacific).", - "type": "object", - "properties": { - "reasons": { - "description": "The set of filtering reasons for this date.", - "type": "array", - "items": { - "$ref": "Reason" - } - }, - "date": { - "description": "The day during which the data was collected.\nThe data is collected from 00:00:00 to 23:59:59 PT.\nDuring switches from PST to PDT and back, the day may\ncontain 23 or 25 hours of data instead of the usual 24.", - "$ref": "Date" - } - }, - "id": "FilteringStats" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "canonicalName": "AdExchangeBuyerII", @@ -3730,5 +1792,1943 @@ "ownerDomain": "google.com", "name": "adexchangebuyer2", "batchPath": "batch", - "title": "Ad Exchange Buyer API II" + "title": "Ad Exchange Buyer API II", + "ownerName": "Google", + "resources": { + "accounts": { + "resources": { + "clients": { + "methods": { + "update": { + "description": "Updates an existing client buyer.", + "request": { + "$ref": "Client" + }, + "httpMethod": "PUT", + "parameterOrder": [ + "accountId", + "clientAccountId" + ], + "response": { + "$ref": "Client" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "accountId": { + "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to update a client for. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "clientAccountId": { + "location": "path", + "description": "Unique numerical account ID of the client to update. (required)", + "format": "int64", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", + "id": "adexchangebuyer2.accounts.clients.update", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}" + }, + "create": { + "response": { + "$ref": "Client" + }, + "parameterOrder": [ + "accountId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "accountId": { + "description": "Unique numerical account ID for the buyer of which the client buyer\nis a customer; the sponsor buyer to create a client for. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients", + "path": "v2beta1/accounts/{accountId}/clients", + "id": "adexchangebuyer2.accounts.clients.create", + "description": "Creates a new client buyer.", + "request": { + "$ref": "Client" + } + }, + "get": { + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", + "id": "adexchangebuyer2.accounts.clients.get", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}", + "description": "Gets a client buyer with a given client account ID.", + "httpMethod": "GET", + "parameterOrder": [ + "accountId", + "clientAccountId" + ], + "response": { + "$ref": "Client" + }, + "parameters": { + "accountId": { + "description": "Numerical account ID of the client's sponsor buyer. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "clientAccountId": { + "location": "path", + "description": "Numerical account ID of the client buyer to retrieve. (required)", + "format": "int64", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "accountId" + ], + "response": { + "$ref": "ListClientsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientsResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.list method.", + "type": "string", + "location": "query" + }, + "partnerClientId": { + "type": "string", + "location": "query", + "description": "Optional unique identifier (from the standpoint of an Ad Exchange sponsor\nbuyer partner) of the client to return.\nIf specified, at most one client will be returned in the response." + }, + "accountId": { + "required": true, + "type": "string", + "location": "path", + "description": "Unique numerical account ID of the sponsor buyer to list the clients for.", + "format": "int64" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients", + "id": "adexchangebuyer2.accounts.clients.list", + "path": "v2beta1/accounts/{accountId}/clients", + "description": "Lists all the clients for the current sponsor buyer." + } + }, + "resources": { + "invitations": { + "methods": { + "get": { + "description": "Retrieves an existing client user invitation.", + "response": { + "$ref": "ClientUserInvitation" + }, + "parameterOrder": [ + "accountId", + "clientAccountId", + "invitationId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "accountId": { + "description": "Numerical account ID of the client's sponsor buyer. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "clientAccountId": { + "required": true, + "type": "string", + "location": "path", + "description": "Numerical account ID of the client buyer that the user invitation\nto be retrieved is associated with. (required)", + "format": "int64" + }, + "invitationId": { + "location": "path", + "description": "Numerical identifier of the user invitation to retrieve. (required)", + "format": "int64", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations/{invitationId}", + "id": "adexchangebuyer2.accounts.clients.invitations.get" + }, + "list": { + "response": { + "$ref": "ListClientUserInvitationsResponse" + }, + "parameterOrder": [ + "accountId", + "clientAccountId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "accountId": { + "location": "path", + "description": "Numerical account ID of the client's sponsor buyer. (required)", + "format": "int64", + "required": true, + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. Server may return fewer clients than requested.\nIf unspecified, server will pick an appropriate default.", + "format": "int32", + "type": "integer" + }, + "clientAccountId": { + "description": "Numerical account ID of the client buyer to list invitations for.\n(required)\nYou must either specify a string representation of a\nnumerical account identifier or the `-` character\nto list all the invitations for all the clients\nof a given sponsor buyer.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUserInvitationsResponse.nextPageToken\nreturned from the previous call to the\nclients.invitations.list\nmethod.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", + "id": "adexchangebuyer2.accounts.clients.invitations.list", + "description": "Lists all the client users invitations for a client\nwith a given account ID." + }, + "create": { + "response": { + "$ref": "ClientUserInvitation" + }, + "parameterOrder": [ + "accountId", + "clientAccountId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "accountId": { + "description": "Numerical account ID of the client's sponsor buyer. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "clientAccountId": { + "description": "Numerical account ID of the client buyer that the user\nshould be associated with. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/invitations", + "id": "adexchangebuyer2.accounts.clients.invitations.create", + "description": "Creates and sends out an email invitation to access\nan Ad Exchange client buyer account.", + "request": { + "$ref": "ClientUserInvitation" + } + } + } + }, + "users": { + "methods": { + "list": { + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users", + "id": "adexchangebuyer2.accounts.clients.users.list", + "description": "Lists all the known client users for a specified\nsponsor buyer account ID.", + "response": { + "$ref": "ListClientUsersResponse" + }, + "parameterOrder": [ + "accountId", + "clientAccountId" + ], + "httpMethod": "GET", + "parameters": { + "accountId": { + "location": "path", + "description": "Numerical account ID of the sponsor buyer of the client to list users for.\n(required)", + "format": "int64", + "required": true, + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer clients than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "clientAccountId": { + "location": "path", + "description": "The account ID of the client buyer to list users for. (required)\nYou must specify either a string representation of a\nnumerical account identifier or the `-` character\nto list all the client users for all the clients\nof a given sponsor buyer.", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListClientUsersResponse.nextPageToken\nreturned from the previous call to the\naccounts.clients.users.list method.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + }, + "get": { + "response": { + "$ref": "ClientUser" + }, + "parameterOrder": [ + "accountId", + "clientAccountId", + "userId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "clientAccountId": { + "description": "Numerical account ID of the client buyer\nthat the user to be retrieved is associated with. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "userId": { + "description": "Numerical identifier of the user to retrieve. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "accountId": { + "location": "path", + "description": "Numerical account ID of the client's sponsor buyer. (required)", + "format": "int64", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", + "id": "adexchangebuyer2.accounts.clients.users.get", + "description": "Retrieves an existing client user." + }, + "update": { + "id": "adexchangebuyer2.accounts.clients.users.update", + "path": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}", + "description": "Updates an existing client user.\nOnly the user status can be changed on update.", + "request": { + "$ref": "ClientUser" + }, + "httpMethod": "PUT", + "parameterOrder": [ + "accountId", + "clientAccountId", + "userId" + ], + "response": { + "$ref": "ClientUser" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "accountId": { + "description": "Numerical account ID of the client's sponsor buyer. (required)", + "format": "int64", + "required": true, + "type": "string", + "location": "path" + }, + "clientAccountId": { + "location": "path", + "description": "Numerical account ID of the client buyer that the user to be retrieved\nis associated with. (required)", + "format": "int64", + "required": true, + "type": "string" + }, + "userId": { + "location": "path", + "description": "Numerical identifier of the user to retrieve. (required)", + "format": "int64", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/clients/{clientAccountId}/users/{userId}" + } + } + } + } + }, + "creatives": { + "methods": { + "list": { + "response": { + "$ref": "ListCreativesResponse" + }, + "parameterOrder": [ + "accountId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativesResponse.next_page_token\nreturned from the previous call to 'ListCreatives' method.", + "type": "string", + "location": "query" + }, + "accountId": { + "location": "path", + "description": "The account to list the creatives from.\nSpecify \"-\" to list all creatives the current user has access to.", + "required": true, + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer creatives than requested\n(due to timeout constraint) even if more are available via another call.\nIf unspecified, server will pick an appropriate default.\nAcceptable values are 1 to 1000, inclusive.", + "format": "int32", + "type": "integer" + }, + "query": { + "location": "query", + "description": "An optional query string to filter creatives. If no filter is specified,\nall active creatives will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus: {approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eattribute: {a numeric attribute from the list of attributes}\n\u003cli\u003edisapprovalReason: {a reason from\nDisapprovalReason}\n\u003c/ul\u003e\nExample: 'accountId=12345 AND (dealsStatus:disapproved AND\ndisapprovalReason:unacceptable_content) OR attribute:47'", + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/creatives", + "path": "v2beta1/accounts/{accountId}/creatives", + "id": "adexchangebuyer2.accounts.creatives.list", + "description": "Lists creatives." + }, + "create": { + "description": "Creates a creative.", + "request": { + "$ref": "Creative" + }, + "response": { + "$ref": "Creative" + }, + "parameterOrder": [ + "accountId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "duplicateIdMode": { + "type": "string", + "location": "query", + "enum": [ + "NO_DUPLICATES", + "FORCE_ENABLE_DUPLICATE_IDS" + ], + "description": "Indicates if multiple creatives can share an ID or not. Default is\nNO_DUPLICATES (one ID per creative)." + }, + "accountId": { + "location": "path", + "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "required": true, + "type": "string" + }, + "accountId1": { + "location": "query", + "description": "The account the creative belongs to.", + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/creatives", + "path": "v2beta1/accounts/{accountId}/creatives", + "id": "adexchangebuyer2.accounts.creatives.create" + }, + "stopWatching": { + "httpMethod": "POST", + "parameterOrder": [ + "accountId", + "creativeId" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "accountId": { + "location": "path", + "description": "The account of the creative to stop notifications for.", + "required": true, + "type": "string" + }, + "creativeId": { + "location": "path", + "description": "The creative ID of the creative to stop notifications for.\nSpecify \"-\" to specify stopping account level notifications.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching", + "id": "adexchangebuyer2.accounts.creatives.stopWatching", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:stopWatching", + "request": { + "$ref": "StopWatchingCreativeRequest" + }, + "description": "Stops watching a creative. Will stop push notifications being sent to the\ntopics when the creative changes status." + }, + "get": { + "response": { + "$ref": "Creative" + }, + "parameterOrder": [ + "accountId", + "creativeId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "creativeId": { + "description": "The ID of the creative to retrieve.", + "required": true, + "type": "string", + "location": "path" + }, + "accountId": { + "location": "path", + "description": "The account the creative belongs to.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}", + "id": "adexchangebuyer2.accounts.creatives.get", + "description": "Gets a creative." + }, + "watch": { + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}:watch", + "id": "adexchangebuyer2.accounts.creatives.watch", + "description": "Watches a creative. Will result in push notifications being sent to the\ntopic when the creative changes status.", + "request": { + "$ref": "WatchCreativeRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "accountId", + "creativeId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "creativeId": { + "location": "path", + "description": "The creative ID to watch for status changes.\nSpecify \"-\" to watch all creatives under the above account.\nIf both creative-level and account-level notifications are\nsent, only a single notification will be sent to the\ncreative-level notification topic.", + "required": true, + "type": "string" + }, + "accountId": { + "location": "path", + "description": "The account of the creative to watch.", + "required": true, + "type": "string" + } + } + }, + "update": { + "response": { + "$ref": "Creative" + }, + "parameterOrder": [ + "accountId", + "creativeId" + ], + "httpMethod": "PUT", + "parameters": { + "creativeId": { + "location": "path", + "description": "The buyer-defined creative ID of this creative.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "required": true, + "type": "string" + }, + "accountId1": { + "type": "string", + "location": "query", + "description": "The account the creative belongs to." + }, + "accountId": { + "description": "The account that this creative belongs to.\nCan be used to filter the response of the\ncreatives.list\nmethod.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}", + "id": "adexchangebuyer2.accounts.creatives.update", + "request": { + "$ref": "Creative" + }, + "description": "Updates a creative." + } + }, + "resources": { + "dealAssociations": { + "methods": { + "add": { + "request": { + "$ref": "AddDealAssociationRequest" + }, + "description": "Associate an existing deal with a creative.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "accountId", + "creativeId" + ], + "httpMethod": "POST", + "parameters": { + "creativeId": { + "description": "The ID of the creative associated with the deal.", + "required": true, + "type": "string", + "location": "path" + }, + "accountId": { + "location": "path", + "description": "The account the creative belongs to.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:add", + "id": "adexchangebuyer2.accounts.creatives.dealAssociations.add" + }, + "remove": { + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "creativeId": { + "location": "path", + "description": "The ID of the creative associated with the deal.", + "required": true, + "type": "string" + }, + "accountId": { + "location": "path", + "description": "The account the creative belongs to.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations:remove", + "id": "adexchangebuyer2.accounts.creatives.dealAssociations.remove", + "description": "Remove the association between a deal and a creative.", + "request": { + "$ref": "RemoveDealAssociationRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "accountId", + "creativeId" + ], + "httpMethod": "POST" + }, + "list": { + "response": { + "$ref": "ListDealAssociationsResponse" + }, + "parameterOrder": [ + "accountId", + "creativeId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "query": { + "description": "An optional query string to filter deal associations. If no filter is\nspecified, all associations will be returned.\nSupported queries are:\n\u003cul\u003e\n\u003cli\u003eaccountId=\u003ci\u003eaccount_id_string\u003c/i\u003e\n\u003cli\u003ecreativeId=\u003ci\u003ecreative_id_string\u003c/i\u003e\n\u003cli\u003edealsId=\u003ci\u003edeals_id_string\u003c/i\u003e\n\u003cli\u003edealsStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003cli\u003eopenAuctionStatus:{approved, conditionally_approved, disapproved,\n not_checked}\n\u003c/ul\u003e\nExample: 'dealsId=12345 AND dealsStatus:disapproved'", + "type": "string", + "location": "query" + }, + "creativeId": { + "location": "path", + "description": "The creative ID to list the associations from.\nSpecify \"-\" to list all creatives under the above account.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListDealAssociationsResponse.next_page_token\nreturned from the previous call to 'ListDealAssociations' method.", + "type": "string" + }, + "accountId": { + "description": "The account to list the associations from.\nSpecify \"-\" to list all creatives the current user has access to.", + "required": true, + "type": "string", + "location": "path" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. Server may return fewer associations than requested.\nIf unspecified, server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations", + "path": "v2beta1/accounts/{accountId}/creatives/{creativeId}/dealAssociations", + "id": "adexchangebuyer2.accounts.creatives.dealAssociations.list", + "description": "List all creative-deal associations." + } + } + } + } + } + } + }, + "bidders": { + "resources": { + "filterSets": { + "methods": { + "create": { + "description": "Creates the specified filter set for the account with the given account ID.", + "request": { + "$ref": "FilterSet" + }, + "response": { + "$ref": "FilterSet" + }, + "parameterOrder": [ + "ownerName" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "isTransient": { + "location": "query", + "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.", + "type": "boolean" + }, + "ownerName": { + "location": "path", + "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+$" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets", + "path": "v2beta1/{+ownerName}/filterSets", + "id": "adexchangebuyer2.bidders.filterSets.create" + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "name": { + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", + "path": "v2beta1/{+name}", + "id": "adexchangebuyer2.bidders.filterSets.delete", + "description": "Deletes the requested filter set from the account with the given account\nID." + }, + "get": { + "description": "Retrieves the requested filter set for the account with the given account\nID.", + "response": { + "$ref": "FilterSet" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}", + "path": "v2beta1/{+name}", + "id": "adexchangebuyer2.bidders.filterSets.get" + }, + "list": { + "response": { + "$ref": "ListFilterSetsResponse" + }, + "parameterOrder": [ + "ownerName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "ownerName": { + "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets", + "path": "v2beta1/{+ownerName}/filterSets", + "id": "adexchangebuyer2.bidders.filterSets.list", + "description": "Lists all filter sets for the account with the given account ID." + } + }, + "resources": { + "filteredBids": { + "methods": { + "list": { + "path": "v2beta1/{+filterSetName}/filteredBids", + "id": "adexchangebuyer2.bidders.filterSets.filteredBids.list", + "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.", + "response": { + "$ref": "ListFilteredBidsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids" + } + }, + "resources": { + "creatives": { + "methods": { + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName", + "creativeStatusId" + ], + "response": { + "$ref": "ListCreativeStatusBreakdownByCreativeResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "creativeStatusId": { + "location": "path", + "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).", + "format": "int32", + "required": true, + "type": "integer" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", + "id": "adexchangebuyer2.bidders.filterSets.filteredBids.creatives.list", + "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives", + "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative." + } + } + }, + "details": { + "methods": { + "list": { + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", + "id": "adexchangebuyer2.bidders.filterSets.filteredBids.details.list", + "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details", + "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.", + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName", + "creativeStatusId" + ], + "response": { + "$ref": "ListCreativeStatusBreakdownByDetailResponse" + }, + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "creativeStatusId": { + "location": "path", + "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", + "format": "int32", + "required": true, + "type": "integer" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + } + } + } + } + }, + "nonBillableWinningBids": { + "methods": { + "list": { + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/nonBillableWinningBids", + "path": "v2beta1/{+filterSetName}/nonBillableWinningBids", + "id": "adexchangebuyer2.bidders.filterSets.nonBillableWinningBids.list", + "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason.", + "response": { + "$ref": "ListNonBillableWinningBidsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET" + } + } + }, + "losingBids": { + "methods": { + "list": { + "id": "adexchangebuyer2.bidders.filterSets.losingBids.list", + "path": "v2beta1/{+filterSetName}/losingBids", + "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.", + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName" + ], + "response": { + "$ref": "ListLosingBidsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/losingBids" + } + } + }, + "impressionMetrics": { + "methods": { + "list": { + "description": "Lists all metrics that are measured in terms of number of impressions.", + "response": { + "$ref": "ListImpressionMetricsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod.", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/impressionMetrics", + "path": "v2beta1/{+filterSetName}/impressionMetrics", + "id": "adexchangebuyer2.bidders.filterSets.impressionMetrics.list" + } + } + }, + "bidMetrics": { + "methods": { + "list": { + "response": { + "$ref": "ListBidMetricsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + }, + "filterSetName": { + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$" + }, + "pageToken": { + "type": "string", + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod." + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidMetrics", + "path": "v2beta1/{+filterSetName}/bidMetrics", + "id": "adexchangebuyer2.bidders.filterSets.bidMetrics.list", + "description": "Lists all metrics that are measured in terms of number of bids." + } + } + }, + "bidResponseErrors": { + "methods": { + "list": { + "response": { + "$ref": "ListBidResponseErrorsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "parameters": { + "filterSetName": { + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.", + "type": "string" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponseErrors", + "path": "v2beta1/{+filterSetName}/bidResponseErrors", + "id": "adexchangebuyer2.bidders.filterSets.bidResponseErrors.list", + "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason." + } + } + }, + "bidResponsesWithoutBids": { + "methods": { + "list": { + "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.", + "response": { + "$ref": "ListBidResponsesWithoutBidsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/filterSets/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.", + "type": "string" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", + "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids", + "id": "adexchangebuyer2.bidders.filterSets.bidResponsesWithoutBids.list" + } + } + }, + "filteredBidRequests": { + "methods": { + "list": { + "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.", + "response": { + "$ref": "ListFilteredBidRequestsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "pattern": "^bidders/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod.", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/filterSets/{filterSetsId}/filteredBidRequests", + "path": "v2beta1/{+filterSetName}/filteredBidRequests", + "id": "adexchangebuyer2.bidders.filterSets.filteredBidRequests.list" + } + } + } + } + }, + "accounts": { + "resources": { + "filterSets": { + "methods": { + "get": { + "path": "v2beta1/{+name}", + "id": "adexchangebuyer2.bidders.accounts.filterSets.get", + "description": "Retrieves the requested filter set for the account with the given account\nID.", + "response": { + "$ref": "FilterSet" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Full name of the resource being requested.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}" + }, + "list": { + "response": { + "$ref": "ListFilterSetsResponse" + }, + "parameterOrder": [ + "ownerName" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilterSetsResponse.nextPageToken\nreturned from the previous call to the\naccounts.filterSets.list\nmethod.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + }, + "ownerName": { + "pattern": "^bidders/[^/]+/accounts/[^/]+$", + "location": "path", + "description": "Name of the owner (bidder or account) of the filter sets to be listed.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", + "path": "v2beta1/{+ownerName}/filterSets", + "id": "adexchangebuyer2.bidders.accounts.filterSets.list", + "description": "Lists all filter sets for the account with the given account ID." + }, + "create": { + "response": { + "$ref": "FilterSet" + }, + "parameterOrder": [ + "ownerName" + ], + "httpMethod": "POST", + "parameters": { + "ownerName": { + "location": "path", + "description": "Name of the owner (bidder or account) of the filter set to be created.\nFor example:\n\n- For a bidder-level filter set for bidder 123: `bidders/123`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+$" + }, + "isTransient": { + "location": "query", + "description": "Whether the filter set is transient, or should be persisted indefinitely.\nBy default, filter sets are not transient.\nIf transient, it will be available for at least 1 hour after creation.", + "type": "boolean" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets", + "path": "v2beta1/{+ownerName}/filterSets", + "id": "adexchangebuyer2.bidders.accounts.filterSets.create", + "request": { + "$ref": "FilterSet" + }, + "description": "Creates the specified filter set for the account with the given account ID." + }, + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "name": { + "description": "Full name of the resource to delete.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}", + "id": "adexchangebuyer2.bidders.accounts.filterSets.delete", + "path": "v2beta1/{+name}", + "description": "Deletes the requested filter set from the account with the given account\nID." + } + }, + "resources": { + "bidResponsesWithoutBids": { + "methods": { + "list": { + "description": "List all reasons for which bid responses were considered to have no\napplicable bids, with the number of bid responses affected for each reason.", + "httpMethod": "GET", + "response": { + "$ref": "ListBidResponsesWithoutBidsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "parameters": { + "filterSetName": { + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponsesWithoutBidsResponse.nextPageToken\nreturned from the previous call to the bidResponsesWithoutBids.list\nmethod.", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponsesWithoutBids", + "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponsesWithoutBids.list", + "path": "v2beta1/{+filterSetName}/bidResponsesWithoutBids" + } + } + }, + "filteredBidRequests": { + "methods": { + "list": { + "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBidRequests.list", + "path": "v2beta1/{+filterSetName}/filteredBidRequests", + "description": "List all reasons that caused a bid request not to be sent for an\nimpression, with the number of bid requests not sent for each reason.", + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName" + ], + "response": { + "$ref": "ListFilteredBidRequestsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string" + }, + "pageToken": { + "type": "string", + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidRequestsResponse.nextPageToken\nreturned from the previous call to the filteredBidRequests.list\nmethod." + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBidRequests" + } + } + }, + "nonBillableWinningBids": { + "methods": { + "list": { + "response": { + "$ref": "ListNonBillableWinningBidsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListNonBillableWinningBidsResponse.nextPageToken\nreturned from the previous call to the nonBillableWinningBids.list\nmethod.", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/nonBillableWinningBids", + "path": "v2beta1/{+filterSetName}/nonBillableWinningBids", + "id": "adexchangebuyer2.bidders.accounts.filterSets.nonBillableWinningBids.list", + "description": "List all reasons for which winning bids were not billable, with the number\nof bids not billed for each reason." + } + } + }, + "filteredBids": { + "methods": { + "list": { + "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.list", + "path": "v2beta1/{+filterSetName}/filteredBids", + "description": "List all reasons for which bids were filtered, with the number of bids\nfiltered for each reason.", + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName" + ], + "response": { + "$ref": "ListFilteredBidsResponse" + }, + "parameters": { + "filterSetName": { + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListFilteredBidsResponse.nextPageToken\nreturned from the previous call to the filteredBids.list\nmethod.", + "type": "string" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids" + } + }, + "resources": { + "creatives": { + "methods": { + "list": { + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/creatives", + "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.creatives.list", + "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/creatives", + "description": "List all creatives associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each creative.", + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName", + "creativeStatusId" + ], + "response": { + "$ref": "ListCreativeStatusBreakdownByCreativeResponse" + }, + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "creativeStatusId": { + "location": "path", + "description": "The ID of the creative status for which to retrieve a breakdown by\ncreative.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).", + "format": "int32", + "required": true, + "type": "integer" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByCreativeResponse.nextPageToken\nreturned from the previous call to the filteredBids.creatives.list\nmethod.", + "type": "string" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + } + } + }, + "details": { + "methods": { + "list": { + "description": "List all details associated with a specific reason for which bids were\nfiltered, with the number of bids filtered for each detail.", + "response": { + "$ref": "ListCreativeStatusBreakdownByDetailResponse" + }, + "parameterOrder": [ + "filterSetName", + "creativeStatusId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string" + }, + "creativeStatusId": { + "required": true, + "type": "integer", + "location": "path", + "description": "The ID of the creative status for which to retrieve a breakdown by detail.\nSee\n[creative-status-codes](https://developers.google.com/ad-exchange/rtb/downloads/creative-status-codes).\nDetails are only available for statuses 10, 14, 15, 17, 18, 19, 86, and 87.", + "format": "int32" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListCreativeStatusBreakdownByDetailResponse.nextPageToken\nreturned from the previous call to the filteredBids.details.list\nmethod.", + "type": "string" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/filteredBids/{creativeStatusId}/details", + "path": "v2beta1/{+filterSetName}/filteredBids/{creativeStatusId}/details", + "id": "adexchangebuyer2.bidders.accounts.filterSets.filteredBids.details.list" + } + } + } + } + }, + "losingBids": { + "methods": { + "list": { + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/losingBids", + "path": "v2beta1/{+filterSetName}/losingBids", + "id": "adexchangebuyer2.bidders.accounts.filterSets.losingBids.list", + "description": "List all reasons for which bids lost in the auction, with the number of\nbids that lost for each reason.", + "response": { + "$ref": "ListLosingBidsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filterSetName": { + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListLosingBidsResponse.nextPageToken\nreturned from the previous call to the losingBids.list\nmethod.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ] + } + } + }, + "impressionMetrics": { + "methods": { + "list": { + "path": "v2beta1/{+filterSetName}/impressionMetrics", + "id": "adexchangebuyer2.bidders.accounts.filterSets.impressionMetrics.list", + "description": "Lists all metrics that are measured in terms of number of impressions.", + "response": { + "$ref": "ListImpressionMetricsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "parameters": { + "filterSetName": { + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path", + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`" + }, + "pageToken": { + "type": "string", + "location": "query", + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListImpressionMetricsResponse.nextPageToken\nreturned from the previous call to the impressionMetrics.list\nmethod." + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/impressionMetrics" + } + } + }, + "bidMetrics": { + "methods": { + "list": { + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidMetrics", + "id": "adexchangebuyer2.bidders.accounts.filterSets.bidMetrics.list", + "path": "v2beta1/{+filterSetName}/bidMetrics", + "description": "Lists all metrics that are measured in terms of number of bids.", + "httpMethod": "GET", + "parameterOrder": [ + "filterSetName" + ], + "response": { + "$ref": "ListBidMetricsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidMetricsResponse.nextPageToken\nreturned from the previous call to the bidMetrics.list\nmethod.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + } + } + } + }, + "bidResponseErrors": { + "methods": { + "list": { + "description": "List all errors that occurred in bid responses, with the number of bid\nresponses affected for each reason.", + "response": { + "$ref": "ListBidResponseErrorsResponse" + }, + "parameterOrder": [ + "filterSetName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/adexchange.buyer" + ], + "parameters": { + "filterSetName": { + "description": "Name of the filter set that should be applied to the requested metrics.\nFor example:\n\n- For a bidder-level filter set for bidder 123:\n `bidders/123/filterSets/abc`\n\n- For an account-level filter set for the buyer account representing bidder\n 123: `bidders/123/accounts/123/filterSets/abc`\n\n- For an account-level filter set for the child seat buyer account 456\n whose bidder is 123: `bidders/123/accounts/456/filterSets/abc`", + "required": true, + "type": "string", + "pattern": "^bidders/[^/]+/accounts/[^/]+/filterSets/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "A token identifying a page of results the server should return.\nTypically, this is the value of\nListBidResponseErrorsResponse.nextPageToken\nreturned from the previous call to the bidResponseErrors.list\nmethod.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Requested page size. The server may return fewer results than requested.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta1/bidders/{biddersId}/accounts/{accountsId}/filterSets/{filterSetsId}/bidResponseErrors", + "path": "v2beta1/{+filterSetName}/bidResponseErrors", + "id": "adexchangebuyer2.bidders.accounts.filterSets.bidResponseErrors.list" + } + } + } + } + } + } + } + } + } + }, + "parameters": { + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "type": "string", + "location": "query", + "description": "Selector specifying which fields to include in a partial response." + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format." + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "type": "string", + "location": "query", + "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." + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + } + }, + "version": "v2beta1", + "baseUrl": "https://adexchangebuyer.googleapis.com/", + "servicePath": "", + "description": "Accesses the latest features for managing Ad Exchange accounts, Real-Time Bidding configurations and auction metrics, and Marketplace programmatic deals.", + "kind": "discovery#restDescription" }
diff --git a/adexperiencereport/v1/adexperiencereport-api.json b/adexperiencereport/v1/adexperiencereport-api.json index 5f4cf38..1cd9493 100644 --- a/adexperiencereport/v1/adexperiencereport-api.json +++ b/adexperiencereport/v1/adexperiencereport-api.json
@@ -1,5 +1,100 @@ { "schemas": { + "SiteSummaryResponse": { + "type": "object", + "properties": { + "mobileSummary": { + "description": "Summary for the mobile review of the site.", + "$ref": "PlatformSummary" + }, + "reviewedSite": { + "type": "string", + "description": "The name of the site reviewed." + }, + "desktopSummary": { + "description": "Summary for the desktop review of the site.", + "$ref": "PlatformSummary" + } + }, + "id": "SiteSummaryResponse", + "description": "Response message for GetSiteSummary." + }, + "PlatformSummary": { + "description": "Summary of the ad experience rating of a site for a specific platform.", + "type": "object", + "properties": { + "enforcementTime": { + "description": "The date on which ad filtering begins.", + "format": "google-datetime", + "type": "string" + }, + "region": { + "enumDescriptions": [ + "Ad standard not yet defined for your region.", + "Region A.", + "Region B." + ], + "description": "The assigned regions for the site and platform.", + "type": "array", + "items": { + "enum": [ + "REGION_UNKNOWN", + "REGION_A", + "REGION_B" + ], + "type": "string" + } + }, + "filterStatus": { + "enum": [ + "UNKNOWN", + "ON", + "OFF", + "PAUSED", + "PENDING" + ], + "description": "The ad filtering status of the site.", + "type": "string", + "enumDescriptions": [ + "N/A.", + "Ad filtering is on.", + "Ad filtering is off.", + "Ad filtering is paused.", + "Ad filtering is pending." + ] + }, + "underReview": { + "description": "Whether the site is currently under review.", + "type": "boolean" + }, + "reportUrl": { + "type": "string", + "description": "A link that leads to a full ad experience report." + }, + "lastChangeTime": { + "description": "The last time that the site changed status.", + "format": "google-datetime", + "type": "string" + }, + "betterAdsStatus": { + "enum": [ + "UNKNOWN", + "PASSING", + "WARNING", + "FAILING" + ], + "description": "The status of the site reviewed for the Better Ads Standards.", + "type": "string", + "enumDescriptions": [ + "Not reviewed.", + "Passing.", + "Warning.", + "Failing." + ] + } + }, + "id": "PlatformSummary" + }, "ViolatingSitesResponse": { "description": "Response message for ListViolatingSites.", "type": "object", @@ -13,108 +108,13 @@ } }, "id": "ViolatingSitesResponse" - }, - "SiteSummaryResponse": { - "description": "Response message for GetSiteSummary.", - "type": "object", - "properties": { - "reviewedSite": { - "description": "The name of the site reviewed.", - "type": "string" - }, - "desktopSummary": { - "description": "Summary for the desktop review of the site.", - "$ref": "PlatformSummary" - }, - "mobileSummary": { - "$ref": "PlatformSummary", - "description": "Summary for the mobile review of the site." - } - }, - "id": "SiteSummaryResponse" - }, - "PlatformSummary": { - "description": "Summary of the ad experience rating of a site for a specific platform.", - "type": "object", - "properties": { - "lastChangeTime": { - "description": "The last time that the site changed status.", - "format": "google-datetime", - "type": "string" - }, - "betterAdsStatus": { - "enumDescriptions": [ - "Not reviewed.", - "Passing.", - "Warning.", - "Failing." - ], - "enum": [ - "UNKNOWN", - "PASSING", - "WARNING", - "FAILING" - ], - "description": "The status of the site reviewed for the Better Ads Standards.", - "type": "string" - }, - "region": { - "enumDescriptions": [ - "Ad standard not yet defined for your region.", - "Region A.", - "Region B." - ], - "description": "The assigned regions for the site and platform.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "REGION_UNKNOWN", - "REGION_A", - "REGION_B" - ] - } - }, - "enforcementTime": { - "description": "The date on which ad filtering begins.", - "format": "google-datetime", - "type": "string" - }, - "filterStatus": { - "description": "The ad filtering status of the site.", - "type": "string", - "enumDescriptions": [ - "N/A.", - "Ad filtering is on.", - "Ad filtering is off.", - "Ad filtering is paused.", - "Ad filtering is pending." - ], - "enum": [ - "UNKNOWN", - "ON", - "OFF", - "PAUSED", - "PENDING" - ] - }, - "underReview": { - "description": "Whether the site is currently under review.", - "type": "boolean" - }, - "reportUrl": { - "description": "A link that leads to a full ad experience report.", - "type": "string" - } - }, - "id": "PlatformSummary" } }, - "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, + "protocol": "rest", "canonicalName": "Ad Experience Report", "auth": { "oauth2": { @@ -132,9 +132,29 @@ "title": "Google Ad Experience Report API", "ownerName": "Google", "resources": { + "violatingSites": { + "methods": { + "list": { + "response": { + "$ref": "ViolatingSitesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/xapi.zoo" + ], + "parameters": {}, + "flatPath": "v1/violatingSites", + "path": "v1/violatingSites", + "id": "adexperiencereport.violatingSites.list", + "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\"." + } + } + }, "sites": { "methods": { "get": { + "description": "Gets a summary of the ad experience rating of a site.", "response": { "$ref": "SiteSummaryResponse" }, @@ -147,91 +167,83 @@ ], "parameters": { "name": { - "location": "path", "description": "The required site name. It should be the site property whose ad experiences\nmay have been reviewed, and it should be URL-encoded. For example,\nsites/https%3A%2F%2Fwww.google.com. The server will return an error of\nBAD_REQUEST if this field is not filled in. Note that if the site property\nis not yet verified in Search Console, the reportUrl field returned by the\nAPI will lead to the verification page, prompting the user to go through\nthat process before they can gain access to the Ad Experience Report.", "required": true, "type": "string", - "pattern": "^sites/[^/]+$" + "pattern": "^sites/[^/]+$", + "location": "path" } }, "flatPath": "v1/sites/{sitesId}", "path": "v1/{+name}", - "id": "adexperiencereport.sites.get", - "description": "Gets a summary of the ad experience rating of a site." - } - } - }, - "violatingSites": { - "methods": { - "list": { - "flatPath": "v1/violatingSites", - "path": "v1/violatingSites", - "id": "adexperiencereport.violatingSites.list", - "description": "Lists sites with Ad Experience Report statuses of \"Failing\" or \"Warning\".", - "response": { - "$ref": "ViolatingSitesResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/xapi.zoo" - ] + "id": "adexperiencereport.sites.get" } } } }, "parameters": { + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, "upload_protocol": { + "type": "string", "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query", + "description": "Returns response with indentations and line breaks." + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "$.xgafv": { + "enum": [ + "1", + "2" + ], "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], - "location": "query", - "enum": [ - "1", - "2" - ] + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "alt": { + "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -239,41 +251,29 @@ "media", "proto" ], - "type": "string", - "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" - }, - "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.", - "type": "string", - "location": "query" + "type": "string" }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, + "key": { + "location": "query", + "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.", + "type": "string" + }, "quotaUser": { "location": "query", "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.", "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" } }, "version": "v1", "baseUrl": "https://adexperiencereport.googleapis.com/", "servicePath": "", - "kind": "discovery#restDescription", "description": "View Ad Experience Report data, and get a list of sites that have a significant number of annoying ads.", + "kind": "discovery#restDescription", "basePath": "", "revision": "20171129", "documentationLink": "https://developers.google.com/ad-experience-report/",
diff --git a/analyticsreporting/v4/analyticsreporting-api.json b/analyticsreporting/v4/analyticsreporting-api.json index 5685151..0e4285d 100644 --- a/analyticsreporting/v4/analyticsreporting-api.json +++ b/analyticsreporting/v4/analyticsreporting-api.json
@@ -1,24 +1,58 @@ { + "basePath": "", + "id": "analyticsreporting:v4", + "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/", + "revision": "20171108", + "discoveryVersion": "v1", + "version_module": true, "schemas": { - "DateRange": { - "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.", - "type": "object", + "ReportRequest": { "properties": { - "endDate": { - "description": "The end date for the query in the format `YYYY-MM-DD`.", + "samplingLevel": { + "enumDescriptions": [ + "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.", + "Returns response with a sample size that balances speed and\naccuracy.", + "It returns a fast response with a smaller sampling size.", + "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower." + ], + "enum": [ + "SAMPLING_UNSPECIFIED", + "DEFAULT", + "SMALL", + "LARGE" + ], + "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.", "type": "string" }, - "startDate": { - "description": "The start date for the query in the format `YYYY-MM-DD`.", + "dimensions": { + "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.", + "type": "array", + "items": { + "$ref": "Dimension" + } + }, + "dateRanges": { + "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.", + "type": "array", + "items": { + "$ref": "DateRange" + } + }, + "pageToken": { + "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.", "type": "string" - } - }, - "id": "DateRange" - }, - "ReportRequest": { - "description": "The main request class which specifies the Reporting API request.", - "type": "object", - "properties": { + }, + "pivots": { + "description": "The pivot definitions. Requests can have a maximum of 2 pivots.", + "type": "array", + "items": { + "$ref": "Pivot" + } + }, + "includeEmptyRows": { + "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.", + "type": "boolean" + }, "metricFilterClauses": { "description": "The metric filter clauses. They are logically combined with the `AND`\noperator. Metric filters look at only the first date range and not the\ncomparing date range. Note that filtering on metrics occurs after the\nmetrics are aggregated.", "type": "array", @@ -31,14 +65,14 @@ "format": "int32", "type": "integer" }, - "hideTotals": { - "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.", - "type": "boolean" - }, "hideValueRanges": { "description": "If set to true, hides the minimum and maximum across all matching rows.\nThe default is false and the value ranges are returned.", "type": "boolean" }, + "hideTotals": { + "description": "If set to true, hides the total of all metrics for all the matching rows,\nfor every date range. The default false and will return the totals.", + "type": "boolean" + }, "cohortGroup": { "$ref": "CohortGroup", "description": "Cohort group associated with this request. If there is a cohort group\nin the request the `ga:cohort` dimension must be present.\nEvery [ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `cohortGroup` definition." @@ -78,54 +112,11 @@ "items": { "$ref": "Segment" } - }, - "samplingLevel": { - "description": "The desired report\n[sample](https://support.google.com/analytics/answer/2637192) size.\nIf the the `samplingLevel` field is unspecified the `DEFAULT` sampling\nlevel is used. Every [ReportRequest](#ReportRequest) within a\n`batchGet` method must contain the same `samplingLevel` definition. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\n for details.", - "type": "string", - "enumDescriptions": [ - "If the `samplingLevel` field is unspecified the `DEFAULT` sampling level\nis used.", - "Returns response with a sample size that balances speed and\naccuracy.", - "It returns a fast response with a smaller sampling size.", - "Returns a more accurate response using a large sampling size. But this\nmay result in response being slower." - ], - "enum": [ - "SAMPLING_UNSPECIFIED", - "DEFAULT", - "SMALL", - "LARGE" - ] - }, - "dimensions": { - "description": "The dimensions requested.\nRequests can have a total of 7 dimensions.", - "type": "array", - "items": { - "$ref": "Dimension" - } - }, - "dateRanges": { - "description": "Date ranges in the request. The request can have a maximum of 2 date\nranges. The response will contain a set of metric values for each\ncombination of the dimensions for each date range in the request. So, if\nthere are two date ranges, there will be two set of metric values, one for\nthe original date range and one for the second date range.\nThe `reportRequest.dateRanges` field should not be specified for cohorts\nor Lifetime value requests.\nIf a date range is not provided, the default date range is (startDate:\ncurrent date - 7 days, endDate: current date - 1 day). Every\n[ReportRequest](#ReportRequest) within a `batchGet` method must\ncontain the same `dateRanges` definition.", - "type": "array", - "items": { - "$ref": "DateRange" - } - }, - "pageToken": { - "description": "A continuation token to get the next page of the results. Adding this to\nthe request will return the rows after the pageToken. The pageToken should\nbe the value returned in the nextPageToken parameter in the response to\nthe GetReports request.", - "type": "string" - }, - "pivots": { - "description": "The pivot definitions. Requests can have a maximum of 2 pivots.", - "type": "array", - "items": { - "$ref": "Pivot" - } - }, - "includeEmptyRows": { - "description": "If set to false, the response does not include rows if all the retrieved\nmetrics are equal to zero. The default is false which will exclude these\nrows.", - "type": "boolean" } }, - "id": "ReportRequest" + "id": "ReportRequest", + "description": "The main request class which specifies the Reporting API request.", + "type": "object" }, "MetricFilter": { "description": "MetricFilter specifies the filter on a metric.", @@ -165,8 +156,6 @@ "id": "MetricFilter" }, "Dimension": { - "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.", - "type": "object", "properties": { "histogramBuckets": { "description": "If non-empty, we place dimension values into buckets after string to\nint64. Dimension values that are not the string representation of an\nintegral value will be converted to zero. The bucket values have to be in\nincreasing order. Each bucket is closed on the lower end, and open on the\nupper end. The \"first\" bucket includes all values less than the first\nboundary, the \"last\" bucket includes all values up to infinity. Dimension\nvalues that fall in a bucket get transformed to a new dimension value. For\nexample, if one gives a list of \"0, 1, 3, 4, 7\", then we return the\nfollowing buckets:\n\n- bucket #1: values \u003c 0, dimension value \"\u003c0\"\n- bucket #2: values in [0,1), dimension value \"0\"\n- bucket #3: values in [1,3), dimension value \"1-2\"\n- bucket #4: values in [3,4), dimension value \"3\"\n- bucket #5: values in [4,7), dimension value \"4-6\"\n- bucket #6: values \u003e= 7, dimension value \"7+\"\n\nNOTE: If you are applying histogram mutation on any dimension, and using\nthat dimension in sort, you will want to use the sort type\n`HISTOGRAM_BUCKET` for that purpose. Without that the dimension values\nwill be sorted according to dictionary\n(lexicographic) order. For example the ascending dictionary order is:\n\n \"\u003c50\", \"1001+\", \"121-1000\", \"50-120\"\n\nAnd the ascending `HISTOGRAM_BUCKET` order is:\n\n \"\u003c50\", \"50-120\", \"121-1000\", \"1001+\"\n\nThe client has to explicitly request `\"orderType\": \"HISTOGRAM_BUCKET\"`\nfor a histogram-mutated dimension.", @@ -181,7 +170,9 @@ "type": "string" } }, - "id": "Dimension" + "id": "Dimension", + "description": "[Dimensions](https://support.google.com/analytics/answer/1033861)\nare attributes of your data. For example, the dimension `ga:city`\nindicates the city, for example, \"Paris\" or \"New York\", from which\na session originates.", + "type": "object" }, "DynamicSegment": { "description": "Dynamic segment definition for defining the segment within the request.\nA segment can select users, sessions or both.", @@ -196,15 +187,13 @@ "type": "string" }, "userSegment": { - "$ref": "SegmentDefinition", - "description": "User Segment to select users to include in the segment." + "description": "User Segment to select users to include in the segment.", + "$ref": "SegmentDefinition" } }, "id": "DynamicSegment" }, "SimpleSegment": { - "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.", - "type": "object", "properties": { "orFiltersForSegment": { "description": "A list of segment filters groups which are combined with logical `AND`\noperator.", @@ -214,22 +203,24 @@ } } }, - "id": "SimpleSegment" + "id": "SimpleSegment", + "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined.", + "type": "object" }, "ColumnHeader": { "description": "Column headers.", "type": "object", "properties": { - "metricHeader": { - "description": "Metric headers for the metrics in the response.", - "$ref": "MetricHeader" - }, "dimensions": { "description": "The dimension names in the response.", "type": "array", "items": { "type": "string" } + }, + "metricHeader": { + "description": "Metric headers for the metrics in the response.", + "$ref": "MetricHeader" } }, "id": "ColumnHeader" @@ -247,32 +238,32 @@ "type": "boolean" }, "dimensionFilter": { - "$ref": "SegmentDimensionFilter", - "description": "Dimension Filter for the segment definition." + "description": "Dimension Filter for the segment definition.", + "$ref": "SegmentDimensionFilter" } }, "id": "SegmentFilterClause" }, "ReportRow": { - "description": "A row in the report.", - "type": "object", "properties": { - "metrics": { - "description": "List of metrics for each requested DateRange.", - "type": "array", - "items": { - "$ref": "DateRangeValues" - } - }, "dimensions": { "description": "List of requested dimensions.", "type": "array", "items": { "type": "string" } + }, + "metrics": { + "description": "List of metrics for each requested DateRange.", + "type": "array", + "items": { + "$ref": "DateRangeValues" + } } }, - "id": "ReportRow" + "id": "ReportRow", + "description": "A row in the report.", + "type": "object" }, "Cohort": { "description": "Defines a cohort. A cohort is a group of users who share a common\ncharacteristic. For example, all users with the same acquisition date\nbelong to the same cohort.", @@ -283,40 +274,38 @@ "type": "string" }, "dateRange": { - "$ref": "DateRange", - "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field." + "description": "This is used for `FIRST_VISIT_DATE` cohort, the cohort selects users\nwhose first visit date is between start date and end date defined in the\nDateRange. The date ranges should be aligned for cohort requests. If the\nrequest contains `ga:cohortNthDay` it should be exactly one day long,\nif `ga:cohortNthWeek` it should be aligned to the week boundary (starting\nat Sunday and ending Saturday), and for `ga:cohortNthMonth` the date range\nshould be aligned to the month (starting at the first and ending on the\nlast day of the month).\nFor LTV requests there are no such restrictions.\nYou do not need to supply a date range for the\n`reportsRequest.dateRanges` field.", + "$ref": "DateRange" }, "type": { - "enumDescriptions": [ - "If unspecified it's treated as `FIRST_VISIT_DATE`.", - "Cohorts that are selected based on first visit date." - ], "enum": [ "UNSPECIFIED_COHORT_TYPE", "FIRST_VISIT_DATE" ], "description": "Type of the cohort. The only supported type as of now is\n`FIRST_VISIT_DATE`. If this field is unspecified the cohort is treated\nas `FIRST_VISIT_DATE` type cohort.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "If unspecified it's treated as `FIRST_VISIT_DATE`.", + "Cohorts that are selected based on first visit date." + ] } }, "id": "Cohort" }, "MetricFilterClause": { - "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.", - "type": "object", "properties": { "operator": { + "enum": [ + "OPERATOR_UNSPECIFIED", + "OR", + "AND" + ], "description": "The operator for combining multiple metric filters. If unspecified, it is\ntreated as an `OR`.", "type": "string", "enumDescriptions": [ "Unspecified operator. It is treated as an `OR`.", "The logical `OR` operator.", "The logical `AND` operator." - ], - "enum": [ - "OPERATOR_UNSPECIFIED", - "OR", - "AND" ] }, "filters": { @@ -327,11 +316,11 @@ } } }, - "id": "MetricFilterClause" + "id": "MetricFilterClause", + "description": "Represents a group of metric filters.\nSet the operator value to specify how the filters are logically combined.", + "type": "object" }, "OrFiltersForSegment": { - "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.", - "type": "object", "properties": { "segmentFilterClauses": { "description": "List of segment filters to be combined with a `OR` operator.", @@ -341,32 +330,32 @@ } } }, - "id": "OrFiltersForSegment" + "id": "OrFiltersForSegment", + "description": "A list of segment filters in the `OR` group are combined with the logical OR\noperator.", + "type": "object" }, "MetricHeader": { - "description": "The headers for the metrics.", - "type": "object", "properties": { - "metricHeaderEntries": { - "description": "Headers for the metrics in the response.", - "type": "array", - "items": { - "$ref": "MetricHeaderEntry" - } - }, "pivotHeaders": { "description": "Headers for the pivots in the response.", "type": "array", "items": { "$ref": "PivotHeader" } + }, + "metricHeaderEntries": { + "description": "Headers for the metrics in the response.", + "type": "array", + "items": { + "$ref": "MetricHeaderEntry" + } } }, - "id": "MetricHeader" + "id": "MetricHeader", + "description": "The headers for the metrics.", + "type": "object" }, "DimensionFilterClause": { - "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.", - "type": "object", "properties": { "operator": { "enumDescriptions": [ @@ -390,17 +379,12 @@ } } }, - "id": "DimensionFilterClause" + "id": "DimensionFilterClause", + "description": "A group of dimension filters. Set the operator value to specify how\nthe filters are logically combined.", + "type": "object" }, "GetReportsResponse": { - "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.", - "type": "object", "properties": { - "queryCost": { - "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.", - "format": "int32", - "type": "integer" - }, "resourceQuotasRemaining": { "description": "The amount of resource quota remaining for the property.", "$ref": "ResourceQuotasRemaining" @@ -411,24 +395,31 @@ "items": { "$ref": "Report" } + }, + "queryCost": { + "description": "The amount of resource quota tokens deducted to execute the query. Includes\nall responses.", + "format": "int32", + "type": "integer" } }, - "id": "GetReportsResponse" + "id": "GetReportsResponse", + "description": "The main response class which holds the reports from the Reporting API\n`batchGet` call.", + "type": "object" }, "SequenceSegment": { "description": "Sequence conditions consist of one or more steps, where each step is defined\nby one or more dimension/metric conditions. Multiple steps can be combined\nwith special sequence operators.", "type": "object", "properties": { - "firstStepShouldMatchFirstHit": { - "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).", - "type": "boolean" - }, "segmentSequenceSteps": { "description": "The list of steps in the sequence.", "type": "array", "items": { "$ref": "SegmentSequenceStep" } + }, + "firstStepShouldMatchFirstHit": { + "description": "If set, first step condition must match the first hit of the visitor (in\nthe date range).", + "type": "boolean" } }, "id": "SequenceSegment" @@ -437,13 +428,29 @@ "description": "Metric filter to be used in a segment filter clause.", "type": "object", "properties": { + "operator": { + "enum": [ + "UNSPECIFIED_OPERATOR", + "LESS_THAN", + "GREATER_THAN", + "EQUAL", + "BETWEEN" + ], + "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.", + "type": "string", + "enumDescriptions": [ + "Unspecified operator is treated as `LESS_THAN` operator.", + "Checks if the metric value is less than comparison value.", + "Checks if the metric value is greater than comparison value.", + "Equals operator.", + "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison." + ] + }, "metricName": { "description": "The metric that will be filtered on. A `metricFilter` must contain a\nmetric name.", "type": "string" }, "scope": { - "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.", - "type": "string", "enumDescriptions": [ "If the scope is unspecified, it defaults to the condition scope,\n`USER` or `SESSION` depending on if the segment is trying to choose\nusers or sessions.", "Product scope.", @@ -457,7 +464,9 @@ "HIT", "SESSION", "USER" - ] + ], + "description": "Scope for a metric defines the level at which that metric is defined. The\nspecified metric scope must be equal to or greater than its primary scope\nas defined in the data model. The primary scope is defined by if the\nsegment is selecting users or sessions.", + "type": "string" }, "maxComparisonValue": { "description": "Max comparison value is only used for `BETWEEN` operator.", @@ -466,31 +475,11 @@ "comparisonValue": { "description": "The value to compare against. If the operator is `BETWEEN`, this value is\ntreated as minimum comparison value.", "type": "string" - }, - "operator": { - "description": "Specifies is the operation to perform to compare the metric. The default\nis `EQUAL`.", - "type": "string", - "enumDescriptions": [ - "Unspecified operator is treated as `LESS_THAN` operator.", - "Checks if the metric value is less than comparison value.", - "Checks if the metric value is greater than comparison value.", - "Equals operator.", - "For between operator, both the minimum and maximum are exclusive.\nWe will use `LT` and `GT` for comparison." - ], - "enum": [ - "UNSPECIFIED_OPERATOR", - "LESS_THAN", - "GREATER_THAN", - "EQUAL", - "BETWEEN" - ] } }, "id": "SegmentMetricFilter" }, "DateRangeValues": { - "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination", - "type": "object", "properties": { "values": { "description": "Each value corresponds to each Metric in the request.", @@ -507,7 +496,9 @@ } } }, - "id": "DateRangeValues" + "id": "DateRangeValues", + "description": "Used to return a list of metrics for a single DateRange / dimension\ncombination", + "type": "object" }, "CohortGroup": { "description": "Defines a cohort group.\nFor example:\n\n \"cohortGroup\": {\n \"cohorts\": [{\n \"name\": \"cohort 1\",\n \"type\": \"FIRST_VISIT_DATE\",\n \"dateRange\": { \"startDate\": \"2015-08-01\", \"endDate\": \"2015-08-01\" }\n },{\n \"name\": \"cohort 2\"\n \"type\": \"FIRST_VISIT_DATE\"\n \"dateRange\": { \"startDate\": \"2015-07-01\", \"endDate\": \"2015-07-01\" }\n }]\n }", @@ -528,8 +519,6 @@ "id": "CohortGroup" }, "GetReportsRequest": { - "description": "The batch request containing multiple report request.", - "type": "object", "properties": { "useResourceQuotas": { "description": "Enables\n[resource based quotas](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4),\n(defaults to `False`). If this field is set to `True` the\nper view (profile) quotas are governed by the computational\ncost of the request. Note that using cost based quotas will\nhigher enable sampling rates. (10 Million for `SMALL`,\n100M for `LARGE`. See the\n[limits and quotas documentation](/analytics/devguides/reporting/core/v4/limits-quotas#analytics_reporting_api_v4) for details.", @@ -543,17 +532,14 @@ } } }, - "id": "GetReportsRequest" + "id": "GetReportsRequest", + "description": "The batch request containing multiple report request.", + "type": "object" }, "Pivot": { "description": "The Pivot describes the pivot section in the request.\nThe Pivot helps rearrange the information in the table for certain reports\nby pivoting your data on a second dimension.", "type": "object", "properties": { - "maxGroupCount": { - "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.", - "format": "int32", - "type": "integer" - }, "startGroup": { "description": "If k metrics were requested, then the response will contain some\ndata-dependent multiple of k columns in the report. E.g., if you pivoted\non the dimension `ga:browser` then you'd get k columns for \"Firefox\", k\ncolumns for \"IE\", k columns for \"Chrome\", etc. The ordering of the groups\nof columns is determined by descending order of \"total\" for the first of\nthe k values. Ties are broken by lexicographic ordering of the first\npivot dimension, then lexicographic ordering of the second pivot\ndimension, and so on. E.g., if the totals for the first value for\nFirefox, IE, and Chrome were 8, 2, 8, respectively, the order of columns\nwould be Chrome, Firefox, IE.\n\nThe following let you choose which of the groups of k columns are\nincluded in the response.", "format": "int32", @@ -579,13 +565,16 @@ "items": { "$ref": "DimensionFilterClause" } + }, + "maxGroupCount": { + "description": "Specifies the maximum number of groups to return.\nThe default value is 10, also the maximum value is 1,000.", + "format": "int32", + "type": "integer" } }, "id": "Pivot" }, "PivotHeaderEntry": { - "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.", - "type": "object", "properties": { "dimensionNames": { "description": "The name of the dimensions in the pivot response.", @@ -606,23 +595,25 @@ } } }, - "id": "PivotHeaderEntry" + "id": "PivotHeaderEntry", + "description": "The headers for the each of the metric column corresponding to the metrics\nrequested in the pivots section of the response.", + "type": "object" }, "SegmentFilter": { "description": "SegmentFilter defines the segment to be either a simple or a sequence\nsegment. A simple segment condition contains dimension and metric conditions\nto select the sessions or users. A sequence segment condition can be used to\nselect users or sessions based on sequential conditions.", "type": "object", "properties": { - "sequenceSegment": { - "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators.", - "$ref": "SequenceSegment" - }, "not": { "description": "If true, match the complement of simple or sequence segment.\nFor example, to match all visits not from \"New York\", we can define the\nsegment as follows:\n\n \"sessionSegment\": {\n \"segmentFilters\": [{\n \"simpleSegment\" :{\n \"orFiltersForSegment\": [{\n \"segmentFilterClauses\":[{\n \"dimensionFilter\": {\n \"dimensionName\": \"ga:city\",\n \"expressions\": [\"New York\"]\n }\n }]\n }]\n },\n \"not\": \"True\"\n }]\n },", "type": "boolean" }, "simpleSegment": { - "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined", - "$ref": "SimpleSegment" + "$ref": "SimpleSegment", + "description": "A Simple segment conditions consist of one or more dimension/metric\nconditions that can be combined" + }, + "sequenceSegment": { + "description": "Sequence conditions consist of one or more steps, where each step is\ndefined by one or more dimension/metric conditions. Multiple steps can\nbe combined with special sequence operators.", + "$ref": "SequenceSegment" } }, "id": "SegmentFilter" @@ -642,12 +633,12 @@ "id": "SegmentDefinition" }, "MetricHeaderEntry": { - "description": "Header for the metrics.", - "type": "object", "properties": { + "name": { + "description": "The name of the header.", + "type": "string" + }, "type": { - "description": "The type of the metric, for example `INTEGER`.", - "type": "string", "enumDescriptions": [ "Metric type is unspecified.", "Integer metric.", @@ -663,18 +654,16 @@ "CURRENCY", "PERCENT", "TIME" - ] - }, - "name": { - "description": "The name of the header.", + ], + "description": "The type of the metric, for example `INTEGER`.", "type": "string" } }, - "id": "MetricHeaderEntry" + "id": "MetricHeaderEntry", + "description": "Header for the metrics.", + "type": "object" }, "ResourceQuotasRemaining": { - "description": "The resource quota tokens remaining for the property after the request is\ncompleted.", - "type": "object", "properties": { "hourlyQuotaTokensRemaining": { "description": "Hourly resource quota tokens remaining.", @@ -687,12 +676,29 @@ "type": "integer" } }, - "id": "ResourceQuotasRemaining" + "id": "ResourceQuotasRemaining", + "description": "The resource quota tokens remaining for the property after the request is\ncompleted.", + "type": "object" }, "ReportData": { "description": "The data part of the report.", "type": "object", "properties": { + "samplingSpaceSizes": { + "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.", + "type": "array", + "items": { + "format": "int64", + "type": "string" + } + }, + "minimums": { + "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.", + "type": "array", + "items": { + "$ref": "DateRangeValues" + } + }, "totals": { "description": "For each requested date range, for the set of all rows that match\nthe query, every requested value format gets a total. The total\nfor a value format is computed by first totaling the metrics\nmentioned in the value format and then evaluating the value\nformat as a scalar expression. E.g., The \"totals\" for\n`3 / (ga:sessions + 2)` we compute\n`3 / ((sum of all relevant ga:sessions) + 2)`.\nTotals are computed before pagination.", "type": "array", @@ -735,28 +741,11 @@ "items": { "$ref": "DateRangeValues" } - }, - "samplingSpaceSizes": { - "description": "If the results are\n[sampled](https://support.google.com/analytics/answer/2637192),\nthis returns the total number of\nsamples present, one entry per date range. If the results are not sampled\nthis field will not be defined. See\n[developer guide](/analytics/devguides/reporting/core/v4/basics#sampling)\nfor details.", - "type": "array", - "items": { - "format": "int64", - "type": "string" - } - }, - "minimums": { - "description": "Minimum and maximum values seen over all matching rows. These are both\nempty when `hideValueRanges` in the request is false, or when\nrowCount is zero.", - "type": "array", - "items": { - "$ref": "DateRangeValues" - } } }, "id": "ReportData" }, "DimensionFilter": { - "description": "Dimension filter specifies the filtering options on a dimension.", - "type": "object", "properties": { "dimensionName": { "description": "The dimension to filter on. A DimensionFilter must contain a dimension.", @@ -806,7 +795,9 @@ "type": "boolean" } }, - "id": "DimensionFilter" + "id": "DimensionFilter", + "description": "Dimension filter specifies the filtering options on a dimension.", + "type": "object" }, "Segment": { "description": "The segment definition, if the report needs to be segmented.\nA Segment is a subset of the Analytics data. For example, of the entire\nset of users, one Segment might be users from a particular country or city.", @@ -872,6 +863,10 @@ "description": "Dimension filter specifies the filtering options on a dimension.", "type": "object", "properties": { + "minComparisonValue": { + "description": "Minimum comparison values for `BETWEEN` match type.", + "type": "string" + }, "maxComparisonValue": { "description": "Maximum comparison values for `BETWEEN` match type.", "type": "string" @@ -881,18 +876,6 @@ "type": "string" }, "operator": { - "enumDescriptions": [ - "If the match type is unspecified, it is treated as a REGEXP.", - "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.", - "Matches the values which begin with the match expression provided.", - "Matches the values which end with the match expression provided.", - "Substring match.", - "The value should match the match expression entirely.", - "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.", - "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.", - "Checks if the dimension is numerically greater than the match\nexpression.", - "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded." - ], "enum": [ "OPERATOR_UNSPECIFIED", "REGEXP", @@ -906,7 +889,19 @@ "NUMERIC_BETWEEN" ], "description": "The operator to use to match the dimension with the expressions.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "If the match type is unspecified, it is treated as a REGEXP.", + "The match expression is treated as a regular expression. All other match\ntypes are not treated as regular expressions.", + "Matches the values which begin with the match expression provided.", + "Matches the values which end with the match expression provided.", + "Substring match.", + "The value should match the match expression entirely.", + "This option is used to specify a dimension filter whose expression can\ntake any value from a selected list of values. This helps avoiding\nevaluating multiple exact match dimension filters which are OR'ed for\nevery single response row. For example:\n\n expressions: [\"A\", \"B\", \"C\"]\n\nAny response row whose dimension has it is value as A, B or C, matches\nthis DimensionFilter.", + "Integer comparison filters.\ncase sensitivity is ignored for these and the expression\nis assumed to be a string representing an integer.\nFailure conditions:\n\n- if expression is not a valid int64, the client should expect\n an error.\n- input dimensions that are not valid int64 values will never match the\n filter.\n\nChecks if the dimension is numerically less than the match expression.", + "Checks if the dimension is numerically greater than the match\nexpression.", + "Checks if the dimension is numerically between the minimum and maximum\nof the match expression, boundaries excluded." + ] }, "expressions": { "description": "The list of expressions, only the first element is used for all operators", @@ -918,10 +913,6 @@ "caseSensitive": { "description": "Should the match be case sensitive, ignored for `IN_LIST` operator.", "type": "boolean" - }, - "minComparisonValue": { - "description": "Minimum comparison values for `BETWEEN` match type.", - "type": "string" } }, "id": "SegmentDimensionFilter" @@ -955,14 +946,24 @@ "id": "SegmentSequenceStep" }, "Metric": { - "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.", - "type": "object", "properties": { + "alias": { + "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.", + "type": "string" + }, "expression": { "description": "A metric expression in the request. An expression is constructed from one\nor more metrics and numbers. Accepted operators include: Plus (+), Minus\n(-), Negation (Unary -), Divided by (/), Multiplied by (*), Parenthesis,\nPositive cardinal numbers (0-9), can include decimals and is limited to\n1024 characters. Example `ga:totalRefunds/ga:users`, in most cases the\nmetric expression is just a single metric name like `ga:users`.\nAdding mixed `MetricType` (E.g., `CURRENCY` + `PERCENTAGE`) metrics\nwill result in unexpected results.", "type": "string" }, "formattingType": { + "enum": [ + "METRIC_TYPE_UNSPECIFIED", + "INTEGER", + "FLOAT", + "CURRENCY", + "PERCENT", + "TIME" + ], "description": "Specifies how the metric expression should be formatted, for example\n`INTEGER`.", "type": "string", "enumDescriptions": [ @@ -972,26 +973,14 @@ "Currency metric.", "Percentage metric.", "Time metric in `HH:MM:SS` format." - ], - "enum": [ - "METRIC_TYPE_UNSPECIFIED", - "INTEGER", - "FLOAT", - "CURRENCY", - "PERCENT", - "TIME" ] - }, - "alias": { - "description": "An alias for the metric expression is an alternate name for the\nexpression. The alias can be used for filtering and sorting. This field\nis optional and is useful if the expression is not a single metric but\na complex expression which cannot be used in filtering and sorting.\nThe alias is also used in the response column header.", - "type": "string" } }, - "id": "Metric" + "id": "Metric", + "description": "[Metrics](https://support.google.com/analytics/answer/1033861)\nare the quantitative measurements. For example, the metric `ga:users`\nindicates the total number of users for the requested time period.", + "type": "object" }, "PivotValueRegion": { - "description": "The metric values in the pivot region.", - "type": "object", "properties": { "values": { "description": "The values of the metrics in each of the pivot regions.", @@ -1001,7 +990,9 @@ } } }, - "id": "PivotValueRegion" + "id": "PivotValueRegion", + "description": "The metric values in the pivot region.", + "type": "object" }, "Report": { "description": "The data response corresponding to the request.", @@ -1012,8 +1003,8 @@ "description": "The column headers." }, "data": { - "description": "Response data.", - "$ref": "ReportData" + "$ref": "ReportData", + "description": "Response data." }, "nextPageToken": { "description": "Page token to retrieve the next page of results in the list.", @@ -1023,8 +1014,6 @@ "id": "Report" }, "PivotHeader": { - "description": "The headers for each of the pivot sections defined in the request.", - "type": "object", "properties": { "pivotHeaderEntries": { "description": "A single pivot section header.", @@ -1039,7 +1028,24 @@ "type": "integer" } }, - "id": "PivotHeader" + "id": "PivotHeader", + "description": "The headers for each of the pivot sections defined in the request.", + "type": "object" + }, + "DateRange": { + "description": "A contiguous set of days: startDate, startDate + 1 day, ..., endDate.\nThe start and end dates are specified in\n[ISO8601](https://en.wikipedia.org/wiki/ISO_8601) date format `YYYY-MM-DD`.", + "type": "object", + "properties": { + "startDate": { + "description": "The start date for the query in the format `YYYY-MM-DD`.", + "type": "string" + }, + "endDate": { + "description": "The end date for the query in the format `YYYY-MM-DD`.", + "type": "string" + } + }, + "id": "DateRange" } }, "icons": { @@ -1051,11 +1057,11 @@ "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/analytics": { - "description": "View and manage your Google Analytics data" - }, "https://www.googleapis.com/auth/analytics.readonly": { "description": "View your Google Analytics data" + }, + "https://www.googleapis.com/auth/analytics": { + "description": "View and manage your Google Analytics data" } } } @@ -1092,27 +1098,48 @@ } }, "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", "type": "string", "location": "query" }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, "$.xgafv": { "enumDescriptions": [ "v1 error format", @@ -1147,34 +1174,13 @@ ], "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.", - "type": "string", - "location": "query" - }, "access_token": { "location": "query", "description": "OAuth access token.", "type": "string" }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "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.", "type": "string", "location": "query" } @@ -1183,11 +1189,5 @@ "baseUrl": "https://analyticsreporting.googleapis.com/", "kind": "discovery#restDescription", "description": "Accesses Analytics report data.", - "servicePath": "", - "basePath": "", - "id": "analyticsreporting:v4", - "revision": "20171108", - "documentationLink": "https://developers.google.com/analytics/devguides/reporting/core/v4/", - "discoveryVersion": "v1", - "version_module": true + "servicePath": "" }
diff --git a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json index e413a15..a54161b 100644 --- a/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json +++ b/androiddeviceprovisioning/v1/androiddeviceprovisioning-api.json
@@ -1,15 +1,11 @@ { - "kind": "discovery#restDescription", - "description": "Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports.", - "servicePath": "", - "rootUrl": "https://androiddeviceprovisioning.googleapis.com/", "basePath": "", "ownerDomain": "google.com", "name": "androiddeviceprovisioning", "batchPath": "batch", - "revision": "20171216", - "documentationLink": "https://developers.google.com/zero-touch/", "id": "androiddeviceprovisioning:v1", + "documentationLink": "https://developers.google.com/zero-touch/", + "revision": "20180106", "title": "Android Device Provisioning Partner API", "ownerName": "Google", "discoveryVersion": "v1", @@ -18,6 +14,10 @@ "customers": { "methods": { "list": { + "flatPath": "v1/customers", + "path": "v1/customers", + "id": "androiddeviceprovisioning.customers.list", + "description": "List the user's customer accounts.", "response": { "$ref": "CustomerListCustomersResponse" }, @@ -30,23 +30,203 @@ "location": "query" }, "pageSize": { - "location": "query", "description": "The maximum number of items to return.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" } - }, - "flatPath": "v1/customers", - "path": "v1/customers", - "id": "androiddeviceprovisioning.customers.list", - "description": "List the user's customer accounts." + } } }, "resources": { + "dpcs": { + "methods": { + "list": { + "id": "androiddeviceprovisioning.customers.dpcs.list", + "path": "v1/{+parent}/dpcs", + "description": "Lists the DPCs (device policy controllers) that support zero-touch\nenrollment.", + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "CustomerListDpcsResponse" + }, + "parameters": { + "parent": { + "location": "path", + "description": "Required. The customer that can use the DPCs in configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.", + "required": true, + "type": "string", + "pattern": "^customers/[^/]+$" + } + }, + "flatPath": "v1/customers/{customersId}/dpcs" + } + } + }, + "devices": { + "methods": { + "applyConfiguration": { + "request": { + "$ref": "CustomerApplyConfigurationRequest" + }, + "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^customers/[^/]+$", + "location": "path", + "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`." + } + }, + "flatPath": "v1/customers/{customersId}/devices:applyConfiguration", + "path": "v1/{+parent}/devices:applyConfiguration", + "id": "androiddeviceprovisioning.customers.devices.applyConfiguration" + }, + "list": { + "description": "Lists a customer's devices.", + "response": { + "$ref": "CustomerListDevicesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "A token specifying which result page to return.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of devices to show in a page of results. The default\nvalue returns all the devices in a single page.", + "format": "int64", + "type": "string" + }, + "parent": { + "required": true, + "type": "string", + "pattern": "^customers/[^/]+$", + "location": "path", + "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`." + } + }, + "flatPath": "v1/customers/{customersId}/devices", + "path": "v1/{+parent}/devices", + "id": "androiddeviceprovisioning.customers.devices.list" + }, + "get": { + "httpMethod": "GET", + "response": { + "$ref": "Device" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "pattern": "^customers/[^/]+/devices/[^/]+$", + "location": "path", + "description": "Required. The device to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/customers/{customersId}/devices/{devicesId}", + "id": "androiddeviceprovisioning.customers.devices.get", + "path": "v1/{+name}", + "description": "Gets the details of a device." + }, + "unclaim": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "pattern": "^customers/[^/]+$", + "location": "path", + "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/customers/{customersId}/devices:unclaim", + "path": "v1/{+parent}/devices:unclaim", + "id": "androiddeviceprovisioning.customers.devices.unclaim", + "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.\n\nAfter removing a device, a customer must contact their reseller to register\nthe device into zero-touch enrollment again.", + "request": { + "$ref": "CustomerUnclaimDeviceRequest" + } + }, + "removeConfiguration": { + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^customers/[^/]+$", + "location": "path", + "description": "Required. The customer managing the device in the format\n`customers/[CUSTOMER_ID]`." + } + }, + "flatPath": "v1/customers/{customersId}/devices:removeConfiguration", + "id": "androiddeviceprovisioning.customers.devices.removeConfiguration", + "path": "v1/{+parent}/devices:removeConfiguration", + "description": "Removes a configuration from device.", + "request": { + "$ref": "CustomerRemoveConfigurationRequest" + }, + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Empty" + } + } + } + }, "configurations": { "methods": { + "create": { + "flatPath": "v1/customers/{customersId}/configurations", + "id": "androiddeviceprovisioning.customers.configurations.create", + "path": "v1/{+parent}/configurations", + "request": { + "$ref": "Configuration" + }, + "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Configuration" + }, + "parameters": { + "parent": { + "description": "Required. The customer that manages the configuration. An API resource name\nin the format `customers/[CUSTOMER_ID]`.", + "required": true, + "type": "string", + "pattern": "^customers/[^/]+$", + "location": "path" + } + } + }, "delete": { - "description": "Deletes an unused configuration. The API call fails if the customer has\ndevices with the configuration applied.", "httpMethod": "DELETE", "parameterOrder": [ "name" @@ -56,25 +236,19 @@ }, "parameters": { "name": { + "description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails.", "required": true, "type": "string", "pattern": "^customers/[^/]+/configurations/[^/]+$", - "location": "path", - "description": "Required. The configuration to delete. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. If the\nconfiguration is applied to any devices, the API call fails." + "location": "path" } }, "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}", "id": "androiddeviceprovisioning.customers.configurations.delete", - "path": "v1/{+name}" + "path": "v1/{+name}", + "description": "Deletes an unused configuration. The API call fails if the customer has\ndevices with the configuration applied." }, "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Configuration" - }, "parameters": { "name": { "description": "Required. The configuration to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.", @@ -85,24 +259,37 @@ } }, "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}", - "id": "androiddeviceprovisioning.customers.configurations.get", "path": "v1/{+name}", - "description": "Gets the details of a configuration." - }, - "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], + "id": "androiddeviceprovisioning.customers.configurations.get", + "description": "Gets the details of a configuration.", "response": { "$ref": "Configuration" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET" + }, + "patch": { + "path": "v1/{+name}", + "id": "androiddeviceprovisioning.customers.configurations.patch", + "request": { + "$ref": "Configuration" + }, + "description": "Updates a configuration's field values.", + "response": { + "$ref": "Configuration" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", "parameters": { "updateMask": { + "location": "query", "description": "Required. The field mask applied to the target `Configuration` before\nupdating the fields. To learn more about using field masks, read\n[FieldMask](/protocol-buffers/docs/reference/google.protobuf#fieldmask) in\nthe Protocol Buffers documentation.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "name": { "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.", @@ -112,13 +299,7 @@ "location": "path" } }, - "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}", - "id": "androiddeviceprovisioning.customers.configurations.patch", - "path": "v1/{+name}", - "request": { - "$ref": "Configuration" - }, - "description": "Updates a configuration's field values." + "flatPath": "v1/customers/{customersId}/configurations/{configurationsId}" }, "list": { "description": "Lists a customer's configurations.", @@ -131,201 +312,16 @@ "httpMethod": "GET", "parameters": { "parent": { - "description": "Required. The customer that manages the listed configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.", "required": true, "type": "string", "pattern": "^customers/[^/]+$", - "location": "path" + "location": "path", + "description": "Required. The customer that manages the listed configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`." } }, "flatPath": "v1/customers/{customersId}/configurations", "path": "v1/{+parent}/configurations", "id": "androiddeviceprovisioning.customers.configurations.list" - }, - "create": { - "flatPath": "v1/customers/{customersId}/configurations", - "path": "v1/{+parent}/configurations", - "id": "androiddeviceprovisioning.customers.configurations.create", - "description": "Creates a new configuration. Once created, a customer can apply the\nconfiguration to devices.", - "request": { - "$ref": "Configuration" - }, - "response": { - "$ref": "Configuration" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "required": true, - "type": "string", - "pattern": "^customers/[^/]+$", - "location": "path", - "description": "Required. The customer that manages the configuration. An API resource name\nin the format `customers/[CUSTOMER_ID]`." - } - } - } - } - }, - "dpcs": { - "methods": { - "list": { - "description": "Lists the DPCs (device policy controllers) that support zero-touch\nenrollment.", - "response": { - "$ref": "CustomerListDpcsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The customer that can use the DPCs in configurations. An API\nresource name in the format `customers/[CUSTOMER_ID]`.", - "required": true, - "type": "string", - "pattern": "^customers/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/customers/{customersId}/dpcs", - "path": "v1/{+parent}/dpcs", - "id": "androiddeviceprovisioning.customers.dpcs.list" - } - } - }, - "devices": { - "methods": { - "applyConfiguration": { - "flatPath": "v1/customers/{customersId}/devices:applyConfiguration", - "path": "v1/{+parent}/devices:applyConfiguration", - "id": "androiddeviceprovisioning.customers.devices.applyConfiguration", - "description": "Applies a Configuration to the device to register the device for zero-touch\nenrollment. After applying a configuration to a device, the device\nautomatically provisions itself on first boot, or next factory reset.", - "request": { - "$ref": "CustomerApplyConfigurationRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.", - "required": true, - "type": "string", - "pattern": "^customers/[^/]+$", - "location": "path" - } - } - }, - "list": { - "httpMethod": "GET", - "response": { - "$ref": "CustomerListDevicesResponse" - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "pattern": "^customers/[^/]+$", - "location": "path", - "description": "Required. The customer managing the devices. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "A token specifying which result page to return.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The maximum number of devices to show in a page of results. The default\nvalue returns all the devices in a single page.", - "format": "int64", - "type": "string" - } - }, - "flatPath": "v1/customers/{customersId}/devices", - "id": "androiddeviceprovisioning.customers.devices.list", - "path": "v1/{+parent}/devices", - "description": "Lists a customer's devices." - }, - "get": { - "path": "v1/{+name}", - "id": "androiddeviceprovisioning.customers.devices.get", - "description": "Gets the details of a device.", - "response": { - "$ref": "Device" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "pattern": "^customers/[^/]+/devices/[^/]+$", - "location": "path", - "description": "Required. The device to get. An API resource name in the format\n`customers/[CUSTOMER_ID]/devices/[DEVICE_ID]`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/customers/{customersId}/devices/{devicesId}" - }, - "unclaim": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "location": "path", - "description": "Required. The customer managing the device. An API resource name in the\nformat `customers/[CUSTOMER_ID]`.", - "required": true, - "type": "string", - "pattern": "^customers/[^/]+$" - } - }, - "flatPath": "v1/customers/{customersId}/devices:unclaim", - "path": "v1/{+parent}/devices:unclaim", - "id": "androiddeviceprovisioning.customers.devices.unclaim", - "description": "Unclaims a device from a customer and removes it from zero-touch\nenrollment.\n\nAfter removing a device, a customer must contact their reseller to register\nthe device into zero-touch enrollment again.", - "request": { - "$ref": "CustomerUnclaimDeviceRequest" - } - }, - "removeConfiguration": { - "request": { - "$ref": "CustomerRemoveConfigurationRequest" - }, - "description": "Removes a configuration from device.", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "parent": { - "location": "path", - "description": "Required. The customer managing the device in the format\n`customers/[CUSTOMER_ID]`.", - "required": true, - "type": "string", - "pattern": "^customers/[^/]+$" - } - }, - "flatPath": "v1/customers/{customersId}/devices:removeConfiguration", - "id": "androiddeviceprovisioning.customers.devices.removeConfiguration", - "path": "v1/{+parent}/devices:removeConfiguration" } } } @@ -335,11 +331,7 @@ "resources": { "devices": { "methods": { - "claimAsync": { - "description": "Claim devices asynchronously.", - "request": { - "$ref": "ClaimDevicesRequest" - }, + "updateMetadataAsync": { "httpMethod": "POST", "parameterOrder": [ "partnerId" @@ -357,17 +349,97 @@ "pattern": "^[^/]+$" } }, - "flatPath": "v1/partners/{partnersId}/devices:claimAsync", - "id": "androiddeviceprovisioning.partners.devices.claimAsync", - "path": "v1/partners/{+partnerId}/devices:claimAsync" - }, - "findByIdentifier": { + "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync", + "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync", + "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync", "request": { - "$ref": "FindDevicesByDeviceIdentifierRequest" + "$ref": "UpdateDeviceMetadataInBatchRequest" }, - "description": "Find devices by device identifier.", + "description": "Set metadata in batch asynchronously." + }, + "get": { + "path": "v1/{+name}", + "id": "androiddeviceprovisioning.partners.devices.get", + "description": "Get a device.", "response": { - "$ref": "FindDevicesByDeviceIdentifierResponse" + "$ref": "Device" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.", + "required": true, + "type": "string", + "pattern": "^partners/[^/]+/devices/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/partners/{partnersId}/devices/{devicesId}" + }, + "unclaim": { + "id": "androiddeviceprovisioning.partners.devices.unclaim", + "path": "v1/partners/{+partnerId}/devices:unclaim", + "request": { + "$ref": "UnclaimDeviceRequest" + }, + "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.", + "httpMethod": "POST", + "parameterOrder": [ + "partnerId" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "partnerId": { + "location": "path", + "description": "ID of the partner.", + "pattern": "^[^/]+$", + "format": "int64", + "type": "string", + "required": true + } + }, + "flatPath": "v1/partners/{partnersId}/devices:unclaim" + }, + "findByOwner": { + "id": "androiddeviceprovisioning.partners.devices.findByOwner", + "path": "v1/partners/{+partnerId}/devices:findByOwner", + "request": { + "$ref": "FindDevicesByOwnerRequest" + }, + "description": "Find devices by ownership.", + "httpMethod": "POST", + "parameterOrder": [ + "partnerId" + ], + "response": { + "$ref": "FindDevicesByOwnerResponse" + }, + "parameters": { + "partnerId": { + "pattern": "^[^/]+$", + "format": "int64", + "required": true, + "type": "string", + "location": "path", + "description": "ID of the partner." + } + }, + "flatPath": "v1/partners/{partnersId}/devices:findByOwner" + }, + "claim": { + "path": "v1/partners/{+partnerId}/devices:claim", + "id": "androiddeviceprovisioning.partners.devices.claim", + "description": "Claim the device identified by device identifier.", + "request": { + "$ref": "ClaimDeviceRequest" + }, + "response": { + "$ref": "ClaimDeviceResponse" }, "parameterOrder": [ "partnerId" @@ -375,25 +447,21 @@ "httpMethod": "POST", "parameters": { "partnerId": { + "location": "path", "description": "ID of the partner.", "pattern": "^[^/]+$", "format": "int64", - "required": true, "type": "string", - "location": "path" + "required": true } }, - "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier", - "path": "v1/partners/{+partnerId}/devices:findByIdentifier", - "id": "androiddeviceprovisioning.partners.devices.findByIdentifier" + "flatPath": "v1/partners/{partnersId}/devices:claim" }, - "unclaimAsync": { - "path": "v1/partners/{+partnerId}/devices:unclaimAsync", - "id": "androiddeviceprovisioning.partners.devices.unclaimAsync", - "description": "Unclaim devices asynchronously.", + "claimAsync": { "request": { - "$ref": "UnclaimDevicesRequest" + "$ref": "ClaimDevicesRequest" }, + "description": "Claim devices asynchronously.", "response": { "$ref": "Operation" }, @@ -411,7 +479,61 @@ "location": "path" } }, - "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync" + "flatPath": "v1/partners/{partnersId}/devices:claimAsync", + "path": "v1/partners/{+partnerId}/devices:claimAsync", + "id": "androiddeviceprovisioning.partners.devices.claimAsync" + }, + "findByIdentifier": { + "description": "Find devices by device identifier.", + "request": { + "$ref": "FindDevicesByDeviceIdentifierRequest" + }, + "response": { + "$ref": "FindDevicesByDeviceIdentifierResponse" + }, + "parameterOrder": [ + "partnerId" + ], + "httpMethod": "POST", + "parameters": { + "partnerId": { + "location": "path", + "description": "ID of the partner.", + "pattern": "^[^/]+$", + "format": "int64", + "type": "string", + "required": true + } + }, + "flatPath": "v1/partners/{partnersId}/devices:findByIdentifier", + "path": "v1/partners/{+partnerId}/devices:findByIdentifier", + "id": "androiddeviceprovisioning.partners.devices.findByIdentifier" + }, + "unclaimAsync": { + "request": { + "$ref": "UnclaimDevicesRequest" + }, + "description": "Unclaim devices asynchronously.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "partnerId" + ], + "httpMethod": "POST", + "parameters": { + "partnerId": { + "format": "int64", + "required": true, + "type": "string", + "location": "path", + "description": "Partner ID.", + "pattern": "^[^/]+$" + } + }, + "flatPath": "v1/partners/{partnersId}/devices:unclaimAsync", + "path": "v1/partners/{+partnerId}/devices:unclaimAsync", + "id": "androiddeviceprovisioning.partners.devices.unclaimAsync" }, "metadata": { "response": { @@ -424,19 +546,19 @@ "httpMethod": "POST", "parameters": { "metadataOwnerId": { + "description": "The owner of the newly set metadata. Set this to the partner ID.", + "pattern": "^[^/]+$", "format": "int64", "required": true, "type": "string", - "location": "path", - "description": "The owner of the newly set metadata. Set this to the partner ID.", - "pattern": "^[^/]+$" + "location": "path" }, "deviceId": { "description": "ID of the partner.", "pattern": "^[^/]+$", "format": "int64", - "type": "string", "required": true, + "type": "string", "location": "path" } }, @@ -447,184 +569,58 @@ "$ref": "UpdateDeviceMetadataRequest" }, "description": "Update the metadata." - }, - "updateMetadataAsync": { - "path": "v1/partners/{+partnerId}/devices:updateMetadataAsync", - "id": "androiddeviceprovisioning.partners.devices.updateMetadataAsync", - "request": { - "$ref": "UpdateDeviceMetadataInBatchRequest" - }, - "description": "Set metadata in batch asynchronously.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "partnerId" - ], - "httpMethod": "POST", - "parameters": { - "partnerId": { - "location": "path", - "description": "Partner ID.", - "pattern": "^[^/]+$", - "format": "int64", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/partners/{partnersId}/devices:updateMetadataAsync" - }, - "get": { - "httpMethod": "GET", - "response": { - "$ref": "Device" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "location": "path", - "description": "Resource name in `partners/[PARTNER_ID]/devices/[DEVICE_ID]`.", - "required": true, - "type": "string", - "pattern": "^partners/[^/]+/devices/[^/]+$" - } - }, - "flatPath": "v1/partners/{partnersId}/devices/{devicesId}", - "id": "androiddeviceprovisioning.partners.devices.get", - "path": "v1/{+name}", - "description": "Get a device." - }, - "unclaim": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "partnerId" - ], - "httpMethod": "POST", - "parameters": { - "partnerId": { - "format": "int64", - "required": true, - "type": "string", - "location": "path", - "description": "ID of the partner.", - "pattern": "^[^/]+$" - } - }, - "flatPath": "v1/partners/{partnersId}/devices:unclaim", - "path": "v1/partners/{+partnerId}/devices:unclaim", - "id": "androiddeviceprovisioning.partners.devices.unclaim", - "description": "Unclaim the device identified by the `device_id` or the `deviceIdentifier`.", - "request": { - "$ref": "UnclaimDeviceRequest" - } - }, - "findByOwner": { - "httpMethod": "POST", - "parameterOrder": [ - "partnerId" - ], - "response": { - "$ref": "FindDevicesByOwnerResponse" - }, - "parameters": { - "partnerId": { - "description": "ID of the partner.", - "pattern": "^[^/]+$", - "format": "int64", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/partners/{partnersId}/devices:findByOwner", - "id": "androiddeviceprovisioning.partners.devices.findByOwner", - "path": "v1/partners/{+partnerId}/devices:findByOwner", - "request": { - "$ref": "FindDevicesByOwnerRequest" - }, - "description": "Find devices by ownership." - }, - "claim": { - "description": "Claim the device identified by device identifier.", - "request": { - "$ref": "ClaimDeviceRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "partnerId" - ], - "response": { - "$ref": "ClaimDeviceResponse" - }, - "parameters": { - "partnerId": { - "format": "int64", - "required": true, - "type": "string", - "location": "path", - "description": "ID of the partner.", - "pattern": "^[^/]+$" - } - }, - "flatPath": "v1/partners/{partnersId}/devices:claim", - "id": "androiddeviceprovisioning.partners.devices.claim", - "path": "v1/partners/{+partnerId}/devices:claim" } } }, "customers": { "methods": { "list": { - "id": "androiddeviceprovisioning.partners.customers.list", - "path": "v1/partners/{+partnerId}/customers", "description": "Lists the customers that are enrolled to the reseller identified by the\n`partnerId` argument. This list includes customers that the reseller\ncreated and customers that enrolled themselves using the portal.", "httpMethod": "GET", - "parameterOrder": [ - "partnerId" - ], "response": { "$ref": "ListCustomersResponse" }, + "parameterOrder": [ + "partnerId" + ], "parameters": { "partnerId": { + "location": "path", + "description": "The ID of the partner.", "pattern": "^[^/]+$", "format": "int64", - "required": true, "type": "string", - "location": "path", - "description": "The ID of the partner." - } - }, - "flatPath": "v1/partners/{partnersId}/customers" - }, - "create": { - "request": { - "$ref": "CreateCustomerRequest" - }, - "description": "Creates a customer for zero-touch enrollment. After the method returns\nsuccessfully, admin and owner roles can manage devices and EMM configs\nby calling API methods or using their zero-touch enrollment portal. The API\ndoesn't notify the customer that they have access.", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "Company" - }, - "parameters": { - "parent": { - "required": true, - "type": "string", - "pattern": "^partners/[^/]+$", - "location": "path", - "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller." + "required": true } }, "flatPath": "v1/partners/{partnersId}/customers", + "id": "androiddeviceprovisioning.partners.customers.list", + "path": "v1/partners/{+partnerId}/customers" + }, + "create": { + "response": { + "$ref": "Company" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "location": "path", + "description": "Required. The parent resource ID in the format `partners/[PARTNER_ID]` that\nidentifies the reseller.", + "required": true, + "type": "string", + "pattern": "^partners/[^/]+$" + } + }, + "flatPath": "v1/partners/{partnersId}/customers", + "path": "v1/{+parent}/customers", "id": "androiddeviceprovisioning.partners.customers.create", - "path": "v1/{+parent}/customers" + "description": "Creates a customer for zero-touch enrollment. After the method returns\nsuccessfully, admin and owner roles can manage devices and EMM configs\nby calling API methods or using their zero-touch enrollment portal. The API\ndoesn't notify the customer that they have access.", + "request": { + "$ref": "CreateCustomerRequest" + } } } } @@ -633,10 +629,6 @@ "operations": { "methods": { "get": { - "flatPath": "v1/operations/{operationsId}", - "path": "v1/{+name}", - "id": "androiddeviceprovisioning.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.", "response": { "$ref": "Operation" }, @@ -646,37 +638,54 @@ "httpMethod": "GET", "parameters": { "name": { - "pattern": "^operations/.+$", "location": "path", "description": "The name of the operation resource.", "required": true, - "type": "string" + "type": "string", + "pattern": "^operations/.+$" } - } + }, + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "androiddeviceprovisioning.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." } } } }, "parameters": { "upload_protocol": { + "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query", + "description": "Returns response with indentations and line breaks." + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], "location": "query" }, "callback": { @@ -684,21 +693,7 @@ "type": "string", "location": "query" }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, "alt": { - "description": "Data format for response.", "default": "json", "enum": [ "json", @@ -711,68 +706,65 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], + "location": "query", + "description": "Data format for response." + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", "location": "query" }, "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.", - "type": "string", - "location": "query" - }, - "access_token": { "location": "query", - "description": "OAuth access token.", + "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.", "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.", "type": "string", - "location": "query" + "location": "query", + "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." }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", "location": "query" }, "bearer_token": { "description": "OAuth bearer token.", "type": "string", "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" } }, "schemas": { "CreateCustomerRequest": { + "description": "Request message to create a customer.", + "type": "object", "properties": { "customer": { "$ref": "Company", "description": "Required. The company data to populate the new customer. Must contain a\nvalue for `companyName` and at least one `owner_email` that's associated\nwith a Google Account. The values for `companyId` and `name` must be empty." } }, - "id": "CreateCustomerRequest", - "description": "Request message to create a customer.", - "type": "object" + "id": "CreateCustomerRequest" }, "Company": { + "id": "Company", "description": "A customer resource in the zero-touch enrollment API.", "type": "object", "properties": { - "companyId": { - "description": "Output only. The ID of the company. Assigned by the server.", - "format": "int64", - "type": "string" - }, "name": { "description": "Output only. The API resource name of the company in the format\n`partners/[PARTNER_ID]/customers/[CUSTOMER_ID]`. Assigned by the server.", "type": "string" }, "companyName": { - "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal.", - "type": "string" + "type": "string", + "description": "Required. The name of the company. For example _XYZ Corp_. Characters\nallowed are: Latin letters, numerals, hyphens, and spaces. Displayed to the\ncustomer's employees in the zero-touch enrollment portal." }, "adminEmails": { "description": "Input only. Optional. Email address of customer's users in the admin role.\nEach email address must be associated with a Google Account.", @@ -782,14 +774,18 @@ } }, "ownerEmails": { + "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users.", "type": "array", "items": { "type": "string" - }, - "description": "Input only. Email address of customer's users in the owner role. At least\none `owner_email` is required. Each email address must be associated with a\nGoogle Account. Owners share the same access as admins but can also add,\ndelete, and edit your organization's portal users." + } + }, + "companyId": { + "type": "string", + "description": "Output only. The ID of the company. Assigned by the server.", + "format": "int64" } - }, - "id": "Company" + } }, "UpdateDeviceMetadataRequest": { "description": "Request to set metadata for a device.", @@ -803,60 +799,60 @@ "id": "UpdateDeviceMetadataRequest" }, "Configuration": { - "description": "A configuration collects the provisioning options for Android devices. Each\nconfiguration combines the following:\n\n* The EMM device policy controller (DPC) installed on the devices.\n* EMM policies enforced on the devices.\n* Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch\nenrollment works best when a customer sets a default configuration that's\napplied to any new devices the organization purchases.", - "type": "object", "properties": { - "dpcResourcePath": { - "type": "string", - "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`." - }, - "configurationId": { - "description": "Output only. The ID of the configuration. Assigned by the server.", - "format": "int64", - "type": "string" - }, - "companyName": { - "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning.", - "type": "string" - }, - "isDefault": { - "description": "Required. Whether this is the default configuration that zero-touch\nenrollment applies to any new devices the organization purchases in the\nfuture. Only one customer configuration can be the default. Setting this\nvalue to `true`, changes the previous default configuration's `isDefault`\nvalue to `false`.", - "type": "boolean" - }, - "customMessage": { - "type": "string", - "description": "A message, containing one or two sentences, to help device users get help\nor give them more details about what’s happening to their device.\nZero-touch enrollment shows this message before the device is provisioned." - }, - "dpcExtras": { - "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.", - "type": "string" - }, "contactEmail": { - "description": "Required. The email address that device users can contact to get help.\nZero-touch enrollment shows this email address to device users before\ndevice provisioning. The value is validated on input.", - "type": "string" + "type": "string", + "description": "Required. The email address that device users can contact to get help.\nZero-touch enrollment shows this email address to device users before\ndevice provisioning. The value is validated on input." }, "name": { "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`. Assigned by\nthe server.", "type": "string" }, "configurationName": { - "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins.", - "type": "string" + "type": "string", + "description": "Required. A short name that describes the configuration's purpose. For\nexample, _Sales team_ or _Temporary employees_. The zero-touch enrollment\nportal displays this name to IT admins." }, "contactPhone": { "description": "Required. The telephone number that device users can call, using another\ndevice, to get help. Zero-touch enrollment shows this number to device\nusers before device provisioning. Accepts numerals, spaces, the plus sign,\nhyphens, and parentheses.", "type": "string" + }, + "companyName": { + "description": "Required. The name of the organization. Zero-touch enrollment shows this\norganization name to device users during device provisioning.", + "type": "string" + }, + "configurationId": { + "description": "Output only. The ID of the configuration. Assigned by the server.", + "format": "int64", + "type": "string" + }, + "dpcResourcePath": { + "description": "Required. The resource name of the selected DPC (device policy controller)\nin the format `customers/[CUSTOMER_ID]/dpcs/*`. To list the supported DPCs,\ncall\n`customers.dpcs.list`.", + "type": "string" + }, + "isDefault": { + "description": "Required. Whether this is the default configuration that zero-touch\nenrollment applies to any new devices the organization purchases in the\nfuture. Only one customer configuration can be the default. Setting this\nvalue to `true`, changes the previous default configuration's `isDefault`\nvalue to `false`.", + "type": "boolean" + }, + "dpcExtras": { + "description": "The JSON-formatted EMM provisioning extras that are passed to the DPC.", + "type": "string" + }, + "customMessage": { + "description": "A message, containing one or two sentences, to help device users get help\nor give them more details about what’s happening to their device.\nZero-touch enrollment shows this message before the device is provisioned.", + "type": "string" } }, - "id": "Configuration" + "id": "Configuration", + "description": "A configuration collects the provisioning options for Android devices. Each\nconfiguration combines the following:\n\n* The EMM device policy controller (DPC) installed on the devices.\n* EMM policies enforced on the devices.\n* Metadata displayed on the device to help users during setup.\n\nCustomers can add as many configurations as they need. However, zero-touch\nenrollment works best when a customer sets a default configuration that's\napplied to any new devices the organization purchases.", + "type": "object" }, "PartnerUnclaim": { "description": "Identifies one unclaim request.", "type": "object", "properties": { "deviceIdentifier": { - "$ref": "DeviceIdentifier", - "description": "Device identifier of the device." + "description": "Device identifier of the device.", + "$ref": "DeviceIdentifier" }, "sectionType": { "enum": [ @@ -871,9 +867,9 @@ ] }, "deviceId": { - "type": "string", "description": "Device ID of the device.", - "format": "int64" + "format": "int64", + "type": "string" } }, "id": "PartnerUnclaim" @@ -893,34 +889,38 @@ "id": "CustomerListDpcsResponse" }, "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 `{}`.", "type": "object", "properties": {}, - "id": "Empty" + "id": "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 `{}`." }, "FindDevicesByDeviceIdentifierResponse": { "description": "Response containing found devices.", "type": "object", "properties": { + "nextPageToken": { + "type": "string", + "description": "Page token of the next page." + }, "devices": { "description": "Found devices.", "type": "array", "items": { "$ref": "Device" } - }, - "nextPageToken": { - "type": "string", - "description": "Page token of the next page." } }, "id": "FindDevicesByDeviceIdentifierResponse" }, "PartnerClaim": { - "id": "PartnerClaim", "description": "Identifies one claim request.", "type": "object", "properties": { + "customerId": { + "description": "Customer ID to claim for.", + "format": "int64", + "type": "string" + }, "deviceIdentifier": { "description": "Device identifier of the device.", "$ref": "DeviceIdentifier" @@ -930,8 +930,6 @@ "$ref": "DeviceMetadata" }, "sectionType": { - "description": "Section type to claim.", - "type": "string", "enumDescriptions": [ "Unspecified section type.", "Zero-touch enrollment section type." @@ -939,25 +937,27 @@ "enum": [ "SECTION_TYPE_UNSPECIFIED", "SECTION_TYPE_ZERO_TOUCH" - ] - }, - "customerId": { - "description": "Customer ID to claim for.", - "format": "int64", + ], + "description": "Section type to claim.", "type": "string" } - } + }, + "id": "PartnerClaim" }, "UnclaimDeviceRequest": { "description": "Request message to unclaim a device.", "type": "object", "properties": { + "deviceId": { + "description": "The device ID returned by `ClaimDevice`.", + "format": "int64", + "type": "string" + }, "deviceIdentifier": { "$ref": "DeviceIdentifier", "description": "The device identifier you used when you claimed this device." }, "sectionType": { - "type": "string", "enumDescriptions": [ "Unspecified section type.", "Zero-touch enrollment section type." @@ -966,68 +966,63 @@ "SECTION_TYPE_UNSPECIFIED", "SECTION_TYPE_ZERO_TOUCH" ], - "description": "The section type to unclaim for." - }, - "deviceId": { - "description": "The device ID returned by `ClaimDevice`.", - "format": "int64", + "description": "The section type to unclaim for.", "type": "string" } }, "id": "UnclaimDeviceRequest" }, "DeviceMetadata": { + "description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata).", "type": "object", "properties": { "entries": { + "description": "Metadata entries recorded as key-value pairs.", + "type": "object", "additionalProperties": { "type": "string" - }, - "description": "Metadata entries recorded as key-value pairs.", - "type": "object" + } } }, - "id": "DeviceMetadata", - "description": "Metadata entries that can be attached to a `Device`. To learn more, read\n[Device metadata](/zero-touch/guides/metadata)." + "id": "DeviceMetadata" }, "CustomerListCustomersResponse": { + "description": "Response message for listing my customers.", + "type": "object", "properties": { "nextPageToken": { "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", "type": "string" }, "customers": { + "description": "Customers the current user can act as.", "type": "array", "items": { "$ref": "Company" - }, - "description": "Customers the current user can act as." + } } }, - "id": "CustomerListCustomersResponse", - "description": "Response message for listing my customers.", - "type": "object" + "id": "CustomerListCustomersResponse" }, "CustomerListDevicesResponse": { "description": "Response message of customer's liting devices.", "type": "object", "properties": { - "devices": { - "description": "The customer's devices.", - "type": "array", - "items": { - "$ref": "Device" - } - }, "nextPageToken": { "description": "A token used to access the next page of results. Omitted if no further\nresults are available.", "type": "string" + }, + "devices": { + "type": "array", + "items": { + "$ref": "Device" + }, + "description": "The customer's devices." } }, "id": "CustomerListDevicesResponse" }, "DeviceClaim": { - "description": "A record of a device claimed by a reseller for a customer. Devices claimed\nfor zero-touch enrollment have a claim with the type\n`SECTION_TYPE_ZERO_TOUCH`. To learn more, read\n[Claim devices for customers](/zero-touch/guides/how-it-works#claim).", "type": "object", "properties": { "ownerCompanyId": { @@ -1036,8 +1031,6 @@ "type": "string" }, "sectionType": { - "description": "Output only. The type of claim made on the device.", - "type": "string", "enumDescriptions": [ "Unspecified section type.", "Zero-touch enrollment section type." @@ -1045,12 +1038,16 @@ "enum": [ "SECTION_TYPE_UNSPECIFIED", "SECTION_TYPE_ZERO_TOUCH" - ] + ], + "description": "Output only. The type of claim made on the device.", + "type": "string" } }, - "id": "DeviceClaim" + "id": "DeviceClaim", + "description": "A record of a device claimed by a reseller for a customer. Devices claimed\nfor zero-touch enrollment have a claim with the type\n`SECTION_TYPE_ZERO_TOUCH`. To learn more, read\n[Claim devices for customers](/zero-touch/guides/how-it-works#claim)." }, "DevicesLongRunningOperationResponse": { + "description": "Long running operation response.", "type": "object", "properties": { "successCount": { @@ -1066,10 +1063,10 @@ } } }, - "id": "DevicesLongRunningOperationResponse", - "description": "Long running operation response." + "id": "DevicesLongRunningOperationResponse" }, "PerDeviceStatusInBatch": { + "id": "PerDeviceStatusInBatch", "description": "Stores the processing result for each device.", "type": "object", "properties": { @@ -1083,8 +1080,6 @@ "type": "string" }, "status": { - "description": "Process result.", - "type": "string", "enumDescriptions": [ "Invalid code. Shouldn't be used.", "Unknown error.\nWe don't expect this error to occur here.", @@ -1104,17 +1099,53 @@ "SINGLE_DEVICE_STATUS_INVALID_DEVICE_IDENTIFIER", "SINGLE_DEVICE_STATUS_INVALID_SECTION_TYPE", "SINGLE_DEVICE_STATUS_SECTION_NOT_YOURS" - ] + ], + "description": "Process result.", + "type": "string" }, "errorIdentifier": { "description": "Error identifier.", "type": "string" } + } + }, + "FindDevicesByOwnerRequest": { + "description": "Request to find devices by customers.", + "type": "object", + "properties": { + "limit": { + "description": "The number of devices to show in the result.", + "format": "int64", + "type": "string" + }, + "pageToken": { + "type": "string", + "description": "Page token." + }, + "sectionType": { + "description": "The section type.", + "type": "string", + "enumDescriptions": [ + "Unspecified section type.", + "Zero-touch enrollment section type." + ], + "enum": [ + "SECTION_TYPE_UNSPECIFIED", + "SECTION_TYPE_ZERO_TOUCH" + ] + }, + "customerId": { + "description": "List of customer IDs to search for.", + "type": "array", + "items": { + "format": "int64", + "type": "string" + } + } }, - "id": "PerDeviceStatusInBatch" + "id": "FindDevicesByOwnerRequest" }, "ClaimDevicesRequest": { - "id": "ClaimDevicesRequest", "description": "Request to claim devices asynchronously in batch.", "type": "object", "properties": { @@ -1125,60 +1156,34 @@ "$ref": "PartnerClaim" } } - } + }, + "id": "ClaimDevicesRequest" }, - "FindDevicesByOwnerRequest": { - "description": "Request to find devices by customers.", + "DeviceIdentifier": { "type": "object", "properties": { - "pageToken": { - "description": "Page token.", + "meid": { + "description": "The device’s MEID number.", "type": "string" }, - "sectionType": { - "enumDescriptions": [ - "Unspecified section type.", - "Zero-touch enrollment section type." - ], - "enum": [ - "SECTION_TYPE_UNSPECIFIED", - "SECTION_TYPE_ZERO_TOUCH" - ], - "description": "The section type.", - "type": "string" - }, - "customerId": { - "description": "List of customer IDs to search for.", - "type": "array", - "items": { - "type": "string", - "format": "int64" - } - }, - "limit": { + "manufacturer": { "type": "string", - "description": "The number of devices to show in the result.", - "format": "int64" + "description": "Required. The device manufacturer’s name. Matches the device's built-in\nvalue returned from `android.os.Build.MANUFACTURER`. Allowed values are\nlisted in [manufacturer names](/zero-touch/resources/manufacturer-names)." + }, + "serialNumber": { + "description": "The manufacturer's serial number for the device. This value might not be\nunique.", + "type": "string" + }, + "imei": { + "description": "The device’s IMEI number. Validated on input.", + "type": "string" } }, - "id": "FindDevicesByOwnerRequest" + "id": "DeviceIdentifier", + "description": "Encapsulates hardware and product IDs to identify a manufactured device. To\nlearn more, read [Identifiers](/zero-touch/guides/identifiers)." }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", "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.", - "type": "any" - }, - "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.", - "type": "object" - }, "name": { "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", "type": "string" @@ -1194,39 +1199,28 @@ }, "description": "This field will contain a `DevicesLongRunningOperationMetadata` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.", "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": { + "description": "This field will contain a `DevicesLongRunningOperationResponse` object if the operation is created by `claimAsync`, `unclaimAsync`, or `updateMetadataAsync`.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } } }, - "id": "Operation" - }, - "DeviceIdentifier": { - "id": "DeviceIdentifier", - "description": "Encapsulates hardware and product IDs to identify a manufactured device. To\nlearn more, read [Identifiers](/zero-touch/guides/identifiers).", - "type": "object", - "properties": { - "serialNumber": { - "description": "The manufacturer's serial number for the device. This value might not be\nunique.", - "type": "string" - }, - "imei": { - "description": "The device’s IMEI number. Validated on input.", - "type": "string" - }, - "meid": { - "description": "The device’s MEID number.", - "type": "string" - }, - "manufacturer": { - "description": "Required. The device manufacturer’s name. Matches the device's built-in\nvalue returned from `android.os.Build.MANUFACTURER`. Allowed values are\nlisted in [manufacturer names](/zero-touch/resources/manufacturer-names).", - "type": "string" - } - } + "id": "Operation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object" }, "Dpc": { + "description": "An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)).\nZero-touch enrollment installs a DPC (listed in the `Configuration`) on a\ndevice to maintain the customer's mobile policies. All the DPCs listed by the\nAPI support zero-touch enrollment and are available in Google Play.", + "type": "object", "properties": { - "dpcName": { - "description": "Output only. The title of the DPC app in Google Play. For example, _Google\nApps Device Policy_. Useful in an application's user interface.", - "type": "string" - }, "name": { "description": "Output only. The API resource name in the format\n`customers/[CUSTOMER_ID]/dpcs/[DPC_ID]`. Assigned by\nthe server. To maintain a reference to a DPC across customer accounts,\npersist and match the last path component (`DPC_ID`).", "type": "string" @@ -1234,60 +1228,85 @@ "packageName": { "description": "Output only. The DPC's Android application ID that looks like a Java\npackage name. Zero-touch enrollment installs the DPC app onto a device\nusing this identifier.", "type": "string" - } - }, - "id": "Dpc", - "description": "An EMM's DPC ([device policy controller](/android/work/dpc/build-dpc)).\nZero-touch enrollment installs a DPC (listed in the `Configuration`) on a\ndevice to maintain the customer's mobile policies. All the DPCs listed by the\nAPI support zero-touch enrollment and are available in Google Play.", - "type": "object" - }, - "CustomerApplyConfigurationRequest": { - "description": "Request message for customer to assign a configuration to device.", - "type": "object", - "properties": { - "configuration": { - "description": "Required. The configuration applied to the device in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.", - "type": "string" }, - "device": { - "$ref": "DeviceReference", - "description": "Required. The device the configuration is applied to." + "dpcName": { + "description": "Output only. The title of the DPC app in Google Play. For example, _Google\nApps Device Policy_. Useful in an application's user interface.", + "type": "string" } }, - "id": "CustomerApplyConfigurationRequest" + "id": "Dpc" }, "UnclaimDevicesRequest": { "description": "Request to unclaim devices asynchronously in batch.", "type": "object", "properties": { "unclaims": { - "description": "List of devices to unclaim.", "type": "array", "items": { "$ref": "PartnerUnclaim" - } + }, + "description": "List of devices to unclaim." } }, "id": "UnclaimDevicesRequest" }, - "CustomerUnclaimDeviceRequest": { + "CustomerApplyConfigurationRequest": { "type": "object", "properties": { "device": { - "$ref": "DeviceReference", - "description": "Required. The device to unclaim." + "description": "Required. The device the configuration is applied to.", + "$ref": "DeviceReference" + }, + "configuration": { + "description": "Required. The configuration applied to the device in the format\n`customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID]`.", + "type": "string" } }, - "id": "CustomerUnclaimDeviceRequest", - "description": "Request message for customer to unclaim a device." + "id": "CustomerApplyConfigurationRequest", + "description": "Request message for customer to assign a configuration to device." + }, + "CustomerUnclaimDeviceRequest": { + "description": "Request message for customer to unclaim a device.", + "type": "object", + "properties": { + "device": { + "description": "Required. The device to unclaim.", + "$ref": "DeviceReference" + } + }, + "id": "CustomerUnclaimDeviceRequest" + }, + "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.", + "type": "object", + "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" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "type": "any", + "description": "Properties of the object. Contains field @type with type URL." + }, + "type": "object" + } + } + }, + "id": "Status" }, "FindDevicesByDeviceIdentifierRequest": { "description": "Request to find devices.", "type": "object", "properties": { - "pageToken": { - "description": "Page token.", - "type": "string" - }, "limit": { "description": "Number of devices to show.", "format": "int64", @@ -1296,41 +1315,20 @@ "deviceIdentifier": { "$ref": "DeviceIdentifier", "description": "The device identifier to search." + }, + "pageToken": { + "description": "Page token.", + "type": "string" } }, "id": "FindDevicesByDeviceIdentifierRequest" }, - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - }, - "message": { - "type": "string", - "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." - } - }, - "id": "Status" - }, "OperationPerDevice": { - "description": "Operation the server received for every device.", - "type": "object", "properties": { + "claim": { + "$ref": "PartnerClaim", + "description": "Request to claim a device." + }, "updateMetadata": { "$ref": "UpdateMetadataArguments", "description": "Request to set metadata for a device." @@ -1340,19 +1338,15 @@ "description": "Request to unclaim a device." }, "result": { - "description": "Processing result for every device.", - "$ref": "PerDeviceStatusInBatch" - }, - "claim": { - "description": "Request to claim a device.", - "$ref": "PartnerClaim" + "$ref": "PerDeviceStatusInBatch", + "description": "Processing result for every device." } }, - "id": "OperationPerDevice" + "id": "OperationPerDevice", + "description": "Operation the server received for every device.", + "type": "object" }, "CustomerListConfigurationsResponse": { - "description": "Response message of customer's listing configuration.", - "type": "object", "properties": { "configurations": { "description": "The configurations.", @@ -1362,25 +1356,27 @@ } } }, - "id": "CustomerListConfigurationsResponse" + "id": "CustomerListConfigurationsResponse", + "description": "Response message of customer's listing configuration.", + "type": "object" }, "FindDevicesByOwnerResponse": { + "type": "object", "properties": { - "nextPageToken": { - "description": "Page token of the next page.", - "type": "string" - }, "devices": { "description": "Devices found.", "type": "array", "items": { "$ref": "Device" } + }, + "nextPageToken": { + "description": "Page token of the next page.", + "type": "string" } }, "id": "FindDevicesByOwnerResponse", - "description": "Response containing found devices.", - "type": "object" + "description": "Response containing found devices." }, "CustomerRemoveConfigurationRequest": { "description": "Request message for customer to remove the configuration from device.", @@ -1397,17 +1393,9 @@ "description": "Long running operation metadata.", "type": "object", "properties": { - "progress": { - "description": "Processing progress from 0 to 100.", - "format": "int32", - "type": "integer" - }, - "devicesCount": { - "description": "Number of devices parsed in your requests.", - "format": "int32", - "type": "integer" - }, "processingStatus": { + "description": "The overall processing status.", + "type": "string", "enumDescriptions": [ "Invalid code. Shouldn't be used.", "Pending.", @@ -1419,15 +1407,22 @@ "BATCH_PROCESS_PENDING", "BATCH_PROCESS_IN_PROGRESS", "BATCH_PROCESS_PROCESSED" - ], - "description": "The overall processing status.", - "type": "string" + ] + }, + "progress": { + "description": "Processing progress from 0 to 100.", + "format": "int32", + "type": "integer" + }, + "devicesCount": { + "description": "Number of devices parsed in your requests.", + "format": "int32", + "type": "integer" } }, "id": "DevicesLongRunningOperationMetadata" }, "ClaimDeviceRequest": { - "id": "ClaimDeviceRequest", "description": "Request message to claim a device on behalf of a customer.", "type": "object", "properties": { @@ -1436,15 +1431,15 @@ "description": "The device identifier of the device to claim." }, "sectionType": { + "enum": [ + "SECTION_TYPE_UNSPECIFIED", + "SECTION_TYPE_ZERO_TOUCH" + ], "description": "The section to claim.", "type": "string", "enumDescriptions": [ "Unspecified section type.", "Zero-touch enrollment section type." - ], - "enum": [ - "SECTION_TYPE_UNSPECIFIED", - "SECTION_TYPE_ZERO_TOUCH" ] }, "customerId": { @@ -1452,10 +1447,10 @@ "format": "int64", "type": "string" } - } + }, + "id": "ClaimDeviceRequest" }, "UpdateDeviceMetadataInBatchRequest": { - "description": "Request to update device metadata in batch.", "type": "object", "properties": { "updates": { @@ -1466,7 +1461,44 @@ } } }, - "id": "UpdateDeviceMetadataInBatchRequest" + "id": "UpdateDeviceMetadataInBatchRequest", + "description": "Request to update device metadata in batch." + }, + "UpdateMetadataArguments": { + "description": "Identifies metdata updates to one device.", + "type": "object", + "properties": { + "deviceId": { + "description": "Device ID of the device.", + "format": "int64", + "type": "string" + }, + "deviceIdentifier": { + "$ref": "DeviceIdentifier", + "description": "Device identifier." + }, + "deviceMetadata": { + "$ref": "DeviceMetadata", + "description": "The metadata to update." + } + }, + "id": "UpdateMetadataArguments" + }, + "ClaimDeviceResponse": { + "description": "Response message containing device id of the claim.", + "type": "object", + "properties": { + "deviceName": { + "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.", + "type": "string" + }, + "deviceId": { + "description": "The device ID of the claimed device.", + "format": "int64", + "type": "string" + } + }, + "id": "ClaimDeviceResponse" }, "ListCustomersResponse": { "description": "Response message of all customers related to this partner.", @@ -1482,54 +1514,18 @@ }, "id": "ListCustomersResponse" }, - "ClaimDeviceResponse": { - "description": "Response message containing device id of the claim.", - "type": "object", - "properties": { - "deviceId": { - "description": "The device ID of the claimed device.", - "format": "int64", - "type": "string" - }, - "deviceName": { - "description": "The resource name of the device in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`.", - "type": "string" - } - }, - "id": "ClaimDeviceResponse" - }, - "UpdateMetadataArguments": { - "description": "Identifies metdata updates to one device.", - "type": "object", - "properties": { - "deviceIdentifier": { - "description": "Device identifier.", - "$ref": "DeviceIdentifier" - }, - "deviceMetadata": { - "$ref": "DeviceMetadata", - "description": "The metadata to update." - }, - "deviceId": { - "type": "string", - "description": "Device ID of the device.", - "format": "int64" - } - }, - "id": "UpdateMetadataArguments" - }, "DeviceReference": { "description": "A `DeviceReference` is an API abstraction that lets you supply a _device_\nargument to a method using one of the following identifier types:\n\n* A numeric API resource ID.\n* Real-world hardware IDs, such as IMEI number, belonging to the manufactured\n device.\n\nMethods that operate on devices take a `DeviceReference` as a parameter type\nbecause it's more flexible for the caller. To learn more about device\nidentifiers, read [Identifiers](/zero-touch/guides/identifiers).", "type": "object", "properties": { + "deviceIdentifier": { + "$ref": "DeviceIdentifier", + "description": "The hardware IDs of the device." + }, "deviceId": { "description": "The ID of the device.", "format": "int64", "type": "string" - }, - "deviceIdentifier": { - "description": "The hardware IDs of the device.", - "$ref": "DeviceIdentifier" } }, "id": "DeviceReference" @@ -1538,18 +1534,6 @@ "description": "An Android device registered for zero-touch enrollment.", "type": "object", "properties": { - "deviceIdentifier": { - "$ref": "DeviceIdentifier", - "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers)." - }, - "deviceMetadata": { - "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata).", - "$ref": "DeviceMetadata" - }, - "name": { - "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server.", - "type": "string" - }, "deviceId": { "description": "Output only. The ID of the device. Assigned by the server.", "format": "int64", @@ -1565,6 +1549,18 @@ "items": { "$ref": "DeviceClaim" } + }, + "deviceIdentifier": { + "$ref": "DeviceIdentifier", + "description": "The hardware IDs that identify a manufactured device. To learn more, read\n[Identifiers](/zero-touch/guides/identifiers)." + }, + "deviceMetadata": { + "$ref": "DeviceMetadata", + "description": "The metadata attached to the device. Structured as key-value pairs. To\nlearn more, read [Device metadata](/zero-touch/guides/metadata)." + }, + "name": { + "type": "string", + "description": "Output only. The API resource name in the format\n`partners/[PARTNER_ID]/devices/[DEVICE_ID]`. Assigned by the server." } }, "id": "Device" @@ -1577,5 +1573,9 @@ }, "version": "v1", "baseUrl": "https://androiddeviceprovisioning.googleapis.com/", - "canonicalName": "Android Provisioning Partner" + "canonicalName": "Android Provisioning Partner", + "kind": "discovery#restDescription", + "description": "Automates reseller integration into zero-touch enrollment by assigning devices to customers and creating device reports.", + "servicePath": "", + "rootUrl": "https://androiddeviceprovisioning.googleapis.com/" }
diff --git a/api-list.json b/api-list.json index 4b797ad..180838c 100644 --- a/api-list.json +++ b/api-list.json
@@ -2323,8 +2323,8 @@ "id": "runtimeconfig:v1", "name": "runtimeconfig", "version": "v1", - "title": "Google Cloud RuntimeConfig API", - "description": "Provides capabilities for dynamic configuration and coordination for applications running on Google Cloud Platform.", + "title": "Google Cloud Runtime Configuration API", + "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", "discoveryRestUrl": "https://runtimeconfig.googleapis.com/$discovery/rest?version=v1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png", @@ -2338,8 +2338,8 @@ "id": "runtimeconfig:v1beta1", "name": "runtimeconfig", "version": "v1beta1", - "title": "Google Cloud RuntimeConfig API", - "description": "Provides capabilities for dynamic configuration and coordination for applications running on Google Cloud Platform.", + "title": "Google Cloud Runtime Configuration API", + "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", "discoveryRestUrl": "https://runtimeconfig.googleapis.com/$discovery/rest?version=v1beta1", "icons": { "x16": "https://www.gstatic.com/images/branding/product/1x/googleg_16dp.png",
diff --git a/appengine/v1/appengine-api.json b/appengine/v1/appengine-api.json index 3d9d6b4..be6ce56 100644 --- a/appengine/v1/appengine-api.json +++ b/appengine/v1/appengine-api.json
@@ -1,30 +1,261 @@ { - "discoveryVersion": "v1", - "ownerName": "Google", "version_module": true, "resources": { "apps": { "resources": { - "domainMappings": { + "locations": { "methods": { - "delete": { - "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", + "list": { + "httpMethod": "GET", "response": { - "$ref": "Operation" + "$ref": "ListLocationsResponse" }, "parameterOrder": [ - "appsId", - "domainMappingsId" + "appsId" ], - "httpMethod": "DELETE", "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, "appsId": { - "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", + "description": "Part of `name`. The resource that owns the locations collection, if applicable.", "required": true, "type": "string", "location": "path" }, - "domainMappingsId": { + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/locations", + "id": "appengine.apps.locations.list", + "path": "v1/apps/{appsId}/locations", + "description": "Lists information about the supported locations for this service." + }, + "get": { + "id": "appengine.apps.locations.get", + "path": "v1/apps/{appsId}/locations/{locationsId}", + "description": "Get information about a location.", + "httpMethod": "GET", + "parameterOrder": [ + "appsId", + "locationsId" + ], + "response": { + "$ref": "Location" + }, + "parameters": { + "appsId": { + "description": "Part of `name`. Resource name for the location.", + "required": true, + "type": "string", + "location": "path" + }, + "locationsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/locations/{locationsId}" + } + } + }, + "authorizedCertificates": { + "methods": { + "list": { + "flatPath": "v1/apps/{appsId}/authorizedCertificates", + "path": "v1/apps/{appsId}/authorizedCertificates", + "id": "appengine.apps.authorizedCertificates.list", + "description": "Lists all SSL certificates the user is authorized to administer.", + "response": { + "$ref": "ListAuthorizedCertificatesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer" + }, + "view": { + "enum": [ + "BASIC_CERTIFICATE", + "FULL_CERTIFICATE" + ], + "description": "Controls the set of fields returned in the LIST response.", + "type": "string", + "location": "query" + } + } + }, + "get": { + "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "id": "appengine.apps.authorizedCertificates.get", + "description": "Gets the specified SSL certificate.", + "response": { + "$ref": "AuthorizedCertificate" + }, + "parameterOrder": [ + "appsId", + "authorizedCertificatesId" + ], + "httpMethod": "GET", + "parameters": { + "view": { + "description": "Controls the set of fields returned in the GET response.", + "type": "string", + "location": "query", + "enum": [ + "BASIC_CERTIFICATE", + "FULL_CERTIFICATE" + ] + }, + "authorizedCertificatesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "patch": { + "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", + "request": { + "$ref": "AuthorizedCertificate" + }, + "response": { + "$ref": "AuthorizedCertificate" + }, + "parameterOrder": [ + "appsId", + "authorizedCertificatesId" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", + "required": true, + "type": "string", + "location": "path" + }, + "authorizedCertificatesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "updateMask": { + "location": "query", + "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", + "format": "google-fieldmask", + "type": "string" + } + }, + "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "id": "appengine.apps.authorizedCertificates.patch" + }, + "create": { + "response": { + "$ref": "AuthorizedCertificate" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/authorizedCertificates", + "path": "v1/apps/{appsId}/authorizedCertificates", + "id": "appengine.apps.authorizedCertificates.create", + "request": { + "$ref": "AuthorizedCertificate" + }, + "description": "Uploads the specified SSL certificate." + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "appsId", + "authorizedCertificatesId" + ], + "httpMethod": "DELETE", + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", + "required": true, + "type": "string" + }, + "authorizedCertificatesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, @@ -34,13 +265,593 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", - "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", - "id": "appengine.apps.domainMappings.delete" + "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "id": "appengine.apps.authorizedCertificates.delete", + "description": "Deletes the specified SSL certificate." + } + } + }, + "services": { + "methods": { + "delete": { + "description": "Deletes the specified service and all enclosed versions.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "DELETE", + "parameters": { + "servicesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}", + "path": "v1/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.delete" }, "list": { + "httpMethod": "GET", "response": { - "$ref": "ListDomainMappingsResponse" + "$ref": "ListServicesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/services", + "id": "appengine.apps.services.list", + "path": "v1/apps/{appsId}/services", + "description": "Lists all the services in the application." + }, + "get": { + "response": { + "$ref": "Service" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "GET", + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "required": true, + "type": "string", + "location": "path" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}", + "path": "v1/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.get", + "description": "Gets the current configuration of the specified service." + }, + "patch": { + "httpMethod": "PATCH", + "parameterOrder": [ + "appsId", + "servicesId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", + "required": true, + "type": "string", + "location": "path" + }, + "migrateTraffic": { + "location": "query", + "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", + "type": "boolean" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.patch", + "path": "v1/apps/{appsId}/services/{servicesId}", + "request": { + "$ref": "Service" + }, + "description": "Updates the configuration of the specified service." + } + }, + "resources": { + "versions": { + "methods": { + "list": { + "response": { + "$ref": "ListVersionsResponse" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "GET", + "parameters": { + "servicesId": { + "description": "Part of `parent`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "view": { + "description": "Controls the set of fields returned in the List response.", + "type": "string", + "location": "query", + "enum": [ + "BASIC", + "FULL" + ] + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions", + "path": "v1/apps/{appsId}/services/{servicesId}/versions", + "id": "appengine.apps.services.versions.list", + "description": "Lists the versions of a service." + }, + "get": { + "id": "appengine.apps.services.versions.get", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", + "httpMethod": "GET", + "response": { + "$ref": "Version" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "parameters": { + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", + "required": true, + "type": "string" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "view": { + "enum": [ + "BASIC", + "FULL" + ], + "description": "Controls the set of fields returned in the Get response.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}" + }, + "patch": { + "request": { + "$ref": "Version" + }, + "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "httpMethod": "PATCH", + "parameters": { + "updateMask": { + "location": "query", + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", + "required": true, + "type": "string", + "location": "path" + }, + "versionsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "id": "appengine.apps.services.versions.patch" + }, + "create": { + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions", + "path": "v1/apps/{appsId}/services/{servicesId}/versions", + "id": "appengine.apps.services.versions.create", + "request": { + "$ref": "Version" + }, + "description": "Deploys code and resource files to a new version.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "POST", + "parameters": { + "servicesId": { + "location": "path", + "description": "Part of `parent`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "description": "Deletes an existing Version resource.", + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "parameters": { + "servicesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", + "required": true, + "type": "string", + "location": "path" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "id": "appengine.apps.services.versions.delete", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}" + } + }, + "resources": { + "instances": { + "methods": { + "delete": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId", + "instancesId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "versionsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "servicesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", + "required": true, + "type": "string" + }, + "instancesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "id": "appengine.apps.services.versions.instances.delete", + "description": "Stops a running instance." + }, + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListInstancesResponse" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "versionsId": { + "description": "Part of `parent`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "servicesId": { + "location": "path", + "description": "Part of `parent`. See documentation of `appsId`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", + "id": "appengine.apps.services.versions.instances.list", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", + "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)." + }, + "get": { + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "id": "appengine.apps.services.versions.instances.get", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "description": "Gets instance information.", + "httpMethod": "GET", + "response": { + "$ref": "Instance" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId", + "instancesId" + ], + "parameters": { + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", + "required": true, + "type": "string", + "location": "path" + }, + "instancesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "debug": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId", + "instancesId" + ], + "httpMethod": "POST", + "parameters": { + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", + "required": true, + "type": "string" + }, + "instancesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", + "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", + "id": "appengine.apps.services.versions.instances.debug", + "request": { + "$ref": "DebugInstanceRequest" + }, + "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment." + } + } + } + } + } + } + }, + "authorizedDomains": { + "methods": { + "list": { + "description": "Lists all domains the user is authorized to administer.", + "response": { + "$ref": "ListAuthorizedDomainsResponse" }, "parameterOrder": [ "appsId" @@ -48,10 +859,200 @@ "httpMethod": "GET", "parameters": { "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/authorizedDomains", + "path": "v1/apps/{appsId}/authorizedDomains", + "id": "appengine.apps.authorizedDomains.list" + } + } + }, + "operations": { + "methods": { + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "appsId" + ], + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. The name of the operation's parent resource.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/operations", + "id": "appengine.apps.operations.list", + "path": "v1/apps/{appsId}/operations", + "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "appsId", + "operationsId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "operationsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "description": "Part of `name`. The name of the operation resource.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/apps/{appsId}/operations/{operationsId}", + "id": "appengine.apps.operations.get", + "path": "v1/apps/{appsId}/operations/{operationsId}", + "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." + } + } + }, + "domainMappings": { + "methods": { + "create": { + "path": "v1/apps/{appsId}/domainMappings", + "id": "appengine.apps.domainMappings.create", + "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.", + "request": { + "$ref": "DomainMapping" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "overrideStrategy": { + "enum": [ + "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY", + "STRICT", + "OVERRIDE" + ], + "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.", + "type": "string", + "location": "query" + }, + "appsId": { "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", "required": true, "type": "string", "location": "path" + } + }, + "flatPath": "v1/apps/{appsId}/domainMappings" + }, + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "domainMappingsId" + ], + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", + "required": true, + "type": "string" + }, + "domainMappingsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.delete", + "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", + "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource." + }, + "list": { + "id": "appengine.apps.domainMappings.list", + "path": "v1/apps/{appsId}/domainMappings", + "description": "Lists the domain mappings on an application.", + "httpMethod": "GET", + "response": { + "$ref": "ListDomainMappingsResponse" + }, + "parameterOrder": [ + "appsId" + ], + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string" }, "pageToken": { "location": "query", @@ -70,14 +1071,9 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1/apps/{appsId}/domainMappings", - "path": "v1/apps/{appsId}/domainMappings", - "id": "appengine.apps.domainMappings.list", - "description": "Lists the domain mappings on an application." + "flatPath": "v1/apps/{appsId}/domainMappings" }, "get": { - "id": "appengine.apps.domainMappings.get", - "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", "description": "Gets the specified domain mapping.", "httpMethod": "GET", "response": { @@ -88,17 +1084,17 @@ "domainMappingsId" ], "parameters": { - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", "required": true, - "type": "string", - "location": "path" + "type": "string" + }, + "domainMappingsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" } }, "scopes": [ @@ -106,9 +1102,17 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}" + "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.get", + "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}" }, "patch": { + "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.patch", + "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", + "request": { + "$ref": "DomainMapping" + }, "response": { "$ref": "Operation" }, @@ -140,50 +1144,7 @@ "location": "path" } }, - "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", - "path": "v1/apps/{appsId}/domainMappings/{domainMappingsId}", - "id": "appengine.apps.domainMappings.patch", - "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", - "request": { - "$ref": "DomainMapping" - } - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "POST", - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "overrideStrategy": { - "enum": [ - "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY", - "STRICT", - "OVERRIDE" - ], - "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/domainMappings", - "path": "v1/apps/{appsId}/domainMappings", - "id": "appengine.apps.domainMappings.create", - "request": { - "$ref": "DomainMapping" - }, - "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains." + "flatPath": "v1/apps/{appsId}/domainMappings/{domainMappingsId}" } } }, @@ -191,175 +1152,6 @@ "resources": { "ingressRules": { "methods": { - "list": { - "response": { - "$ref": "ListIngressRulesResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "matchingAddress": { - "location": "query", - "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.", - "type": "string" - }, - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/firewall/ingressRules", - "path": "v1/apps/{appsId}/firewall/ingressRules", - "id": "appengine.apps.firewall.ingressRules.list", - "description": "Lists the firewall rules of an application." - }, - "create": { - "flatPath": "v1/apps/{appsId}/firewall/ingressRules", - "id": "appengine.apps.firewall.ingressRules.create", - "path": "v1/apps/{appsId}/firewall/ingressRules", - "request": { - "$ref": "FirewallRule" - }, - "description": "Creates a firewall rule for the application.", - "httpMethod": "POST", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "FirewallRule" - }, - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "response": { - "$ref": "FirewallRule" - }, - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.", - "required": true, - "type": "string", - "location": "path" - }, - "ingressRulesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "id": "appengine.apps.firewall.ingressRules.get", - "description": "Gets the specified firewall rule." - }, - "patch": { - "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "id": "appengine.apps.firewall.ingressRules.patch", - "request": { - "$ref": "FirewallRule" - }, - "description": "Updates the specified firewall rule.", - "response": { - "$ref": "FirewallRule" - }, - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.", - "required": true, - "type": "string", - "location": "path" - }, - "ingressRulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}" - }, - "batchUpdate": { - "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate", - "id": "appengine.apps.firewall.ingressRules.batchUpdate", - "request": { - "$ref": "BatchUpdateIngressRulesRequest" - }, - "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.", - "response": { - "$ref": "BatchUpdateIngressRulesResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "POST", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate" - }, "delete": { "response": { "$ref": "Empty" @@ -374,10 +1166,10 @@ ], "parameters": { "appsId": { + "location": "path", "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "ingressRulesId": { "location": "path", @@ -390,412 +1182,98 @@ "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", "id": "appengine.apps.firewall.ingressRules.delete", "description": "Deletes the specified firewall rule." - } - } - } - } - }, - "locations": { - "methods": { - "list": { - "response": { - "$ref": "ListLocationsResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" }, - "appsId": { - "description": "Part of `name`. The resource that owns the locations collection, if applicable.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/locations", - "path": "v1/apps/{appsId}/locations", - "id": "appengine.apps.locations.list", - "description": "Lists information about the supported locations for this service." - }, - "get": { - "response": { - "$ref": "Location" - }, - "parameterOrder": [ - "appsId", - "locationsId" - ], - "httpMethod": "GET", - "parameters": { - "locationsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "description": "Part of `name`. Resource name for the location.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/locations/{locationsId}", - "path": "v1/apps/{appsId}/locations/{locationsId}", - "id": "appengine.apps.locations.get", - "description": "Get information about a location." - } - } - }, - "authorizedCertificates": { - "methods": { - "delete": { - "description": "Deletes the specified SSL certificate.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", - "required": true, - "type": "string" - }, - "authorizedCertificatesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.delete" - }, - "list": { - "description": "Lists all SSL certificates the user is authorized to administer.", - "response": { - "$ref": "ListAuthorizedCertificatesResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - }, - "view": { - "description": "Controls the set of fields returned in the LIST response.", - "type": "string", - "location": "query", - "enum": [ - "BASIC_CERTIFICATE", - "FULL_CERTIFICATE" - ] - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/authorizedCertificates", - "path": "v1/apps/{appsId}/authorizedCertificates", - "id": "appengine.apps.authorizedCertificates.list" - }, - "get": { - "response": { - "$ref": "AuthorizedCertificate" - }, - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", - "required": true, - "type": "string" - }, - "view": { - "description": "Controls the set of fields returned in the GET response.", - "type": "string", - "location": "query", - "enum": [ - "BASIC_CERTIFICATE", - "FULL_CERTIFICATE" - ] - }, - "authorizedCertificatesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.get", - "description": "Gets the specified SSL certificate." - }, - "patch": { - "response": { - "$ref": "AuthorizedCertificate" - }, - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", - "required": true, - "type": "string", - "location": "path" - }, - "authorizedCertificatesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.patch", - "request": { - "$ref": "AuthorizedCertificate" - }, - "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated." - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "AuthorizedCertificate" - }, - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/authorizedCertificates", - "id": "appengine.apps.authorizedCertificates.create", - "path": "v1/apps/{appsId}/authorizedCertificates", - "request": { - "$ref": "AuthorizedCertificate" - }, - "description": "Uploads the specified SSL certificate." - } - } - }, - "services": { - "resources": { - "versions": { - "methods": { - "delete": { - "description": "Deletes an existing Version resource.", + "list": { + "path": "v1/apps/{appsId}/firewall/ingressRules", + "id": "appengine.apps.firewall.ingressRules.list", + "description": "Lists the firewall rules of an application.", "response": { - "$ref": "Operation" + "$ref": "ListIngressRulesResponse" }, "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" + "appsId" ], - "httpMethod": "DELETE", + "httpMethod": "GET", "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", + "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.", "required": true, "type": "string", "location": "path" }, - "versionsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "id": "appengine.apps.services.versions.delete" - }, - "list": { - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions", - "id": "appengine.apps.services.versions.list", - "path": "v1/apps/{appsId}/services/{servicesId}/versions", - "description": "Lists the versions of a service.", - "httpMethod": "GET", - "response": { - "$ref": "ListVersionsResponse" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "parameters": { + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string", + "location": "query" + }, "pageSize": { "description": "Maximum results to return per page.", "format": "int32", "type": "integer", "location": "query" }, - "view": { - "description": "Controls the set of fields returned in the List response.", - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "FULL" - ] - }, - "servicesId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", + "matchingAddress": { + "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.", "type": "string", "location": "query" } }, + "flatPath": "v1/apps/{appsId}/firewall/ingressRules" + }, + "create": { + "path": "v1/apps/{appsId}/firewall/ingressRules", + "id": "appengine.apps.firewall.ingressRules.create", + "request": { + "$ref": "FirewallRule" + }, + "description": "Creates a firewall rule for the application.", + "response": { + "$ref": "FirewallRule" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.", + "required": true, + "type": "string", + "location": "path" + } + }, "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/apps/{appsId}/firewall/ingressRules" }, "get": { - "httpMethod": "GET", + "description": "Gets the specified firewall rule.", "response": { - "$ref": "Version" + "$ref": "FirewallRule" }, "parameterOrder": [ "appsId", - "servicesId", - "versionsId" + "ingressRulesId" ], + "httpMethod": "GET", "parameters": { - "servicesId": { + "ingressRulesId": { + "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", + "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.", "required": true, "type": "string", "location": "path" - }, - "view": { - "location": "query", - "enum": [ - "BASIC", - "FULL" - ], - "description": "Controls the set of fields returned in the Get response.", - "type": "string" } }, "scopes": [ @@ -803,26 +1281,31 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "id": "appengine.apps.services.versions.get", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource." + "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "id": "appengine.apps.firewall.ingressRules.get" }, "patch": { + "flatPath": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "path": "v1/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "id": "appengine.apps.firewall.ingressRules.patch", + "description": "Updates the specified firewall rule.", + "request": { + "$ref": "FirewallRule" + }, "response": { - "$ref": "Operation" + "$ref": "FirewallRule" }, "parameterOrder": [ "appsId", - "servicesId", - "versionsId" + "ingressRulesId" ], "httpMethod": "PATCH", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "versionsId": { + "ingressRulesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, @@ -834,567 +1317,59 @@ "type": "string", "location": "query" }, - "servicesId": { + "appsId": { "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", + "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.", "required": true, "type": "string" - }, - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", - "required": true, - "type": "string", - "location": "path" } - }, - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "id": "appengine.apps.services.versions.patch", - "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.", - "request": { - "$ref": "Version" } }, - "create": { - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions", - "path": "v1/apps/{appsId}/services/{servicesId}/versions", - "id": "appengine.apps.services.versions.create", - "description": "Deploys code and resource files to a new version.", + "batchUpdate": { "request": { - "$ref": "Version" + "$ref": "BatchUpdateIngressRulesRequest" }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], + "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list.", "httpMethod": "POST", + "parameterOrder": [ + "appsId" + ], + "response": { + "$ref": "BatchUpdateIngressRulesResponse" + }, + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "parameters": { - "servicesId": { - "location": "path", - "description": "Part of `parent`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - } - } - } - }, - "resources": { - "instances": { - "methods": { - "delete": { - "description": "Stops a running instance.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId", - "instancesId" - ], - "httpMethod": "DELETE", - "parameters": { - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "required": true, - "type": "string" - }, - "instancesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "versionsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "id": "appengine.apps.services.versions.instances.delete" - }, - "list": { - "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", - "response": { - "$ref": "ListInstancesResponse" - }, - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "servicesId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "versionsId": { - "location": "path", - "description": "Part of `parent`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", - "id": "appengine.apps.services.versions.instances.list" - }, - "get": { - "response": { - "$ref": "Instance" - }, - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId", - "instancesId" - ], - "httpMethod": "GET", - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "required": true, - "type": "string", - "location": "path" - }, - "instancesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "versionsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "id": "appengine.apps.services.versions.instances.get", - "description": "Gets instance information." - }, - "debug": { - "httpMethod": "POST", - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId", - "instancesId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", - "required": true, - "type": "string", - "location": "path" - }, - "instancesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", - "id": "appengine.apps.services.versions.instances.debug", - "path": "v1/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", - "request": { - "$ref": "DebugInstanceRequest" - }, - "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment." - } - } + "flatPath": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate", + "id": "appengine.apps.firewall.ingressRules.batchUpdate", + "path": "v1/apps/{appsId}/firewall/ingressRules:batchUpdate" } } } - }, - "methods": { - "delete": { - "flatPath": "v1/apps/{appsId}/services/{servicesId}", - "path": "v1/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.delete", - "description": "Deletes the specified service and all enclosed versions.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "DELETE", - "parameters": { - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "flatPath": "v1/apps/{appsId}/services", - "path": "v1/apps/{appsId}/services", - "id": "appengine.apps.services.list", - "description": "Lists all the services in the application.", - "response": { - "$ref": "ListServicesResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - } - } - }, - "get": { - "description": "Gets the current configuration of the specified service.", - "response": { - "$ref": "Service" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "required": true, - "type": "string", - "location": "path" - }, - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/apps/{appsId}/services/{servicesId}", - "path": "v1/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.get" - }, - "patch": { - "flatPath": "v1/apps/{appsId}/services/{servicesId}", - "path": "v1/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.patch", - "request": { - "$ref": "Service" - }, - "description": "Updates the configuration of the specified service.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "location": "query", - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string" - }, - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - }, - "migrateTraffic": { - "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", - "type": "boolean", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "authorizedDomains": { - "methods": { - "list": { - "description": "Lists all domains the user is authorized to administer.", - "httpMethod": "GET", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "ListAuthorizedDomainsResponse" - }, - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/authorizedDomains", - "id": "appengine.apps.authorizedDomains.list", - "path": "v1/apps/{appsId}/authorizedDomains" - } - } - }, - "operations": { - "methods": { - "list": { - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. The name of the operation's parent resource.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}/operations", - "path": "v1/apps/{appsId}/operations", - "id": "appengine.apps.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." - }, - "get": { - "path": "v1/apps/{appsId}/operations/{operationsId}", - "id": "appengine.apps.operations.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.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "operationsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. The name of the operation resource.", - "required": true, - "type": "string" - }, - "operationsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/apps/{appsId}/operations/{operationsId}" - } } } }, "methods": { - "repair": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the application to repair. Example: apps/myapp", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/apps/{appsId}:repair", - "path": "v1/apps/{appsId}:repair", - "id": "appengine.apps.repair", - "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.", - "request": { - "$ref": "RepairApplicationRequest" - } - }, "get": { - "httpMethod": "GET", + "flatPath": "v1/apps/{appsId}", + "path": "v1/apps/{appsId}", + "id": "appengine.apps.get", + "description": "Gets information about an application.", "response": { "$ref": "Application" }, "parameterOrder": [ "appsId" ], + "httpMethod": "GET", "parameters": { "appsId": { "location": "path", @@ -1407,20 +1382,23 @@ "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/apps/{appsId}", - "id": "appengine.apps.get", - "path": "v1/apps/{appsId}", - "description": "Gets information about an application." + ] }, "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "appsId" - ], + "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.", + "request": { + "$ref": "Application" + }, "response": { "$ref": "Operation" }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "appsId": { "location": "path", @@ -1435,18 +1413,15 @@ "location": "query" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "flatPath": "v1/apps/{appsId}", - "id": "appengine.apps.patch", "path": "v1/apps/{appsId}", + "id": "appengine.apps.patch" + }, + "create": { "request": { "$ref": "Application" }, - "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application." - }, - "create": { + "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).", "response": { "$ref": "Operation" }, @@ -1458,23 +1433,57 @@ ], "flatPath": "v1/apps", "path": "v1/apps", - "id": "appengine.apps.create", - "request": { - "$ref": "Application" + "id": "appengine.apps.create" + }, + "repair": { + "response": { + "$ref": "Operation" }, - "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)." + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the application to repair. Example: apps/myapp", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/apps/{appsId}:repair", + "path": "v1/apps/{appsId}:repair", + "id": "appengine.apps.repair", + "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.", + "request": { + "$ref": "RepairApplicationRequest" + } } } } }, "parameters": { - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, @@ -1497,6 +1506,12 @@ "type": "string" }, "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -1504,13 +1519,7 @@ ], "location": "query", "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" + "default": "json" }, "key": { "location": "query", @@ -1528,460 +1537,43 @@ "location": "query" }, "pp": { - "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" }, "bearer_token": { - "location": "query", "description": "OAuth bearer token.", - "type": "string" + "type": "string", + "location": "query" }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" } }, "schemas": { - "ListInstancesResponse": { - "description": "Response message for Instances.ListInstances.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "instances": { - "description": "The instances belonging to the requested version.", - "type": "array", - "items": { - "$ref": "Instance" - } - } - }, - "id": "ListInstancesResponse" - }, - "ListDomainMappingsResponse": { - "properties": { - "domainMappings": { - "description": "The domain mappings for the application.", - "type": "array", - "items": { - "$ref": "DomainMapping" - } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "id": "ListDomainMappingsResponse", - "description": "Response message for DomainMappings.ListDomainMappings.", - "type": "object" - }, - "OperationMetadataV1Alpha": { - "properties": { - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Alpha" - }, - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - } - }, - "id": "OperationMetadataV1Alpha", - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object" - }, - "UrlDispatchRule": { - "description": "Rules to match an HTTP request and dispatch that request to a service.", - "type": "object", - "properties": { - "domain": { - "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", - "type": "string" - }, - "service": { - "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.", - "type": "string" - }, - "path": { - "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.", - "type": "string" - } - }, - "id": "UrlDispatchRule" - }, - "ListVersionsResponse": { - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "versions": { - "description": "The versions belonging to the requested service.", - "type": "array", - "items": { - "$ref": "Version" - } - } - }, - "id": "ListVersionsResponse", - "description": "Response message for Versions.ListVersions.", - "type": "object" - }, - "ListAuthorizedDomainsResponse": { - "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "domains": { - "description": "The authorized domains belonging to the user.", - "type": "array", - "items": { - "$ref": "AuthorizedDomain" - } - } - }, - "id": "ListAuthorizedDomainsResponse" - }, - "DomainMapping": { - "description": "A domain serving an App Engine application.", - "type": "object", - "properties": { - "name": { - "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", - "type": "string" - }, - "sslSettings": { - "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.", - "$ref": "SslSettings" - }, - "id": { - "description": "Relative name of the domain serving the application. Example: example.com.", - "type": "string" - }, - "resourceRecords": { - "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly", - "type": "array", - "items": { - "$ref": "ResourceRecord" - } - } - }, - "id": "DomainMapping" - }, - "ApiEndpointHandler": { - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "id": "ApiEndpointHandler", - "description": "Uses Google Cloud Endpoints to handle requests.", - "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "AutomaticScaling": { - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", - "type": "object", - "properties": { - "minPendingLatency": { - "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "requestUtilization": { - "$ref": "RequestUtilization", - "description": "Target scaling by request utilization." - }, - "maxIdleInstances": { - "description": "Maximum number of idle instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "standardSchedulerSettings": { - "$ref": "StandardSchedulerSettings", - "description": "Scheduler settings for standard environment." - }, - "minIdleInstances": { - "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.", - "format": "int32", - "type": "integer" - }, - "maxTotalInstances": { - "description": "Maximum number of instances that should be started to handle requests.", - "format": "int32", - "type": "integer" - }, - "minTotalInstances": { - "description": "Minimum number of instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "networkUtilization": { - "$ref": "NetworkUtilization", - "description": "Target scaling by network usage." - }, - "maxConcurrentRequests": { - "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", - "format": "int32", - "type": "integer" - }, - "coolDownPeriod": { - "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.", - "format": "google-duration", - "type": "string" - }, - "maxPendingLatency": { - "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "cpuUtilization": { - "description": "Target scaling by CPU usage.", - "$ref": "CpuUtilization" - }, - "diskUtilization": { - "description": "Target scaling by disk usage.", - "$ref": "DiskUtilization" - } - }, - "id": "AutomaticScaling" - }, - "ZipInfo": { - "description": "The zip file information for a zip deployment.", - "type": "object", - "properties": { - "sourceUrl": { - "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", - "type": "string" - }, - "filesCount": { - "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.", - "format": "int32", - "type": "integer" - } - }, - "id": "ZipInfo" - }, - "AuthorizedCertificate": { - "properties": { - "domainMappingsCount": { - "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "domainNames": { - "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly", - "type": "string" - }, - "displayName": { - "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.", - "type": "string" - }, - "certificateRawData": { - "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.", - "$ref": "CertificateRawData" - }, - "visibleDomainMappings": { - "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "expireTime": { - "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly", - "type": "string" - } - }, - "id": "AuthorizedCertificate", - "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", - "type": "object" - }, - "ResourceRecord": { - "description": "A DNS resource record.", - "type": "object", - "properties": { - "rrdata": { - "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).", - "type": "string" - }, - "name": { - "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.", - "type": "string" - }, - "type": { - "enumDescriptions": [ - "An unknown resource record.", - "An A resource record. Data is an IPv4 address.", - "An AAAA resource record. Data is an IPv6 address.", - "A CNAME resource record. Data is a domain name to be aliased." - ], - "enum": [ - "RECORD_TYPE_UNSPECIFIED", - "A", - "AAAA", - "CNAME" - ], - "description": "Resource record type. Example: AAAA.", - "type": "string" - } - }, - "id": "ResourceRecord" - }, - "Library": { - "properties": { - "name": { - "description": "Name of the library. Example: \"django\".", - "type": "string" - }, - "version": { - "description": "Version of the library to select, or \"latest\".", - "type": "string" - } - }, - "id": "Library", - "description": "Third-party Python runtime library that is required by the application.", - "type": "object" - }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "type": "object", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Location" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListLocationsResponse" - }, - "ContainerInfo": { - "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", - "type": "object", - "properties": { - "image": { - "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"", - "type": "string" - } - }, - "id": "ContainerInfo" - }, "RequestUtilization": { "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.", "type": "object", "properties": { - "targetRequestCountPerSecond": { - "description": "Target requests per second.", + "targetConcurrentRequests": { + "description": "Target number of concurrent requests.", "format": "int32", "type": "integer" }, - "targetConcurrentRequests": { - "description": "Target number of concurrent requests.", + "targetRequestCountPerSecond": { + "description": "Target requests per second.", "format": "int32", "type": "integer" } }, "id": "RequestUtilization" }, - "EndpointsApiService": { - "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", - "type": "object", - "properties": { - "name": { - "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", - "type": "string" - }, - "configId": { - "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"", - "type": "string" - } - }, - "id": "EndpointsApiService" - }, "UrlMap": { - "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", - "type": "object", "properties": { "redirectHttpResponseCode": { - "enum": [ - "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", - "REDIRECT_HTTP_RESPONSE_CODE_301", - "REDIRECT_HTTP_RESPONSE_CODE_302", - "REDIRECT_HTTP_RESPONSE_CODE_303", - "REDIRECT_HTTP_RESPONSE_CODE_307" - ], "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", "type": "string", "enumDescriptions": [ @@ -1990,6 +1582,13 @@ "302 Moved Temporarily code.", "303 See Other code.", "307 Temporary Redirect code." + ], + "enum": [ + "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", + "REDIRECT_HTTP_RESPONSE_CODE_301", + "REDIRECT_HTTP_RESPONSE_CODE_302", + "REDIRECT_HTTP_RESPONSE_CODE_303", + "REDIRECT_HTTP_RESPONSE_CODE_307" ] }, "securityLevel": { @@ -2025,8 +1624,8 @@ "type": "string" }, "script": { - "$ref": "ScriptHandler", - "description": "Executes a script to handle the request that matches this URL pattern." + "description": "Executes a script to handle the request that matches this URL pattern.", + "$ref": "ScriptHandler" }, "urlRegex": { "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", @@ -2053,79 +1652,37 @@ "$ref": "ApiEndpointHandler" }, "staticFiles": { - "description": "Returns the contents of a file, such as an image, as the response.", - "$ref": "StaticFilesHandler" + "$ref": "StaticFilesHandler", + "description": "Returns the contents of a file, such as an image, as the response." } }, - "id": "UrlMap" + "id": "UrlMap", + "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", + "type": "object" }, - "ApiConfigHandler": { - "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", + "EndpointsApiService": { + "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", "type": "object", "properties": { - "securityLevel": { - "enumDescriptions": [ - "Not specified.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", - "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", - "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." - ], - "enum": [ - "SECURE_UNSPECIFIED", - "SECURE_DEFAULT", - "SECURE_NEVER", - "SECURE_OPTIONAL", - "SECURE_ALWAYS" - ], - "description": "Security (HTTPS) enforcement for this URL.", + "name": { + "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", "type": "string" }, - "authFailAction": { - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ], - "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "type": "string", - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with a 401 HTTP status code and an error message." - ] - }, - "script": { - "description": "Path to the script from the application root directory.", - "type": "string" - }, - "login": { - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ], - "description": "Level of login required to access this resource. Defaults to optional.", - "type": "string", - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ] - }, - "url": { - "description": "URL to serve the endpoint at.", + "configId": { + "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"", "type": "string" } }, - "id": "ApiConfigHandler" + "id": "EndpointsApiService" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { + "done": { + "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", + "type": "boolean" + }, "response": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -2149,38 +1706,77 @@ }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" - }, - "done": { - "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", - "type": "boolean" } }, "id": "Operation" }, + "ApiConfigHandler": { + "properties": { + "securityLevel": { + "enumDescriptions": [ + "Not specified.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", + "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", + "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." + ], + "enum": [ + "SECURE_UNSPECIFIED", + "SECURE_DEFAULT", + "SECURE_NEVER", + "SECURE_OPTIONAL", + "SECURE_ALWAYS" + ], + "description": "Security (HTTPS) enforcement for this URL.", + "type": "string" + }, + "authFailAction": { + "description": "Action to take when users access resources that require authentication. Defaults to redirect.", + "type": "string", + "enumDescriptions": [ + "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", + "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", + "Rejects request with a 401 HTTP status code and an error message." + ], + "enum": [ + "AUTH_FAIL_ACTION_UNSPECIFIED", + "AUTH_FAIL_ACTION_REDIRECT", + "AUTH_FAIL_ACTION_UNAUTHORIZED" + ] + }, + "script": { + "description": "Path to the script from the application root directory.", + "type": "string" + }, + "login": { + "enumDescriptions": [ + "Not specified. LOGIN_OPTIONAL is assumed.", + "Does not require that the user is signed in.", + "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", + "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." + ], + "enum": [ + "LOGIN_UNSPECIFIED", + "LOGIN_OPTIONAL", + "LOGIN_ADMIN", + "LOGIN_REQUIRED" + ], + "description": "Level of login required to access this resource. Defaults to optional.", + "type": "string" + }, + "url": { + "description": "URL to serve the endpoint at.", + "type": "string" + } + }, + "id": "ApiConfigHandler", + "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", + "type": "object" + }, "StaticFilesHandler": { "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", "type": "object", "properties": { - "requireMatchingFile": { - "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", - "type": "boolean" - }, - "expiration": { - "description": "Time a static file served by this handler should be cached by web proxies and browsers.", - "format": "google-duration", - "type": "string" - }, - "applicationReadable": { - "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", - "type": "boolean" - }, - "httpHeaders": { - "description": "HTTP headers to use for all responses from these URLs.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, "uploadPathRegex": { "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", "type": "string" @@ -2192,6 +1788,26 @@ "mimeType": { "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.", "type": "string" + }, + "requireMatchingFile": { + "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", + "type": "boolean" + }, + "expiration": { + "description": "Time a static file served by this handler should be cached by web proxies and browsers.", + "format": "google-duration", + "type": "string" + }, + "httpHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "HTTP headers to use for all responses from these URLs.", + "type": "object" + }, + "applicationReadable": { + "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", + "type": "boolean" } }, "id": "StaticFilesHandler" @@ -2200,33 +1816,21 @@ "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", "type": "object", "properties": { - "maxInstances": { - "description": "Maximum number of instances to create for this version.", - "format": "int32", - "type": "integer" - }, "idleTimeout": { "description": "Duration of time after the last request that an instance must wait before the instance is shut down.", "format": "google-duration", "type": "string" + }, + "maxInstances": { + "description": "Maximum number of instances to create for this version.", + "format": "int32", + "type": "integer" } }, "id": "BasicScaling" }, "DiskUtilization": { - "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.", - "type": "object", "properties": { - "targetReadBytesPerSecond": { - "description": "Target bytes read per second.", - "format": "int32", - "type": "integer" - }, - "targetReadOpsPerSecond": { - "description": "Target ops read per seconds.", - "format": "int32", - "type": "integer" - }, "targetWriteOpsPerSecond": { "description": "Target ops written per second.", "format": "int32", @@ -2236,9 +1840,21 @@ "description": "Target bytes written per second.", "format": "int32", "type": "integer" + }, + "targetReadBytesPerSecond": { + "description": "Target bytes read per second.", + "format": "int32", + "type": "integer" + }, + "targetReadOpsPerSecond": { + "description": "Target ops read per seconds.", + "format": "int32", + "type": "integer" } }, - "id": "DiskUtilization" + "id": "DiskUtilization", + "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.", + "type": "object" }, "CpuUtilization": { "description": "Target scaling by CPU usage.", @@ -2257,33 +1873,6 @@ }, "id": "CpuUtilization" }, - "Status": { - "properties": { - "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 field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - } - }, - "id": "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", - "type": "object" - }, "IdentityAwareProxy": { "description": "Identity-Aware Proxy", "type": "object", @@ -2307,7 +1896,36 @@ }, "id": "IdentityAwareProxy" }, + "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "type": "object", + "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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + } + }, + "id": "Status" + }, "ManualScaling": { + "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", + "type": "object", "properties": { "instances": { "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.", @@ -2315,33 +1933,25 @@ "type": "integer" } }, - "id": "ManualScaling", - "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", - "type": "object" + "id": "ManualScaling" }, "LocationMetadata": { - "description": "Metadata for the given google.cloud.location.Location.", - "type": "object", "properties": { - "standardEnvironmentAvailable": { - "description": "App Engine Standard Environment is available in the given location.@OutputOnly", - "type": "boolean" - }, "flexibleEnvironmentAvailable": { "description": "App Engine Flexible Environment is available in the given location.@OutputOnly", "type": "boolean" + }, + "standardEnvironmentAvailable": { + "description": "App Engine Standard Environment is available in the given location.@OutputOnly", + "type": "boolean" } }, - "id": "LocationMetadata" + "id": "LocationMetadata", + "description": "Metadata for the given google.cloud.location.Location.", + "type": "object" }, "Service": { - "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.", - "type": "object", "properties": { - "id": { - "description": "Relative name of the service within the application. Example: default.@OutputOnly", - "type": "string" - }, "name": { "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", "type": "string" @@ -2349,45 +1959,72 @@ "split": { "$ref": "TrafficSplit", "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service." + }, + "id": { + "description": "Relative name of the service within the application. Example: default.@OutputOnly", + "type": "string" } }, - "id": "Service" + "id": "Service", + "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.", + "type": "object" }, "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", "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.", "type": "array", "items": { "$ref": "Operation" } + } + }, + "id": "ListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object" + }, + "FirewallRule": { + "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.", + "type": "object", + "properties": { + "priority": { + "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.", + "format": "int32", + "type": "integer" }, - "nextPageToken": { - "description": "The standard List next-page token.", + "action": { + "description": "The action to take on matched requests.", + "type": "string", + "enumDescriptions": [ + "", + "Matching requests are allowed.", + "Matching requests are denied." + ], + "enum": [ + "UNSPECIFIED_ACTION", + "ALLOW", + "DENY" + ] + }, + "description": { + "description": "An optional string description of this rule. This field has a maximum length of 100 characters.", + "type": "string" + }, + "sourceRange": { + "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.", "type": "string" } }, - "id": "ListOperationsResponse" + "id": "FirewallRule" }, "OperationMetadata": { "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { - "insertTime": { - "description": "Timestamp that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, "method": { "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly", "type": "string" @@ -2400,58 +2037,37 @@ "operationType": { "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly", "type": "string" + }, + "insertTime": { + "description": "Timestamp that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly", + "type": "string" } }, "id": "OperationMetadata" }, - "FirewallRule": { - "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.", - "type": "object", - "properties": { - "description": { - "description": "An optional string description of this rule. This field has a maximum length of 100 characters.", - "type": "string" - }, - "sourceRange": { - "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.", - "type": "string" - }, - "priority": { - "description": "A positive integer between 1, Int32.MaxValue-1 that defines the order of rule evaluation. Rules with the lowest priority are evaluated first.A default rule at priority Int32.MaxValue matches all IPv4 and IPv6 traffic when no previous rule matches. Only the action of this rule can be modified by the user.", - "format": "int32", - "type": "integer" - }, - "action": { - "enumDescriptions": [ - "", - "Matching requests are allowed.", - "Matching requests are denied." - ], - "enum": [ - "UNSPECIFIED_ACTION", - "ALLOW", - "DENY" - ], - "description": "The action to take on matched requests.", - "type": "string" - } - }, - "id": "FirewallRule" - }, "ListAuthorizedCertificatesResponse": { "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.", "type": "object", "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, "certificates": { "description": "The SSL certificates the user is authorized to administer.", "type": "array", "items": { "$ref": "AuthorizedCertificate" } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" } }, "id": "ListAuthorizedCertificatesResponse" @@ -2468,40 +2084,28 @@ "id": "CreateVersionMetadataV1Beta" }, "FeatureSettings": { + "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.", + "type": "object", "properties": { "splitHealthChecks": { "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.", "type": "boolean" } }, - "id": "FeatureSettings", - "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.", - "type": "object" + "id": "FeatureSettings" }, "OperationMetadataV1": { "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", + "user": { + "description": "User who requested this operation.@OutputOnly", "type": "string" }, "target": { "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", "type": "string" }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, "ephemeralMessage": { "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", "type": "string" @@ -2514,20 +2118,32 @@ "description": "Time that this operation completed.@OutputOnly", "format": "google-datetime", "type": "string" + }, + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" } }, "id": "OperationMetadataV1" }, "SslSettings": { + "description": "SSL configuration for a DomainMapping resource.", + "type": "object", "properties": { "certificateId": { "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support. Example: 12345.", "type": "string" } }, - "id": "SslSettings", - "description": "SSL configuration for a DomainMapping resource.", - "type": "object" + "id": "SslSettings" }, "ErrorHandler": { "description": "Custom static error page to be served when an error occurs.", @@ -2563,6 +2179,8 @@ "id": "ErrorHandler" }, "Network": { + "description": "Extra network settings. Only applicable in the App Engine flexible environment.", + "type": "object", "properties": { "forwardedPorts": { "description": "List of ports, or port pairs, to forward from the virtual machine to the application container. Only applicable in the App Engine flexible environment.", @@ -2584,40 +2202,12 @@ "type": "string" } }, - "id": "Network", - "description": "Extra network settings. Only applicable in the App Engine flexible environment.", - "type": "object" + "id": "Network" }, "Application": { + "description": "An Application resource contains the top-level configuration of an App Engine application.", + "type": "object", "properties": { - "dispatchRules": { - "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly", - "type": "array", - "items": { - "$ref": "UrlDispatchRule" - } - }, - "gcrDomain": { - "description": "The Google Container Registry domain used for storing managed build docker images for this application.", - "type": "string" - }, - "name": { - "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", - "type": "string" - }, - "id": { - "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", - "type": "string" - }, - "defaultCookieExpiration": { - "description": "Cookie expiration policy for this application.", - "format": "google-duration", - "type": "string" - }, - "locationId": { - "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US", - "type": "string" - }, "servingStatus": { "enumDescriptions": [ "Serving status is unspecified.", @@ -2639,8 +2229,8 @@ "type": "string" }, "featureSettings": { - "description": "The feature specific settings to be used in the application.", - "$ref": "FeatureSettings" + "$ref": "FeatureSettings", + "description": "The feature specific settings to be used in the application." }, "iap": { "$ref": "IdentityAwareProxy" @@ -2656,14 +2246,68 @@ "defaultBucket": { "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly", "type": "string" + }, + "dispatchRules": { + "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly", + "type": "array", + "items": { + "$ref": "UrlDispatchRule" + } + }, + "gcrDomain": { + "description": "The Google Container Registry domain used for storing managed build docker images for this application.", + "type": "string" + }, + "name": { + "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", + "type": "string" + }, + "defaultCookieExpiration": { + "description": "Cookie expiration policy for this application.", + "format": "google-duration", + "type": "string" + }, + "id": { + "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", + "type": "string" + }, + "locationId": { + "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US", + "type": "string" } }, - "id": "Application", - "description": "An Application resource contains the top-level configuration of an App Engine application.", - "type": "object" + "id": "Application" }, "Instance": { "properties": { + "errors": { + "description": "Number of errors since this instance was started.@OutputOnly", + "format": "int32", + "type": "integer" + }, + "vmStatus": { + "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "availability": { + "enum": [ + "UNSPECIFIED", + "RESIDENT", + "DYNAMIC" + ], + "description": "Availability of the instance.@OutputOnly", + "type": "string", + "enumDescriptions": [ + "", + "", + "" + ] + }, + "startTime": { + "description": "Time that this instance was started.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, "vmDebugEnabled": { "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly", "type": "boolean" @@ -2703,8 +2347,8 @@ "format": "int32", "type": "integer" }, - "id": { - "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", + "vmIp": { + "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", "type": "string" }, "memoryUsage": { @@ -2712,36 +2356,8 @@ "format": "int64", "type": "string" }, - "vmIp": { - "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "vmStatus": { - "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "availability": { - "enumDescriptions": [ - "", - "", - "" - ], - "enum": [ - "UNSPECIFIED", - "RESIDENT", - "DYNAMIC" - ], - "description": "Availability of the instance.@OutputOnly", - "type": "string" - }, - "errors": { - "description": "Number of errors since this instance was started.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "Time that this instance was started.@OutputOnly", - "format": "google-datetime", + "id": { + "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", "type": "string" } }, @@ -2753,6 +2369,11 @@ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances.", "type": "object", "properties": { + "initialDelay": { + "description": "The initial delay before starting to execute the checks.", + "format": "google-duration", + "type": "string" + }, "path": { "description": "The request path.", "type": "string" @@ -2771,20 +2392,15 @@ "format": "google-duration", "type": "string" }, - "failureThreshold": { - "description": "Number of consecutive failed checks required before considering the VM unhealthy.", - "format": "uint32", - "type": "integer" - }, "timeout": { "description": "Time before the check is considered failed.", "format": "google-duration", "type": "string" }, - "initialDelay": { - "description": "The initial delay before starting to execute the checks.", - "format": "google-duration", - "type": "string" + "failureThreshold": { + "description": "Number of consecutive failed checks required before considering the VM unhealthy.", + "format": "uint32", + "type": "integer" } }, "id": "LivenessCheck" @@ -2808,11 +2424,11 @@ "type": "object", "properties": { "labels": { - "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", + "type": "object" }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", @@ -2834,6 +2450,8 @@ "id": "Location" }, "NetworkUtilization": { + "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.", + "type": "object", "properties": { "targetSentBytesPerSecond": { "description": "Target bytes sent per second.", @@ -2856,19 +2474,12 @@ "type": "integer" } }, - "id": "NetworkUtilization", - "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.", - "type": "object" + "id": "NetworkUtilization" }, "HealthCheck": { "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.", "type": "object", "properties": { - "unhealthyThreshold": { - "description": "Number of consecutive failed health checks required before removing traffic.", - "format": "uint32", - "type": "integer" - }, "disableHealthCheck": { "description": "Whether to explicitly disable health checks for this instance.", "type": "boolean" @@ -2896,6 +2507,11 @@ "description": "Time before the health check is considered failed.", "format": "google-duration", "type": "string" + }, + "unhealthyThreshold": { + "description": "Number of consecutive failed health checks required before removing traffic.", + "format": "uint32", + "type": "integer" } }, "id": "HealthCheck" @@ -2904,21 +2520,6 @@ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.", "type": "object", "properties": { - "checkInterval": { - "description": "Interval between health checks.", - "format": "google-duration", - "type": "string" - }, - "timeout": { - "description": "Time before the check is considered failed.", - "format": "google-duration", - "type": "string" - }, - "failureThreshold": { - "description": "Number of consecutive failed checks required before removing traffic.", - "format": "uint32", - "type": "integer" - }, "appStartTimeout": { "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.", "format": "google-duration", @@ -2936,10 +2537,52 @@ "host": { "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"", "type": "string" + }, + "checkInterval": { + "description": "Interval between health checks.", + "format": "google-duration", + "type": "string" + }, + "timeout": { + "description": "Time before the check is considered failed.", + "format": "google-duration", + "type": "string" + }, + "failureThreshold": { + "description": "Number of consecutive failed checks required before removing traffic.", + "format": "uint32", + "type": "integer" } }, "id": "ReadinessCheck" }, + "StandardSchedulerSettings": { + "description": "Scheduler settings for standard environment.", + "type": "object", + "properties": { + "minInstances": { + "description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.", + "format": "int32", + "type": "integer" + }, + "targetCpuUtilization": { + "description": "Target CPU utilization ratio to maintain when scaling.", + "format": "double", + "type": "number" + }, + "targetThroughputUtilization": { + "description": "Target throughput utilization ratio to maintain when scaling", + "format": "double", + "type": "number" + }, + "maxInstances": { + "description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.", + "format": "int32", + "type": "integer" + } + }, + "id": "StandardSchedulerSettings" + }, "DebugInstanceRequest": { "properties": { "sshKey": { @@ -2951,32 +2594,16 @@ "description": "Request message for Instances.DebugInstance.", "type": "object" }, - "StandardSchedulerSettings": { - "description": "Scheduler settings for standard environment.", + "CreateVersionMetadataV1Alpha": { + "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", "type": "object", "properties": { - "targetThroughputUtilization": { - "description": "Target throughput utilization ratio to maintain when scaling", - "format": "double", - "type": "number" - }, - "maxInstances": { - "description": "Maximum number of instances for an app version. Set to zero to disable max_instances configuration.", - "format": "int32", - "type": "integer" - }, - "minInstances": { - "description": "Minimum number of instances for an app version. Set to zero to disable min_instances configuration.", - "format": "int32", - "type": "integer" - }, - "targetCpuUtilization": { - "description": "Target CPU utilization ratio to maintain when scaling.", - "format": "double", - "type": "number" + "cloudBuildId": { + "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", + "type": "string" } }, - "id": "StandardSchedulerSettings" + "id": "CreateVersionMetadataV1Alpha" }, "OperationMetadataV1Beta5": { "description": "Metadata for the given google.longrunning.Operation.", @@ -3007,60 +2634,22 @@ }, "id": "OperationMetadataV1Beta5" }, - "CreateVersionMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", + "Version": { + "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", "type": "object", "properties": { - "cloudBuildId": { - "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", - "type": "string" - } - }, - "id": "CreateVersionMetadataV1Alpha" - }, - "Version": { - "properties": { - "diskUsageBytes": { - "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", - "format": "int64", - "type": "string" - }, - "healthCheck": { - "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.", - "$ref": "HealthCheck" - }, - "threadsafe": { - "description": "Whether multiple requests can be dispatched to this version at once.", - "type": "boolean" - }, - "readinessCheck": { - "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.", - "$ref": "ReadinessCheck" - }, - "manualScaling": { - "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", - "$ref": "ManualScaling" - }, - "name": { - "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", - "type": "string" - }, - "apiConfig": { - "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.", - "$ref": "ApiConfigHandler" - }, "endpointsApiService": { "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.", "$ref": "EndpointsApiService" }, - "versionUrl": { - "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", - "type": "string" - }, "vm": { "description": "Whether to deploy this version in a container on a virtual machine.", "type": "boolean" }, + "versionUrl": { + "description": "Serving URL for this version. Example: \"https://myversion-dot-myservice-dot-myapp.appspot.com\"@OutputOnly", + "type": "string" + }, "instanceClass": { "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.", "type": "string" @@ -3079,19 +2668,23 @@ "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.", "type": "string" }, - "runtimeApiVersion": { - "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref", - "type": "string" - }, "deployment": { "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.", "$ref": "Deployment" }, + "runtimeApiVersion": { + "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref", + "type": "string" + }, "createTime": { "description": "Time that this version was created.@OutputOnly", "format": "google-datetime", "type": "string" }, + "resources": { + "$ref": "Resources", + "description": "Machine resources for this version. Only applicable for VM runtimes." + }, "inboundServices": { "enumDescriptions": [ "Not specified.", @@ -3121,10 +2714,6 @@ ] } }, - "resources": { - "$ref": "Resources", - "description": "Machine resources for this version. Only applicable for VM runtimes." - }, "errorHandlers": { "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.", "type": "array", @@ -3149,27 +2738,27 @@ "type": "string" }, "basicScaling": { - "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", - "$ref": "BasicScaling" + "$ref": "BasicScaling", + "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity." }, "runtime": { "description": "Desired runtime. Example: python27.", "type": "string" }, - "id": { - "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".", - "type": "string" - }, "createdBy": { "description": "Email address of the user who created this version.@OutputOnly", "type": "string" }, + "id": { + "description": "Relative name of the version within the service. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".", + "type": "string" + }, "envVariables": { + "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.", + "type": "object", "additionalProperties": { "type": "string" - }, - "description": "Environment variables available to the application.Only returned in GET requests if view=FULL is set.", - "type": "object" + } }, "livenessCheck": { "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.", @@ -3207,11 +2796,38 @@ "automaticScaling": { "$ref": "AutomaticScaling", "description": "Automatic scaling is based on request rate, response latencies, and other application metrics." + }, + "diskUsageBytes": { + "description": "Total size in bytes of all the files that are included in this version and currently hosted on the App Engine disk.@OutputOnly", + "format": "int64", + "type": "string" + }, + "healthCheck": { + "$ref": "HealthCheck", + "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set." + }, + "threadsafe": { + "description": "Whether multiple requests can be dispatched to this version at once.", + "type": "boolean" + }, + "readinessCheck": { + "$ref": "ReadinessCheck", + "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set." + }, + "manualScaling": { + "$ref": "ManualScaling", + "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time." + }, + "name": { + "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", + "type": "string" + }, + "apiConfig": { + "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.", + "$ref": "ApiConfigHandler" } }, - "id": "Version", - "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", - "type": "object" + "id": "Version" }, "RepairApplicationRequest": { "description": "Request message for 'Applications.RepairApplication'.", @@ -3234,14 +2850,21 @@ }, "id": "CertificateRawData" }, + "ScriptHandler": { + "properties": { + "scriptPath": { + "description": "Path to the script from the application root directory.", + "type": "string" + } + }, + "id": "ScriptHandler", + "description": "Executes a script to handle the request that matches the URL pattern.", + "type": "object" + }, "FileInfo": { "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.", "type": "object", "properties": { - "sha1Sum": { - "description": "The SHA1 hash of the file, in hex.", - "type": "string" - }, "mimeType": { "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.", "type": "string" @@ -3249,35 +2872,28 @@ "sourceUrl": { "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", "type": "string" + }, + "sha1Sum": { + "description": "The SHA1 hash of the file, in hex.", + "type": "string" } }, "id": "FileInfo" }, - "ScriptHandler": { - "description": "Executes a script to handle the request that matches the URL pattern.", - "type": "object", - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "id": "ScriptHandler" - }, "AuthorizedDomain": { - "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).", - "type": "object", "properties": { - "name": { - "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly", - "type": "string" - }, "id": { "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.", "type": "string" + }, + "name": { + "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly", + "type": "string" } }, - "id": "AuthorizedDomain" + "id": "AuthorizedDomain", + "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).", + "type": "object" }, "TrafficSplit": { "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.", @@ -3314,9 +2930,6 @@ "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Beta" - }, "warning": { "description": "Durable messages that persist on every operation poll. @OutputOnly", "type": "array", @@ -3349,27 +2962,30 @@ "description": "Time that this operation completed.@OutputOnly", "format": "google-datetime", "type": "string" + }, + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Beta" } }, "id": "OperationMetadataV1Beta" }, "ListIngressRulesResponse": { + "description": "Response message for Firewall.ListIngressRules.", + "type": "object", "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, "ingressRules": { "description": "The ingress FirewallRules for this application.", "type": "array", "items": { "$ref": "FirewallRule" } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" } }, - "id": "ListIngressRulesResponse", - "description": "Response message for Firewall.ListIngressRules.", - "type": "object" + "id": "ListIngressRulesResponse" }, "ListServicesResponse": { "description": "Response message for Services.ListServices.", @@ -3390,6 +3006,8 @@ "id": "ListServicesResponse" }, "Deployment": { + "description": "Code and application artifacts used to deploy a version to App Engine.", + "type": "object", "properties": { "files": { "additionalProperties": { @@ -3399,17 +3017,15 @@ "type": "object" }, "zip": { - "$ref": "ZipInfo", - "description": "The zip file for this deployment, if this is a zip deployment." + "description": "The zip file for this deployment, if this is a zip deployment.", + "$ref": "ZipInfo" }, "container": { "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.", "$ref": "ContainerInfo" } }, - "id": "Deployment", - "description": "Code and application artifacts used to deploy a version to App Engine.", - "type": "object" + "id": "Deployment" }, "Resources": { "description": "Machine resources for a version.", @@ -3458,10 +3074,6 @@ "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.", "type": "object", "properties": { - "volumeType": { - "description": "Underlying volume type, e.g. 'tmpfs'.", - "type": "string" - }, "sizeGb": { "description": "Volume size in gigabytes.", "format": "double", @@ -3470,9 +3082,395 @@ "name": { "description": "Unique name for the volume.", "type": "string" + }, + "volumeType": { + "description": "Underlying volume type, e.g. 'tmpfs'.", + "type": "string" } }, "id": "Volume" + }, + "ListInstancesResponse": { + "description": "Response message for Instances.ListInstances.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "instances": { + "description": "The instances belonging to the requested version.", + "type": "array", + "items": { + "$ref": "Instance" + } + } + }, + "id": "ListInstancesResponse" + }, + "ListDomainMappingsResponse": { + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "domainMappings": { + "description": "The domain mappings for the application.", + "type": "array", + "items": { + "$ref": "DomainMapping" + } + } + }, + "id": "ListDomainMappingsResponse", + "description": "Response message for DomainMappings.ListDomainMappings.", + "type": "object" + }, + "OperationMetadataV1Alpha": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", + "properties": { + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", + "type": "string" + }, + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Alpha" + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + } + }, + "id": "OperationMetadataV1Alpha" + }, + "UrlDispatchRule": { + "properties": { + "path": { + "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.", + "type": "string" + }, + "domain": { + "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", + "type": "string" + }, + "service": { + "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.", + "type": "string" + } + }, + "id": "UrlDispatchRule", + "description": "Rules to match an HTTP request and dispatch that request to a service.", + "type": "object" + }, + "ListVersionsResponse": { + "properties": { + "versions": { + "description": "The versions belonging to the requested service.", + "type": "array", + "items": { + "$ref": "Version" + } + }, + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + } + }, + "id": "ListVersionsResponse", + "description": "Response message for Versions.ListVersions.", + "type": "object" + }, + "ListAuthorizedDomainsResponse": { + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "domains": { + "description": "The authorized domains belonging to the user.", + "type": "array", + "items": { + "$ref": "AuthorizedDomain" + } + } + }, + "id": "ListAuthorizedDomainsResponse", + "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", + "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "ApiEndpointHandler": { + "description": "Uses Google Cloud Endpoints to handle requests.", + "type": "object", + "properties": { + "scriptPath": { + "description": "Path to the script from the application root directory.", + "type": "string" + } + }, + "id": "ApiEndpointHandler" + }, + "DomainMapping": { + "description": "A domain serving an App Engine application.", + "type": "object", + "properties": { + "id": { + "description": "Relative name of the domain serving the application. Example: example.com.", + "type": "string" + }, + "resourceRecords": { + "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly", + "type": "array", + "items": { + "$ref": "ResourceRecord" + } + }, + "name": { + "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", + "type": "string" + }, + "sslSettings": { + "$ref": "SslSettings", + "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL." + } + }, + "id": "DomainMapping" + }, + "ZipInfo": { + "properties": { + "sourceUrl": { + "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", + "type": "string" + }, + "filesCount": { + "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.", + "format": "int32", + "type": "integer" + } + }, + "id": "ZipInfo", + "description": "The zip file information for a zip deployment.", + "type": "object" + }, + "AutomaticScaling": { + "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", + "type": "object", + "properties": { + "minIdleInstances": { + "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.", + "format": "int32", + "type": "integer" + }, + "maxTotalInstances": { + "description": "Maximum number of instances that should be started to handle requests.", + "format": "int32", + "type": "integer" + }, + "minTotalInstances": { + "description": "Minimum number of instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "networkUtilization": { + "description": "Target scaling by network usage.", + "$ref": "NetworkUtilization" + }, + "maxConcurrentRequests": { + "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", + "format": "int32", + "type": "integer" + }, + "coolDownPeriod": { + "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.", + "format": "google-duration", + "type": "string" + }, + "maxPendingLatency": { + "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "cpuUtilization": { + "$ref": "CpuUtilization", + "description": "Target scaling by CPU usage." + }, + "diskUtilization": { + "description": "Target scaling by disk usage.", + "$ref": "DiskUtilization" + }, + "minPendingLatency": { + "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "requestUtilization": { + "$ref": "RequestUtilization", + "description": "Target scaling by request utilization." + }, + "maxIdleInstances": { + "description": "Maximum number of idle instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "standardSchedulerSettings": { + "description": "Scheduler settings for standard environment.", + "$ref": "StandardSchedulerSettings" + } + }, + "id": "AutomaticScaling" + }, + "AuthorizedCertificate": { + "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", + "type": "object", + "properties": { + "displayName": { + "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.", + "type": "string" + }, + "certificateRawData": { + "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority.", + "$ref": "CertificateRawData" + }, + "visibleDomainMappings": { + "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "expireTime": { + "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly", + "type": "string" + }, + "domainMappingsCount": { + "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", + "format": "int32", + "type": "integer" + }, + "domainNames": { + "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly", + "type": "string" + } + }, + "id": "AuthorizedCertificate" + }, + "ResourceRecord": { + "properties": { + "rrdata": { + "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).", + "type": "string" + }, + "name": { + "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.", + "type": "string" + }, + "type": { + "enumDescriptions": [ + "An unknown resource record.", + "An A resource record. Data is an IPv4 address.", + "An AAAA resource record. Data is an IPv6 address.", + "A CNAME resource record. Data is a domain name to be aliased." + ], + "enum": [ + "RECORD_TYPE_UNSPECIFIED", + "A", + "AAAA", + "CNAME" + ], + "description": "Resource record type. Example: AAAA.", + "type": "string" + } + }, + "id": "ResourceRecord", + "description": "A DNS resource record.", + "type": "object" + }, + "Library": { + "description": "Third-party Python runtime library that is required by the application.", + "type": "object", + "properties": { + "version": { + "description": "Version of the library to select, or \"latest\".", + "type": "string" + }, + "name": { + "description": "Name of the library. Example: \"django\".", + "type": "string" + } + }, + "id": "Library" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "type": "object", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Location" + } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "id": "ListLocationsResponse" + }, + "ContainerInfo": { + "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", + "type": "object", + "properties": { + "image": { + "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"", + "type": "string" + } + }, + "id": "ContainerInfo" } }, "protocol": "rest", @@ -3485,21 +3483,21 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/appengine.admin": { + "description": "View and manage your applications deployed on Google App Engine" + }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud Platform services" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/appengine.admin": { - "description": "View and manage your applications deployed on Google App Engine" } } } }, "kind": "discovery#restDescription", - "servicePath": "", "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", + "servicePath": "", "rootUrl": "https://appengine.googleapis.com/", "basePath": "", "ownerDomain": "google.com", @@ -3508,5 +3506,7 @@ "revision": "20171220", "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "id": "appengine:v1", - "title": "Google App Engine Admin API" + "title": "Google App Engine Admin API", + "discoveryVersion": "v1", + "ownerName": "Google" }
diff --git a/appengine/v1alpha/appengine-api.json b/appengine/v1alpha/appengine-api.json index 4cd40a0..f389e66 100644 --- a/appengine/v1alpha/appengine-api.json +++ b/appengine/v1alpha/appengine-api.json
@@ -1,4 +1,16 @@ { + "kind": "discovery#restDescription", + "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", + "servicePath": "", + "rootUrl": "https://appengine.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "appengine", + "batchPath": "batch", + "revision": "20171220", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", + "id": "appengine:v1alpha", + "title": "Google App Engine Admin API", "discoveryVersion": "v1", "ownerName": "Google", "resources": { @@ -8,24 +20,14 @@ "methods": { "list": { "description": "Lists information about the supported locations for this service.", - "response": { - "$ref": "ListLocationsResponse" - }, + "httpMethod": "GET", "parameterOrder": [ "appsId" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], + "response": { + "$ref": "ListLocationsResponse" + }, "parameters": { - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, "appsId": { "description": "Part of `name`. The resource that owns the locations collection, if applicable.", "required": true, @@ -33,31 +35,40 @@ "location": "path" }, "pageToken": { + "location": "query", "description": "The standard list page token.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { + "location": "query", "description": "The standard list page size.", "format": "int32", - "type": "integer", + "type": "integer" + }, + "filter": { + "description": "The standard list filter.", + "type": "string", "location": "query" } }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "flatPath": "v1alpha/apps/{appsId}/locations", - "path": "v1alpha/apps/{appsId}/locations", - "id": "appengine.apps.locations.list" + "id": "appengine.apps.locations.list", + "path": "v1alpha/apps/{appsId}/locations" }, "get": { - "description": "Get information about a location.", - "httpMethod": "GET", + "response": { + "$ref": "Location" + }, "parameterOrder": [ "appsId", "locationsId" ], - "response": { - "$ref": "Location" - }, + "httpMethod": "GET", "parameters": { "appsId": { "description": "Part of `name`. Resource name for the location.", @@ -78,143 +89,29 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1alpha/apps/{appsId}/locations/{locationsId}", + "path": "v1alpha/apps/{appsId}/locations/{locationsId}", "id": "appengine.apps.locations.get", - "path": "v1alpha/apps/{appsId}/locations/{locationsId}" + "description": "Get information about a location." } } }, "domainMappings": { "methods": { - "list": { - "flatPath": "v1alpha/apps/{appsId}/domainMappings", - "path": "v1alpha/apps/{appsId}/domainMappings", - "id": "appengine.apps.domainMappings.list", - "description": "Lists the domain mappings on an application.", - "response": { - "$ref": "ListDomainMappingsResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - }, - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "get": { - "id": "appengine.apps.domainMappings.get", - "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", - "description": "Gets the specified domain mapping.", - "httpMethod": "GET", - "response": { + "create": { + "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.", + "request": { "$ref": "DomainMapping" }, - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "parameters": { - "domainMappingsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}" - }, - "patch": { "response": { "$ref": "Operation" }, "parameterOrder": [ - "appsId", - "domainMappingsId" + "appsId" ], - "httpMethod": "PATCH", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", - "required": true, - "type": "string" - }, - "domainMappingsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "noManagedCertificate": { - "location": "query", - "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.", - "type": "boolean" - }, - "updateMask": { - "location": "query", - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string" - } - }, + "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", - "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", - "id": "appengine.apps.domainMappings.patch", - "request": { - "$ref": "DomainMapping" - }, - "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource." - }, - "create": { - "flatPath": "v1alpha/apps/{appsId}/domainMappings", - "id": "appengine.apps.domainMappings.create", - "path": "v1alpha/apps/{appsId}/domainMappings", - "request": { - "$ref": "DomainMapping" - }, - "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.", - "httpMethod": "POST", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "Operation" - }, "parameters": { "overrideStrategy": { "location": "query", @@ -238,15 +135,11 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "flatPath": "v1alpha/apps/{appsId}/domainMappings", + "path": "v1alpha/apps/{appsId}/domainMappings", + "id": "appengine.apps.domainMappings.create" }, "delete": { - "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", - "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", - "id": "appengine.apps.domainMappings.delete", - "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", "response": { "$ref": "Operation" }, @@ -271,79 +164,25 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "authorizedCertificates": { - "methods": { - "create": { - "response": { - "$ref": "AuthorizedCertificate" - }, - "parameterOrder": [ - "appsId" ], - "httpMethod": "POST", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates", - "path": "v1alpha/apps/{appsId}/authorizedCertificates", - "id": "appengine.apps.authorizedCertificates.create", - "request": { - "$ref": "AuthorizedCertificate" - }, - "description": "Uploads the specified SSL certificate." - }, - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "appsId", - "authorizedCertificatesId" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", - "required": true, - "type": "string", - "location": "path" - }, - "authorizedCertificatesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.delete", - "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "description": "Deletes the specified SSL certificate." + "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", + "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.delete", + "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource." }, "list": { - "description": "Lists all SSL certificates the user is authorized to administer.", - "httpMethod": "GET", + "response": { + "$ref": "ListDomainMappingsResponse" + }, "parameterOrder": [ "appsId" ], - "response": { - "$ref": "ListAuthorizedCertificatesResponse" - }, + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { "appsId": { "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", @@ -357,10 +196,155 @@ "location": "query" }, "pageSize": { - "location": "query", "description": "Maximum results to return per page.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" + } + }, + "flatPath": "v1alpha/apps/{appsId}/domainMappings", + "path": "v1alpha/apps/{appsId}/domainMappings", + "id": "appengine.apps.domainMappings.list", + "description": "Lists the domain mappings on an application." + }, + "get": { + "description": "Gets the specified domain mapping.", + "response": { + "$ref": "DomainMapping" + }, + "parameterOrder": [ + "appsId", + "domainMappingsId" + ], + "httpMethod": "GET", + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", + "required": true, + "type": "string", + "location": "path" + }, + "domainMappingsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", + "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.get" + }, + "patch": { + "request": { + "$ref": "DomainMapping" + }, + "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", + "httpMethod": "PATCH", + "parameterOrder": [ + "appsId", + "domainMappingsId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "domainMappingsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "noManagedCertificate": { + "location": "query", + "description": "Whether a managed certificate should be provided by App Engine. If true, a certificate ID must be manually set in the DomainMapping resource to configure SSL for this domain. If false, a managed certificate will be provisioned and a certificate ID will be automatically populated. Only applicable if ssl_settings.certificate_id is specified in the update mask.", + "type": "boolean" + }, + "updateMask": { + "location": "query", + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.patch", + "path": "v1alpha/apps/{appsId}/domainMappings/{domainMappingsId}" + } + } + }, + "authorizedCertificates": { + "methods": { + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "appsId", + "authorizedCertificatesId" + ], + "parameters": { + "authorizedCertificatesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/authorizedCertificates/12345.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "id": "appengine.apps.authorizedCertificates.delete", + "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "description": "Deletes the specified SSL certificate." + }, + "list": { + "response": { + "$ref": "ListAuthorizedCertificatesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" }, "view": { "location": "query", @@ -378,10 +362,14 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates", + "path": "v1alpha/apps/{appsId}/authorizedCertificates", "id": "appengine.apps.authorizedCertificates.list", - "path": "v1alpha/apps/{appsId}/authorizedCertificates" + "description": "Lists all SSL certificates the user is authorized to administer." }, "get": { + "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "id": "appengine.apps.authorizedCertificates.get", + "description": "Gets the specified SSL certificate.", "response": { "$ref": "AuthorizedCertificate" }, @@ -391,6 +379,15 @@ ], "httpMethod": "GET", "parameters": { + "view": { + "location": "query", + "enum": [ + "BASIC_CERTIFICATE", + "FULL_CERTIFICATE" + ], + "description": "Controls the set of fields returned in the GET response.", + "type": "string" + }, "authorizedCertificatesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", @@ -402,15 +399,6 @@ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", "required": true, "type": "string" - }, - "view": { - "location": "query", - "enum": [ - "BASIC_CERTIFICATE", - "FULL_CERTIFICATE" - ], - "description": "Controls the set of fields returned in the GET response.", - "type": "string" } }, "scopes": [ @@ -418,12 +406,13 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.get", - "description": "Gets the specified SSL certificate." + "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}" }, "patch": { + "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", + "request": { + "$ref": "AuthorizedCertificate" + }, "response": { "$ref": "AuthorizedCertificate" }, @@ -443,22 +432,45 @@ "location": "path" }, "updateMask": { + "location": "query", "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "appsId": { - "location": "path", "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", "path": "v1alpha/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.patch", - "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", + "id": "appengine.apps.authorizedCertificates.patch" + }, + "create": { + "response": { + "$ref": "AuthorizedCertificate" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1alpha/apps/{appsId}/authorizedCertificates", + "path": "v1alpha/apps/{appsId}/authorizedCertificates", + "id": "appengine.apps.authorizedCertificates.create", + "description": "Uploads the specified SSL certificate.", "request": { "$ref": "AuthorizedCertificate" } @@ -469,13 +481,18 @@ "methods": { "list": { "description": "Lists all domains the user is authorized to administer.", - "httpMethod": "GET", "response": { "$ref": "ListAuthorizedDomainsResponse" }, "parameterOrder": [ "appsId" ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { "pageSize": { "location": "query", @@ -484,10 +501,10 @@ "type": "integer" }, "appsId": { - "location": "path", "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "pageToken": { "description": "Continuation token for fetching the next page of results.", @@ -495,33 +512,41 @@ "location": "query" } }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], "flatPath": "v1alpha/apps/{appsId}/authorizedDomains", - "id": "appengine.apps.authorizedDomains.list", - "path": "v1alpha/apps/{appsId}/authorizedDomains" + "path": "v1alpha/apps/{appsId}/authorizedDomains", + "id": "appengine.apps.authorizedDomains.list" } } }, "operations": { "methods": { "list": { + "path": "v1alpha/apps/{appsId}/operations", + "id": "appengine.apps.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "appsId" ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, "filter": { - "location": "query", "description": "The standard list filter.", - "type": "string" + "type": "string", + "location": "query" }, "appsId": { "description": "Part of `name`. The name of the operation's parent resource.", @@ -530,40 +555,22 @@ "location": "path" }, "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" + "description": "The standard list page token.", + "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1alpha/apps/{appsId}/operations", - "id": "appengine.apps.operations.list", - "path": "v1alpha/apps/{appsId}/operations" + "flatPath": "v1alpha/apps/{appsId}/operations" }, "get": { - "response": { - "$ref": "Operation" - }, + "httpMethod": "GET", "parameterOrder": [ "appsId", "operationsId" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], + "response": { + "$ref": "Operation" + }, "parameters": { "appsId": { "location": "path", @@ -572,15 +579,20 @@ "type": "string" }, "operationsId": { - "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "flatPath": "v1alpha/apps/{appsId}/operations/{operationsId}", - "path": "v1alpha/apps/{appsId}/operations/{operationsId}", "id": "appengine.apps.operations.get", + "path": "v1alpha/apps/{appsId}/operations/{operationsId}", "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." } } @@ -589,31 +601,26 @@ } }, "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.", - "type": "string", - "location": "query" - }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" + "default": "true" }, "oauth_token": { + "location": "query", "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", "type": "string", "location": "query" }, "upload_protocol": { + "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "prettyPrint": { "location": "query", @@ -622,19 +629,14 @@ "default": "true" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "uploadType": { - "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" + "type": "string", + "location": "query" }, "$.xgafv": { "enumDescriptions": [ @@ -649,6 +651,11 @@ "description": "V1 error format.", "type": "string" }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "alt": { "description": "Data format for response.", "default": "json", @@ -666,77 +673,26 @@ "location": "query" }, "access_token": { + "location": "query", "description": "OAuth access token.", - "type": "string", - "location": "query" + "type": "string" }, "key": { "location": "query", "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.", "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.", + "type": "string", + "location": "query" } }, "schemas": { - "ManagedCertificate": { - "description": "A certificate managed by App Engine.", - "type": "object", - "properties": { - "status": { - "enum": [ - "UNSPECIFIED_STATUS", - "OK", - "PENDING", - "FAILED_RETRYING_INTERNAL", - "FAILED_RETRYING_NOT_VISIBLE", - "FAILED_PERMANENTLY_NOT_VISIBLE", - "FAILED_RETRYING_CAA_FORBIDDEN", - "FAILED_RETRYING_CAA_CHECKING" - ], - "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly", - "type": "string", - "enumDescriptions": [ - "", - "Certificate was successfully obtained and inserted into the serving system.", - "Certificate is under active attempts to acquire or renew.", - "Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.", - "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.", - "All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.", - "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.", - "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving." - ] - }, - "lastRenewalTime": { - "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly", - "format": "google-datetime", - "type": "string" - } - }, - "id": "ManagedCertificate" - }, - "SslSettings": { - "properties": { - "isManagedCertificate": { - "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly", - "type": "boolean" - }, - "certificateId": { - "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.", - "type": "string" - } - }, - "id": "SslSettings", - "description": "SSL configuration for a DomainMapping resource.", - "type": "object" - }, "OperationMetadataV1": { "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, "warning": { "description": "Durable messages that persist on every operation poll. @OutputOnly", "type": "array", @@ -744,6 +700,11 @@ "type": "string" } }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, "user": { "description": "User who requested this operation.@OutputOnly", "type": "string" @@ -768,26 +729,46 @@ }, "id": "OperationMetadataV1" }, + "SslSettings": { + "description": "SSL configuration for a DomainMapping resource.", + "type": "object", + "properties": { + "isManagedCertificate": { + "description": "Whether the mapped certificate is an App Engine managed certificate. Managed certificates are created by default with a domain mapping. To opt out, specify no_managed_certificate on a CREATE or UPDATE request.@OutputOnly", + "type": "boolean" + }, + "certificateId": { + "description": "ID of the AuthorizedCertificate resource configuring SSL for the application. Clearing this field will remove SSL support.By default, a managed certificate is automatically created for every domain mapping. To omit SSL support or to configure SSL manually, specify no_managed_certificate on a CREATE or UPDATE request. You must be authorized to administer the AuthorizedCertificate resource to manually map it to a DomainMapping resource. Example: 12345.", + "type": "string" + } + }, + "id": "SslSettings" + }, "ListDomainMappingsResponse": { "description": "Response message for DomainMappings.ListDomainMappings.", "type": "object", "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, "domainMappings": { "description": "The domain mappings for the application.", "type": "array", "items": { "$ref": "DomainMapping" } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" } }, "id": "ListDomainMappingsResponse" }, "OperationMetadataV1Alpha": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", "properties": { + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Alpha" + }, "warning": { "description": "Durable messages that persist on every operation poll. @OutputOnly", "type": "array", @@ -820,18 +801,11 @@ "description": "Time that this operation completed.@OutputOnly", "format": "google-datetime", "type": "string" - }, - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Alpha" } }, - "id": "OperationMetadataV1Alpha", - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object" + "id": "OperationMetadataV1Alpha" }, "ListAuthorizedDomainsResponse": { - "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", - "type": "object", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", @@ -845,7 +819,9 @@ } } }, - "id": "ListAuthorizedDomainsResponse" + "id": "ListAuthorizedDomainsResponse", + "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", + "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", @@ -855,14 +831,6 @@ }, "DomainMapping": { "properties": { - "name": { - "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", - "type": "string" - }, - "sslSettings": { - "$ref": "SslSettings", - "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL." - }, "id": { "description": "Relative name of the domain serving the application. Example: example.com.", "type": "string" @@ -873,6 +841,14 @@ "items": { "$ref": "ResourceRecord" } + }, + "name": { + "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", + "type": "string" + }, + "sslSettings": { + "$ref": "SslSettings", + "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL." } }, "id": "DomainMapping", @@ -880,14 +856,9 @@ "type": "object" }, "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "type": "object", "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", - "type": "object" - }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", "type": "string" @@ -903,15 +874,18 @@ }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", + "type": "object" } }, - "id": "Location", - "description": "A resource that represents Google Cloud Platform location.", - "type": "object" + "id": "Location" }, "AuthorizedCertificate": { - "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", - "type": "object", "properties": { "displayName": { "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.", @@ -922,8 +896,8 @@ "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority." }, "managedCertificate": { - "$ref": "ManagedCertificate", - "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly" + "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly", + "$ref": "ManagedCertificate" }, "visibleDomainMappings": { "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", @@ -958,7 +932,9 @@ "type": "string" } }, - "id": "AuthorizedCertificate" + "id": "AuthorizedCertificate", + "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", + "type": "object" }, "ResourceRecord": { "description": "A DNS resource record.", @@ -1001,6 +977,8 @@ "type": "object" }, "OperationMetadataV1Beta5": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", "properties": { "method": { "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly", @@ -1025,24 +1003,22 @@ "type": "string" } }, - "id": "OperationMetadataV1Beta5", - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object" + "id": "OperationMetadataV1Beta5" }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" } }, "id": "ListLocationsResponse" @@ -1066,9 +1042,25 @@ "description": "This resource represents a long-running operation that is the result of a network API call.", "type": "object", "properties": { + "done": { + "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", + "type": "boolean" + }, + "response": { + "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", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "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 operations/some/unique/name.", + "type": "string" + }, "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { @@ -1077,29 +1069,11 @@ }, "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", "type": "object" - }, - "done": { - "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", - "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 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" - }, - "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 operations/some/unique/name.", - "type": "string" } }, "id": "Operation" }, "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", - "type": "object", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", @@ -1122,19 +1096,21 @@ "type": "string" } }, - "id": "Status" + "id": "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "type": "object" }, "AuthorizedDomain": { "description": "A domain that a user has been authorized to administer. To authorize use of a domain, verify ownership via Webmaster Central (https://www.google.com/webmasters/verification/home).", "type": "object", "properties": { - "name": { - "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly", - "type": "string" - }, "id": { "description": "Fully qualified domain name of the domain authorized for use. Example: example.com.", "type": "string" + }, + "name": { + "description": "Full path to the AuthorizedDomain resource in the API. Example: apps/myapp/authorizedDomains/example.com.@OutputOnly", + "type": "string" } }, "id": "AuthorizedDomain" @@ -1158,6 +1134,22 @@ "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", + "type": "string" + }, "endTime": { "description": "Time that this operation completed.@OutputOnly", "format": "google-datetime", @@ -1177,27 +1169,13 @@ "description": "Time that this operation was created.@OutputOnly", "format": "google-datetime", "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", - "type": "string" } }, "id": "OperationMetadataV1Beta" }, "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", "properties": { "operations": { "description": "A list of operations that matches the specified filter in the request.", @@ -1211,19 +1189,12 @@ "type": "string" } }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations.", - "type": "object" + "id": "ListOperationsResponse" }, "OperationMetadata": { "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { - "endTime": { - "description": "Timestamp that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, "operationType": { "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly", "type": "string" @@ -1244,11 +1215,18 @@ "method": { "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly", "type": "string" + }, + "endTime": { + "description": "Timestamp that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" } }, "id": "OperationMetadata" }, "ListAuthorizedCertificatesResponse": { + "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.", + "type": "object", "properties": { "nextPageToken": { "description": "Continuation token for fetching the next page of results.", @@ -1262,9 +1240,7 @@ } } }, - "id": "ListAuthorizedCertificatesResponse", - "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.", - "type": "object" + "id": "ListAuthorizedCertificatesResponse" }, "CreateVersionMetadataV1Beta": { "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.", @@ -1276,6 +1252,42 @@ } }, "id": "CreateVersionMetadataV1Beta" + }, + "ManagedCertificate": { + "properties": { + "lastRenewalTime": { + "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "status": { + "enum": [ + "UNSPECIFIED_STATUS", + "OK", + "PENDING", + "FAILED_RETRYING_INTERNAL", + "FAILED_RETRYING_NOT_VISIBLE", + "FAILED_PERMANENTLY_NOT_VISIBLE", + "FAILED_RETRYING_CAA_FORBIDDEN", + "FAILED_RETRYING_CAA_CHECKING" + ], + "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly", + "type": "string", + "enumDescriptions": [ + "", + "Certificate was successfully obtained and inserted into the serving system.", + "Certificate is under active attempts to acquire or renew.", + "Most recent renewal failed due to a system failure and will be retried. System failure is likely transient, and subsequent renewal attempts may succeed. The last successfully provisioned certificate may still be serving.", + "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.", + "All renewal attempts have been exhausted. Most recent renewal failed due to an invalid DNS setup and will not be retried. The last successfully provisioned certificate may still be serving.", + "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.", + "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving." + ] + } + }, + "id": "ManagedCertificate", + "description": "A certificate managed by App Engine.", + "type": "object" } }, "protocol": "rest", @@ -1288,28 +1300,16 @@ "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/appengine.admin": { - "description": "View and manage your applications deployed on Google App Engine" - }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud Platform services" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/appengine.admin": { + "description": "View and manage your applications deployed on Google App Engine" } } } - }, - "kind": "discovery#restDescription", - "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", - "servicePath": "", - "rootUrl": "https://appengine.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "appengine", - "batchPath": "batch", - "revision": "20171220", - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", - "id": "appengine:v1alpha", - "title": "Google App Engine Admin API" + } }
diff --git a/appengine/v1beta/appengine-api.json b/appengine/v1beta/appengine-api.json index 68bedc0..9104818 100644 --- a/appengine/v1beta/appengine-api.json +++ b/appengine/v1beta/appengine-api.json
@@ -1,418 +1,17 @@ { - "kind": "discovery#restDescription", - "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", - "servicePath": "", - "rootUrl": "https://appengine.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "appengine", "batchPath": "batch", - "revision": "20171220", - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "id": "appengine:v1beta", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", + "revision": "20171220", "title": "Google App Engine Admin API", "discoveryVersion": "v1", "ownerName": "Google", "resources": { "apps": { "resources": { - "domainMappings": { - "methods": { - "delete": { - "id": "appengine.apps.domainMappings.delete", - "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", - "httpMethod": "DELETE", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", - "required": true, - "type": "string" - }, - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}" - }, - "list": { - "description": "Lists the domain mappings on an application.", - "response": { - "$ref": "ListDomainMappingsResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "flatPath": "v1beta/apps/{appsId}/domainMappings", - "path": "v1beta/apps/{appsId}/domainMappings", - "id": "appengine.apps.domainMappings.list" - }, - "get": { - "description": "Gets the specified domain mapping.", - "response": { - "$ref": "DomainMapping" - }, - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "id": "appengine.apps.domainMappings.get" - }, - "patch": { - "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", - "id": "appengine.apps.domainMappings.patch", - "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", - "request": { - "$ref": "DomainMapping" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "domainMappingsId" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", - "required": true, - "type": "string", - "location": "path" - }, - "domainMappingsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "updateMask": { - "location": "query", - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string" - } - } - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "POST", - "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - }, - "overrideStrategy": { - "location": "query", - "enum": [ - "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY", - "STRICT", - "OVERRIDE" - ], - "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/domainMappings", - "path": "v1beta/apps/{appsId}/domainMappings", - "id": "appengine.apps.domainMappings.create", - "request": { - "$ref": "DomainMapping" - }, - "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains." - } - } - }, - "firewall": { - "resources": { - "ingressRules": { - "methods": { - "delete": { - "description": "Deletes the specified firewall rule.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "httpMethod": "DELETE", - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.", - "required": true, - "type": "string", - "location": "path" - }, - "ingressRulesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "id": "appengine.apps.firewall.ingressRules.delete" - }, - "list": { - "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules", - "path": "v1beta/apps/{appsId}/firewall/ingressRules", - "id": "appengine.apps.firewall.ingressRules.list", - "description": "Lists the firewall rules of an application.", - "response": { - "$ref": "ListIngressRulesResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "matchingAddress": { - "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.", - "type": "string", - "location": "query" - }, - "appsId": { - "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - } - } - }, - "create": { - "response": { - "$ref": "FirewallRule" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "POST", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules", - "path": "v1beta/apps/{appsId}/firewall/ingressRules", - "id": "appengine.apps.firewall.ingressRules.create", - "request": { - "$ref": "FirewallRule" - }, - "description": "Creates a firewall rule for the application." - }, - "get": { - "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "id": "appengine.apps.firewall.ingressRules.get", - "description": "Gets the specified firewall rule.", - "response": { - "$ref": "FirewallRule" - }, - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.", - "required": true, - "type": "string" - }, - "ingressRulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}" - }, - "patch": { - "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", - "id": "appengine.apps.firewall.ingressRules.patch", - "request": { - "$ref": "FirewallRule" - }, - "description": "Updates the specified firewall rule.", - "response": { - "$ref": "FirewallRule" - }, - "parameterOrder": [ - "appsId", - "ingressRulesId" - ], - "httpMethod": "PATCH", - "parameters": { - "ingressRulesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "appsId": { - "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}" - }, - "batchUpdate": { - "httpMethod": "POST", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "BatchUpdateIngressRulesResponse" - }, - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate", - "id": "appengine.apps.firewall.ingressRules.batchUpdate", - "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate", - "request": { - "$ref": "BatchUpdateIngressRulesRequest" - }, - "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list." - } - } - } - } - }, "locations": { "methods": { "list": { - "flatPath": "v1beta/apps/{appsId}/locations", - "path": "v1beta/apps/{appsId}/locations", - "id": "appengine.apps.locations.list", - "description": "Lists information about the supported locations for this service.", "response": { "$ref": "ListLocationsResponse" }, @@ -426,11 +25,16 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + }, "appsId": { - "location": "path", "description": "Part of `name`. The resource that owns the locations collection, if applicable.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "pageToken": { "description": "The standard list page token.", @@ -442,16 +46,14 @@ "format": "int32", "type": "integer", "location": "query" - }, - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" } - } + }, + "flatPath": "v1beta/apps/{appsId}/locations", + "path": "v1beta/apps/{appsId}/locations", + "id": "appengine.apps.locations.list", + "description": "Lists information about the supported locations for this service." }, "get": { - "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}", "path": "v1beta/apps/{appsId}/locations/{locationsId}", "id": "appengine.apps.locations.get", "description": "Get information about a location.", @@ -463,12 +65,17 @@ "locationsId" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { "locationsId": { - "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "appsId": { "location": "path", @@ -477,17 +84,15 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + "flatPath": "v1beta/apps/{appsId}/locations/{locationsId}" } } }, "authorizedCertificates": { "methods": { "delete": { + "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", + "id": "appengine.apps.authorizedCertificates.delete", "description": "Deletes the specified SSL certificate.", "response": { "$ref": "Empty" @@ -497,9 +102,6 @@ "authorizedCertificatesId" ], "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "appsId": { "location": "path", @@ -508,25 +110,29 @@ "type": "string" }, "authorizedCertificatesId": { + "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, - "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.delete" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}" }, "list": { + "flatPath": "v1beta/apps/{appsId}/authorizedCertificates", + "path": "v1beta/apps/{appsId}/authorizedCertificates", + "id": "appengine.apps.authorizedCertificates.list", "description": "Lists all SSL certificates the user is authorized to administer.", - "httpMethod": "GET", "response": { "$ref": "ListAuthorizedCertificatesResponse" }, "parameterOrder": [ "appsId" ], + "httpMethod": "GET", "parameters": { "appsId": { "location": "path", @@ -535,9 +141,9 @@ "type": "string" }, "pageToken": { - "location": "query", "description": "Continuation token for fetching the next page of results.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", @@ -559,31 +165,23 @@ "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta/apps/{appsId}/authorizedCertificates", - "id": "appengine.apps.authorizedCertificates.list", - "path": "v1beta/apps/{appsId}/authorizedCertificates" + ] }, "get": { - "response": { - "$ref": "AuthorizedCertificate" - }, + "httpMethod": "GET", "parameterOrder": [ "appsId", "authorizedCertificatesId" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], + "response": { + "$ref": "AuthorizedCertificate" + }, "parameters": { "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/authorizedCertificates/12345.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "view": { "description": "Controls the set of fields returned in the GET response.", @@ -601,28 +199,38 @@ "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", "id": "appengine.apps.authorizedCertificates.get", + "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", "description": "Gets the specified SSL certificate." }, "patch": { - "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", + "id": "appengine.apps.authorizedCertificates.patch", + "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", "request": { "$ref": "AuthorizedCertificate" }, - "response": { - "$ref": "AuthorizedCertificate" - }, + "description": "Updates the specified SSL certificate. To renew a certificate and maintain its existing domain mappings, update certificate_data with a new certificate. The new certificate must be applicable to the same domains as the original certificate. The certificate display_name may also be updated.", + "httpMethod": "PATCH", "parameterOrder": [ "appsId", "authorizedCertificatesId" ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], + "response": { + "$ref": "AuthorizedCertificate" + }, "parameters": { + "authorizedCertificatesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, "updateMask": { "location": "query", "description": "Standard field mask for the set of fields to be updated. Updates are only supported on the certificate_raw_data and display_name fields.", @@ -634,23 +242,14 @@ "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/authorizedCertificates/12345.", "required": true, "type": "string" - }, - "authorizedCertificatesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" } }, - "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "path": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}", - "id": "appengine.apps.authorizedCertificates.patch" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/authorizedCertificates/{authorizedCertificatesId}" }, "create": { - "description": "Uploads the specified SSL certificate.", - "request": { - "$ref": "AuthorizedCertificate" - }, "response": { "$ref": "AuthorizedCertificate" }, @@ -671,17 +270,205 @@ }, "flatPath": "v1beta/apps/{appsId}/authorizedCertificates", "path": "v1beta/apps/{appsId}/authorizedCertificates", - "id": "appengine.apps.authorizedCertificates.create" + "id": "appengine.apps.authorizedCertificates.create", + "description": "Uploads the specified SSL certificate.", + "request": { + "$ref": "AuthorizedCertificate" + } } } }, "services": { + "methods": { + "delete": { + "description": "Deletes the specified service and all enclosed versions.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}", + "path": "v1beta/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.delete" + }, + "list": { + "path": "v1beta/apps/{appsId}/services", + "id": "appengine.apps.services.list", + "description": "Lists all the services in the application.", + "response": { + "$ref": "ListServicesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta/apps/{appsId}/services" + }, + "get": { + "description": "Gets the current configuration of the specified service.", + "response": { + "$ref": "Service" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}", + "path": "v1beta/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.get" + }, + "patch": { + "request": { + "$ref": "Service" + }, + "description": "Updates the configuration of the specified service.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "PATCH", + "parameters": { + "migrateTraffic": { + "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", + "type": "boolean", + "location": "query" + }, + "updateMask": { + "location": "query", + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}", + "path": "v1beta/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.patch" + } + }, "resources": { "versions": { "methods": { + "delete": { + "description": "Deletes an existing Version resource.", + "httpMethod": "DELETE", + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "id": "appengine.apps.services.versions.delete", + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}" + }, "list": { - "description": "Lists the versions of a service.", - "httpMethod": "GET", "response": { "$ref": "ListVersionsResponse" }, @@ -689,22 +476,8 @@ "appsId", "servicesId" ], + "httpMethod": "GET", "parameters": { - "pageSize": { - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "view": { - "location": "query", - "enum": [ - "BASIC", - "FULL" - ], - "description": "Controls the set of fields returned in the List response.", - "type": "string" - }, "servicesId": { "description": "Part of `parent`. See documentation of `appsId`.", "required": true, @@ -712,15 +485,30 @@ "location": "path" }, "appsId": { - "location": "path", "description": "Part of `parent`. Name of the parent Service resource. Example: apps/myapp/services/default.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "pageToken": { - "location": "query", "description": "Continuation token for fetching the next page of results.", - "type": "string" + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "view": { + "description": "Controls the set of fields returned in the List response.", + "type": "string", + "location": "query", + "enum": [ + "BASIC", + "FULL" + ] } }, "scopes": [ @@ -729,10 +517,12 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions", + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions", "id": "appengine.apps.services.versions.list", - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions" + "description": "Lists the versions of a service." }, "get": { + "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", "httpMethod": "GET", "response": { "$ref": "Version" @@ -743,6 +533,21 @@ "versionsId" ], "parameters": { + "versionsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "view": { + "enum": [ + "BASIC", + "FULL" + ], + "description": "Controls the set of fields returned in the Get response.", + "type": "string", + "location": "query" + }, "servicesId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, @@ -754,21 +559,6 @@ "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", "required": true, "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "view": { - "enum": [ - "BASIC", - "FULL" - ], - "description": "Controls the set of fields returned in the Get response.", - "type": "string", - "location": "query" } }, "scopes": [ @@ -778,14 +568,9 @@ ], "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", "id": "appengine.apps.services.versions.get", - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource." + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}" }, "patch": { - "request": { - "$ref": "Version" - }, - "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.", "response": { "$ref": "Operation" }, @@ -796,6 +581,12 @@ ], "httpMethod": "PATCH", "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", + "required": true, + "type": "string" + }, "versionsId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", @@ -803,22 +594,16 @@ "type": "string" }, "updateMask": { - "location": "query", "description": "Standard field mask for the set of fields to be updated.", "format": "google-fieldmask", - "type": "string" + "type": "string", + "location": "query" }, "servicesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", - "required": true, - "type": "string" } }, "scopes": [ @@ -826,13 +611,19 @@ ], "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "id": "appengine.apps.services.versions.patch" - }, - "create": { - "description": "Deploys code and resource files to a new version.", + "id": "appengine.apps.services.versions.patch", "request": { "$ref": "Version" }, + "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.min_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.max_total_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cool_down_period_sec (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment.\nautomatic_scaling.cpu_utilization.target_utilization (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine Flexible environment." + }, + "create": { + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions", + "id": "appengine.apps.services.versions.create", + "request": { + "$ref": "Version" + }, + "description": "Deploys code and resource files to a new version.", "response": { "$ref": "Operation" }, @@ -841,87 +632,55 @@ "servicesId" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { - "appsId": { - "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.", - "required": true, - "type": "string", - "location": "path" - }, "servicesId": { "location": "path", "description": "Part of `parent`. See documentation of `appsId`.", "required": true, "type": "string" - } - }, - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions", - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions", - "id": "appengine.apps.services.versions.create" - }, - "delete": { - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "id": "appengine.apps.services.versions.delete", - "description": "Deletes an existing Version resource.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "versionsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" }, "appsId": { "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", + "description": "Part of `parent`. Name of the parent resource to create this version under. Example: apps/myapp/services/default.", "required": true, "type": "string" } }, - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions" } }, "resources": { "instances": { "methods": { "delete": { - "description": "Stops a running instance.", - "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "appsId", "servicesId", "versionsId", "instancesId" ], - "response": { - "$ref": "Operation" - }, + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { - "servicesId": { - "location": "path", + "versionsId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" + "type": "string", + "location": "path" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" }, "appsId": { "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", @@ -930,29 +689,18 @@ "location": "path" }, "instancesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "versionsId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", "id": "appengine.apps.services.versions.instances.delete", - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}" + "description": "Stops a running instance." }, "list": { - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", - "id": "appengine.apps.services.versions.instances.list", - "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", "response": { "$ref": "ListInstancesResponse" }, @@ -963,12 +711,6 @@ ], "httpMethod": "GET", "parameters": { - "servicesId": { - "description": "Part of `parent`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, "appsId": { "location": "path", "description": "Part of `parent`. Name of the parent Version resource. Example: apps/myapp/services/default/versions/v1.", @@ -991,6 +733,12 @@ "description": "Part of `parent`. See documentation of `appsId`.", "required": true, "type": "string" + }, + "servicesId": { + "description": "Part of `parent`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" } }, "scopes": [ @@ -998,11 +746,12 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances" + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", + "id": "appengine.apps.services.versions.instances.list", + "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)." }, "get": { - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "id": "appengine.apps.services.versions.instances.get", "description": "Gets instance information.", "response": { "$ref": "Instance" @@ -1045,230 +794,80 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}" + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", + "id": "appengine.apps.services.versions.instances.get" }, "debug": { - "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", - "id": "appengine.apps.services.versions.instances.debug", - "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", - "request": { - "$ref": "DebugInstanceRequest" - }, - "response": { - "$ref": "Operation" - }, + "httpMethod": "POST", "parameterOrder": [ "appsId", "servicesId", "versionsId", "instancesId" ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], + "response": { + "$ref": "Operation" + }, "parameters": { - "servicesId": { + "versionsId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string", "location": "path" }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", + "required": true, + "type": "string" + }, "instancesId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string", "location": "path" - }, - "versionsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" } }, - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", + "id": "appengine.apps.services.versions.instances.debug", + "path": "v1beta/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", + "request": { + "$ref": "DebugInstanceRequest" + }, + "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment." } } } } } - }, - "methods": { - "list": { - "description": "Lists all the services in the application.", - "httpMethod": "GET", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "ListServicesResponse" - }, - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta/apps/{appsId}/services", - "id": "appengine.apps.services.list", - "path": "v1beta/apps/{appsId}/services" - }, - "get": { - "response": { - "$ref": "Service" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "GET", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - }, - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}", - "path": "v1beta/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.get", - "description": "Gets the current configuration of the specified service." - }, - "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "appsId", - "servicesId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - }, - "migrateTraffic": { - "location": "query", - "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services#shardby) field in the Service resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", - "type": "boolean" - }, - "updateMask": { - "location": "query", - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string" - }, - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.patch", - "path": "v1beta/apps/{appsId}/services/{servicesId}", - "request": { - "$ref": "Service" - }, - "description": "Updates the configuration of the specified service." - }, - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta/apps/{appsId}/services/{servicesId}", - "path": "v1beta/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.delete", - "description": "Deletes the specified service and all enclosed versions." - } } }, "authorizedDomains": { "methods": { "list": { - "id": "appengine.apps.authorizedDomains.list", - "path": "v1beta/apps/{appsId}/authorizedDomains", - "description": "Lists all domains the user is authorized to administer.", - "httpMethod": "GET", "response": { "$ref": "ListAuthorizedDomainsResponse" }, "parameterOrder": [ "appsId" ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - }, "appsId": { "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", "required": true, @@ -1276,36 +875,41 @@ "location": "path" }, "pageToken": { + "location": "query", "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer" } }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta/apps/{appsId}/authorizedDomains" + "flatPath": "v1beta/apps/{appsId}/authorizedDomains", + "path": "v1beta/apps/{appsId}/authorizedDomains", + "id": "appengine.apps.authorizedDomains.list", + "description": "Lists all domains the user is authorized to administer." } } }, "operations": { "methods": { "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "appsId" ], - "httpMethod": "GET", "parameters": { "pageSize": { + "location": "query", "description": "The standard list page size.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" }, "filter": { "location": "query", @@ -1313,10 +917,10 @@ "type": "string" }, "appsId": { - "location": "path", "description": "Part of `name`. The name of the operation's parent resource.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "pageToken": { "location": "query", @@ -1330,11 +934,12 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta/apps/{appsId}/operations", - "path": "v1beta/apps/{appsId}/operations", "id": "appengine.apps.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." + "path": "v1beta/apps/{appsId}/operations" }, "get": { + "path": "v1beta/apps/{appsId}/operations/{operationsId}", + "id": "appengine.apps.operations.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.", "response": { "$ref": "Operation" @@ -1363,49 +968,416 @@ "type": "string" } }, - "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}", - "path": "v1beta/apps/{appsId}/operations/{operationsId}", - "id": "appengine.apps.operations.get" + "flatPath": "v1beta/apps/{appsId}/operations/{operationsId}" + } + } + }, + "domainMappings": { + "methods": { + "delete": { + "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.delete", + "description": "Deletes the specified domain mapping. A user must be authorized to administer the associated domain in order to delete a DomainMapping resource.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "domainMappingsId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "domainMappingsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to delete. Example: apps/myapp/domainMappings/example.com.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}" + }, + "list": { + "description": "Lists the domain mappings on an application.", + "response": { + "$ref": "ListDomainMappingsResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta/apps/{appsId}/domainMappings", + "path": "v1beta/apps/{appsId}/domainMappings", + "id": "appengine.apps.domainMappings.list" + }, + "get": { + "description": "Gets the specified domain mapping.", + "response": { + "$ref": "DomainMapping" + }, + "parameterOrder": [ + "appsId", + "domainMappingsId" + ], + "httpMethod": "GET", + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/domainMappings/example.com.", + "required": true, + "type": "string", + "location": "path" + }, + "domainMappingsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", + "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.get" + }, + "patch": { + "path": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}", + "id": "appengine.apps.domainMappings.patch", + "description": "Updates the specified domain mapping. To map an SSL certificate to a domain mapping, update certificate_id to point to an AuthorizedCertificate resource. A user must be authorized to administer the associated domain in order to update a DomainMapping resource.", + "request": { + "$ref": "DomainMapping" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "domainMappingsId" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "domainMappingsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "updateMask": { + "location": "query", + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/domainMappings/example.com.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta/apps/{appsId}/domainMappings/{domainMappingsId}" + }, + "create": { + "description": "Maps a domain to an application. A user must be authorized to administer a domain in order to map it to an application. For a list of available authorized domains, see AuthorizedDomains.ListAuthorizedDomains.", + "request": { + "$ref": "DomainMapping" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the parent Application resource. Example: apps/myapp.", + "required": true, + "type": "string" + }, + "overrideStrategy": { + "enum": [ + "UNSPECIFIED_DOMAIN_OVERRIDE_STRATEGY", + "STRICT", + "OVERRIDE" + ], + "description": "Whether the domain creation should override any existing mappings for this domain. By default, overrides are rejected.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1beta/apps/{appsId}/domainMappings", + "path": "v1beta/apps/{appsId}/domainMappings", + "id": "appengine.apps.domainMappings.create" + } + } + }, + "firewall": { + "resources": { + "ingressRules": { + "methods": { + "create": { + "request": { + "$ref": "FirewallRule" + }, + "description": "Creates a firewall rule for the application.", + "httpMethod": "POST", + "parameterOrder": [ + "appsId" + ], + "response": { + "$ref": "FirewallRule" + }, + "parameters": { + "appsId": { + "description": "Part of `parent`. Name of the parent Firewall collection in which to create a new rule. Example: apps/myapp/firewall/ingressRules.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules", + "id": "appengine.apps.firewall.ingressRules.create", + "path": "v1beta/apps/{appsId}/firewall/ingressRules" + }, + "patch": { + "response": { + "$ref": "FirewallRule" + }, + "parameterOrder": [ + "appsId", + "ingressRulesId" + ], + "httpMethod": "PATCH", + "parameters": { + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the Firewall resource to update. Example: apps/myapp/firewall/ingressRules/100.", + "required": true, + "type": "string" + }, + "ingressRulesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "id": "appengine.apps.firewall.ingressRules.patch", + "request": { + "$ref": "FirewallRule" + }, + "description": "Updates the specified firewall rule." + }, + "get": { + "response": { + "$ref": "FirewallRule" + }, + "parameterOrder": [ + "appsId", + "ingressRulesId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the Firewall resource to retrieve. Example: apps/myapp/firewall/ingressRules/100.", + "required": true, + "type": "string" + }, + "ingressRulesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "id": "appengine.apps.firewall.ingressRules.get", + "description": "Gets the specified firewall rule." + }, + "batchUpdate": { + "response": { + "$ref": "BatchUpdateIngressRulesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the Firewall collection to set. Example: apps/myapp/firewall/ingressRules.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate", + "path": "v1beta/apps/{appsId}/firewall/ingressRules:batchUpdate", + "id": "appengine.apps.firewall.ingressRules.batchUpdate", + "request": { + "$ref": "BatchUpdateIngressRulesRequest" + }, + "description": "Replaces the entire firewall ruleset in one bulk operation. This overrides and replaces the rules of an existing firewall with the new rules.If the final rule does not match traffic with the '*' wildcard IP range, then an \"allow all\" rule is explicitly added to the end of the list." + }, + "delete": { + "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "path": "v1beta/apps/{appsId}/firewall/ingressRules/{ingressRulesId}", + "id": "appengine.apps.firewall.ingressRules.delete", + "description": "Deletes the specified firewall rule.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "appsId", + "ingressRulesId" + ], + "httpMethod": "DELETE", + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the Firewall resource to delete. Example: apps/myapp/firewall/ingressRules/100.", + "required": true, + "type": "string", + "location": "path" + }, + "ingressRulesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "flatPath": "v1beta/apps/{appsId}/firewall/ingressRules", + "path": "v1beta/apps/{appsId}/firewall/ingressRules", + "id": "appengine.apps.firewall.ingressRules.list", + "description": "Lists the firewall rules of an application.", + "response": { + "$ref": "ListIngressRulesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "matchingAddress": { + "description": "A valid IP Address. If set, only rules matching this address will be returned. The first returned rule will be the rule that fires on requests from this IP.", + "type": "string", + "location": "query" + }, + "appsId": { + "location": "path", + "description": "Part of `parent`. Name of the Firewall collection to retrieve. Example: apps/myapp/firewall/ingressRules.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "Continuation token for fetching the next page of results.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + } + } } } } }, "methods": { - "repair": { - "id": "appengine.apps.repair", - "path": "v1beta/apps/{appsId}:repair", - "request": { - "$ref": "RepairApplicationRequest" - }, - "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.", - "httpMethod": "POST", - "parameterOrder": [ - "appsId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the application to repair. Example: apps/myapp", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta/apps/{appsId}:repair" - }, "get": { - "httpMethod": "GET", + "description": "Gets information about an application.", "response": { "$ref": "Application" }, "parameterOrder": [ "appsId" ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { "appsId": { "description": "Part of `name`. Name of the Application resource to get. Example: apps/myapp.", @@ -1414,21 +1386,11 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], "flatPath": "v1beta/apps/{appsId}", - "id": "appengine.apps.get", "path": "v1beta/apps/{appsId}", - "description": "Gets information about an application." + "id": "appengine.apps.get" }, "patch": { - "request": { - "$ref": "Application" - }, - "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application.", "response": { "$ref": "Operation" }, @@ -1438,16 +1400,16 @@ "httpMethod": "PATCH", "parameters": { "updateMask": { - "location": "query", "description": "Standard field mask for the set of fields to be updated.", "format": "google-fieldmask", - "type": "string" + "type": "string", + "location": "query" }, "appsId": { + "location": "path", "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ @@ -1455,39 +1417,128 @@ ], "flatPath": "v1beta/apps/{appsId}", "path": "v1beta/apps/{appsId}", - "id": "appengine.apps.patch" + "id": "appengine.apps.patch", + "request": { + "$ref": "Application" + }, + "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain - Google authentication domain for controlling user access to the application.\ndefault_cookie_expiration - Cookie expiration policy for the application." }, "create": { - "path": "v1beta/apps", - "id": "appengine.apps.create", "request": { "$ref": "Application" }, "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).", + "httpMethod": "POST", + "parameterOrder": [], "response": { "$ref": "Operation" }, - "parameterOrder": [], - "httpMethod": "POST", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1beta/apps" + "flatPath": "v1beta/apps", + "id": "appengine.apps.create", + "path": "v1beta/apps" + }, + "repair": { + "path": "v1beta/apps/{appsId}:repair", + "id": "appengine.apps.repair", + "description": "Recreates the required App Engine features for the specified App Engine application, for example a Cloud Storage bucket or App Engine service account. Use this method if you receive an error message about a missing feature, for example, Error retrieving the App Engine service account.", + "request": { + "$ref": "RepairApplicationRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the application to repair. Example: apps/myapp", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta/apps/{appsId}:repair" } } } }, "parameters": { + "alt": { + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "$.xgafv": { "enumDescriptions": [ @@ -1506,920 +1557,9 @@ "location": "query", "description": "JSONP", "type": "string" - }, - "alt": { - "type": "string", - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" } }, "schemas": { - "Resources": { - "description": "Machine resources for a version.", - "type": "object", - "properties": { - "volumes": { - "description": "User specified volumes.", - "type": "array", - "items": { - "$ref": "Volume" - } - }, - "diskGb": { - "description": "Disk size (GB) needed.", - "format": "double", - "type": "number" - }, - "cpu": { - "description": "Number of CPU cores needed.", - "format": "double", - "type": "number" - }, - "memoryGb": { - "description": "Memory (GB) needed.", - "format": "double", - "type": "number" - } - }, - "id": "Resources" - }, - "Deployment": { - "description": "Code and application artifacts used to deploy a version to App Engine.", - "type": "object", - "properties": { - "zip": { - "description": "The zip file for this deployment, if this is a zip deployment.", - "$ref": "ZipInfo" - }, - "container": { - "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment.", - "$ref": "ContainerInfo" - }, - "build": { - "$ref": "BuildInfo", - "description": "Google Cloud Container Builder build information." - }, - "files": { - "additionalProperties": { - "$ref": "FileInfo" - }, - "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", - "type": "object" - }, - "cloudBuildOptions": { - "$ref": "CloudBuildOptions", - "description": "Options for any Google Cloud Container Builder builds created as a part of this deployment.Note that this is orthogonal to the build parameter, where the deployment depends on an already existing cloud build. These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip." - } - }, - "id": "Deployment" - }, - "BatchUpdateIngressRulesResponse": { - "description": "Response message for Firewall.UpdateAllIngressRules.", - "type": "object", - "properties": { - "ingressRules": { - "description": "The full list of ingress FirewallRules for this application.", - "type": "array", - "items": { - "$ref": "FirewallRule" - } - } - }, - "id": "BatchUpdateIngressRulesResponse" - }, - "Volume": { - "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.", - "type": "object", - "properties": { - "sizeGb": { - "description": "Volume size in gigabytes.", - "format": "double", - "type": "number" - }, - "name": { - "description": "Unique name for the volume.", - "type": "string" - }, - "volumeType": { - "description": "Underlying volume type, e.g. 'tmpfs'.", - "type": "string" - } - }, - "id": "Volume" - }, - "ManagedCertificate": { - "properties": { - "lastRenewalTime": { - "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "status": { - "enumDescriptions": [ - "", - "Certificate was successfully obtained and inserted into the serving system.", - "Certificate is under active attempts to acquire or renew.", - "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.", - "All renewal attempts have been exhausted, likely due to an invalid DNS setup.", - "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.", - "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving." - ], - "enum": [ - "MANAGEMENT_STATUS_UNSPECIFIED", - "OK", - "PENDING", - "FAILED_RETRYING_NOT_VISIBLE", - "FAILED_PERMANENT", - "FAILED_RETRYING_CAA_FORBIDDEN", - "FAILED_RETRYING_CAA_CHECKING" - ], - "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly", - "type": "string" - } - }, - "id": "ManagedCertificate", - "description": "A certificate managed by App Engine.", - "type": "object" - }, - "ListInstancesResponse": { - "properties": { - "instances": { - "description": "The instances belonging to the requested version.", - "type": "array", - "items": { - "$ref": "Instance" - } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "id": "ListInstancesResponse", - "description": "Response message for Instances.ListInstances.", - "type": "object" - }, - "ListDomainMappingsResponse": { - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "domainMappings": { - "description": "The domain mappings for the application.", - "type": "array", - "items": { - "$ref": "DomainMapping" - } - } - }, - "id": "ListDomainMappingsResponse", - "description": "Response message for DomainMappings.ListDomainMappings.", - "type": "object" - }, - "OperationMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object", - "properties": { - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Alpha" - }, - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - } - }, - "id": "OperationMetadataV1Alpha" - }, - "UrlDispatchRule": { - "description": "Rules to match an HTTP request and dispatch that request to a service.", - "type": "object", - "properties": { - "domain": { - "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", - "type": "string" - }, - "service": { - "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.", - "type": "string" - }, - "path": { - "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.", - "type": "string" - } - }, - "id": "UrlDispatchRule" - }, - "ListVersionsResponse": { - "properties": { - "versions": { - "description": "The versions belonging to the requested service.", - "type": "array", - "items": { - "$ref": "Version" - } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "id": "ListVersionsResponse", - "description": "Response message for Versions.ListVersions.", - "type": "object" - }, - "ListAuthorizedDomainsResponse": { - "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "domains": { - "description": "The authorized domains belonging to the user.", - "type": "array", - "items": { - "$ref": "AuthorizedDomain" - } - } - }, - "id": "ListAuthorizedDomainsResponse" - }, - "ApiEndpointHandler": { - "description": "Uses Google Cloud Endpoints to handle requests.", - "type": "object", - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "id": "ApiEndpointHandler" - }, - "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "DomainMapping": { - "description": "A domain serving an App Engine application.", - "type": "object", - "properties": { - "id": { - "description": "Relative name of the domain serving the application. Example: example.com.", - "type": "string" - }, - "resourceRecords": { - "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly", - "type": "array", - "items": { - "$ref": "ResourceRecord" - } - }, - "name": { - "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", - "type": "string" - }, - "sslSettings": { - "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL.", - "$ref": "SslSettings" - } - }, - "id": "DomainMapping" - }, - "ZipInfo": { - "description": "The zip file information for a zip deployment.", - "type": "object", - "properties": { - "filesCount": { - "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.", - "format": "int32", - "type": "integer" - }, - "sourceUrl": { - "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", - "type": "string" - } - }, - "id": "ZipInfo" - }, - "AutomaticScaling": { - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", - "type": "object", - "properties": { - "minPendingLatency": { - "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "requestUtilization": { - "description": "Target scaling by request utilization.", - "$ref": "RequestUtilization" - }, - "maxIdleInstances": { - "description": "Maximum number of idle instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "standardSchedulerSettings": { - "description": "Scheduler settings for standard environment.", - "$ref": "StandardSchedulerSettings" - }, - "minIdleInstances": { - "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.", - "format": "int32", - "type": "integer" - }, - "maxTotalInstances": { - "description": "Maximum number of instances that should be started to handle requests.", - "format": "int32", - "type": "integer" - }, - "minTotalInstances": { - "description": "Minimum number of instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "networkUtilization": { - "$ref": "NetworkUtilization", - "description": "Target scaling by network usage." - }, - "maxConcurrentRequests": { - "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", - "format": "int32", - "type": "integer" - }, - "coolDownPeriod": { - "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.", - "format": "google-duration", - "type": "string" - }, - "maxPendingLatency": { - "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "cpuUtilization": { - "$ref": "CpuUtilization", - "description": "Target scaling by CPU usage." - }, - "diskUtilization": { - "description": "Target scaling by disk usage.", - "$ref": "DiskUtilization" - } - }, - "id": "AutomaticScaling" - }, - "AuthorizedCertificate": { - "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", - "type": "object", - "properties": { - "domainMappingsCount": { - "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "domainNames": { - "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly", - "type": "string" - }, - "displayName": { - "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.", - "type": "string" - }, - "certificateRawData": { - "$ref": "CertificateRawData", - "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority." - }, - "managedCertificate": { - "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly", - "$ref": "ManagedCertificate" - }, - "visibleDomainMappings": { - "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "expireTime": { - "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly", - "type": "string" - } - }, - "id": "AuthorizedCertificate" - }, - "ResourceRecord": { - "description": "A DNS resource record.", - "type": "object", - "properties": { - "name": { - "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.", - "type": "string" - }, - "type": { - "enum": [ - "A", - "AAAA", - "CNAME" - ], - "description": "Resource record type. Example: AAAA.", - "type": "string", - "enumDescriptions": [ - "An A resource record. Data is an IPv4 address.", - "An AAAA resource record. Data is an IPv6 address.", - "A CNAME resource record. Data is a domain name to be aliased." - ] - }, - "rrdata": { - "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).", - "type": "string" - } - }, - "id": "ResourceRecord" - }, - "Library": { - "description": "Third-party Python runtime library that is required by the application.", - "type": "object", - "properties": { - "name": { - "description": "Name of the library. Example: \"django\".", - "type": "string" - }, - "version": { - "description": "Version of the library to select, or \"latest\".", - "type": "string" - } - }, - "id": "Library" - }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "type": "object", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Location" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListLocationsResponse" - }, - "ContainerInfo": { - "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", - "type": "object", - "properties": { - "image": { - "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"", - "type": "string" - } - }, - "id": "ContainerInfo" - }, - "RequestUtilization": { - "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.", - "type": "object", - "properties": { - "targetRequestCountPerSecond": { - "description": "Target requests per second.", - "format": "int32", - "type": "integer" - }, - "targetConcurrentRequests": { - "description": "Target number of concurrent requests.", - "format": "int32", - "type": "integer" - } - }, - "id": "RequestUtilization" - }, - "EndpointsApiService": { - "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", - "type": "object", - "properties": { - "name": { - "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", - "type": "string" - }, - "configId": { - "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.", - "type": "string" - } - }, - "id": "EndpointsApiService" - }, - "UrlMap": { - "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", - "type": "object", - "properties": { - "redirectHttpResponseCode": { - "enumDescriptions": [ - "Not specified. 302 is assumed.", - "301 Moved Permanently code.", - "302 Moved Temporarily code.", - "303 See Other code.", - "307 Temporary Redirect code." - ], - "enum": [ - "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", - "REDIRECT_HTTP_RESPONSE_CODE_301", - "REDIRECT_HTTP_RESPONSE_CODE_302", - "REDIRECT_HTTP_RESPONSE_CODE_303", - "REDIRECT_HTTP_RESPONSE_CODE_307" - ], - "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", - "type": "string" - }, - "securityLevel": { - "description": "Security (HTTPS) enforcement for this URL.", - "type": "string", - "enumDescriptions": [ - "Not specified.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", - "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", - "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." - ], - "enum": [ - "SECURE_UNSPECIFIED", - "SECURE_DEFAULT", - "SECURE_NEVER", - "SECURE_OPTIONAL", - "SECURE_ALWAYS" - ] - }, - "authFailAction": { - "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "type": "string", - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with a 401 HTTP status code and an error message." - ], - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ] - }, - "script": { - "description": "Executes a script to handle the request that matches this URL pattern.", - "$ref": "ScriptHandler" - }, - "urlRegex": { - "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", - "type": "string" - }, - "login": { - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ], - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ], - "description": "Level of login required to access this resource.", - "type": "string" - }, - "apiEndpoint": { - "description": "Uses API Endpoints to handle requests.", - "$ref": "ApiEndpointHandler" - }, - "staticFiles": { - "description": "Returns the contents of a file, such as an image, as the response.", - "$ref": "StaticFilesHandler" - } - }, - "id": "UrlMap" - }, - "ApiConfigHandler": { - "properties": { - "script": { - "description": "Path to the script from the application root directory.", - "type": "string" - }, - "login": { - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ], - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ], - "description": "Level of login required to access this resource. Defaults to optional.", - "type": "string" - }, - "url": { - "description": "URL to serve the endpoint at.", - "type": "string" - }, - "securityLevel": { - "enumDescriptions": [ - "Not specified.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", - "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", - "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." - ], - "enum": [ - "SECURE_UNSPECIFIED", - "SECURE_DEFAULT", - "SECURE_NEVER", - "SECURE_OPTIONAL", - "SECURE_ALWAYS" - ], - "description": "Security (HTTPS) enforcement for this URL.", - "type": "string" - }, - "authFailAction": { - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with a 401 HTTP status code and an error message." - ], - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ], - "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "type": "string" - } - }, - "id": "ApiConfigHandler", - "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", - "type": "object" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "type": "object", - "properties": { - "done": { - "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", - "type": "boolean" - }, - "response": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "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 operations/some/unique/name.", - "type": "string" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "id": "Operation" - }, - "StaticFilesHandler": { - "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", - "type": "object", - "properties": { - "expiration": { - "description": "Time a static file served by this handler should be cached by web proxies and browsers.", - "format": "google-duration", - "type": "string" - }, - "httpHeaders": { - "additionalProperties": { - "type": "string" - }, - "description": "HTTP headers to use for all responses from these URLs.", - "type": "object" - }, - "applicationReadable": { - "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", - "type": "boolean" - }, - "uploadPathRegex": { - "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", - "type": "string" - }, - "path": { - "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", - "type": "string" - }, - "mimeType": { - "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.", - "type": "string" - }, - "requireMatchingFile": { - "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", - "type": "boolean" - } - }, - "id": "StaticFilesHandler" - }, - "DiskUtilization": { - "properties": { - "targetReadBytesPerSecond": { - "description": "Target bytes read per second.", - "format": "int32", - "type": "integer" - }, - "targetReadOpsPerSecond": { - "description": "Target ops read per seconds.", - "format": "int32", - "type": "integer" - }, - "targetWriteOpsPerSecond": { - "description": "Target ops written per second.", - "format": "int32", - "type": "integer" - }, - "targetWriteBytesPerSecond": { - "description": "Target bytes written per second.", - "format": "int32", - "type": "integer" - } - }, - "id": "DiskUtilization", - "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.", - "type": "object" - }, - "BasicScaling": { - "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", - "type": "object", - "properties": { - "idleTimeout": { - "description": "Duration of time after the last request that an instance must wait before the instance is shut down.", - "format": "google-duration", - "type": "string" - }, - "maxInstances": { - "description": "Maximum number of instances to create for this version.", - "format": "int32", - "type": "integer" - } - }, - "id": "BasicScaling" - }, - "CpuUtilization": { - "description": "Target scaling by CPU usage.", - "type": "object", - "properties": { - "aggregationWindowLength": { - "description": "Period of time over which CPU utilization is calculated.", - "format": "google-duration", - "type": "string" - }, - "targetUtilization": { - "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.", - "format": "double", - "type": "number" - } - }, - "id": "CpuUtilization" - }, - "IdentityAwareProxy": { - "properties": { - "oauth2ClientSecretSha256": { - "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly", - "type": "string" - }, - "enabled": { - "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.", - "type": "boolean" - }, - "oauth2ClientSecret": { - "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly", - "type": "string" - }, - "oauth2ClientId": { - "description": "OAuth2 client ID to use for the authentication flow.", - "type": "string" - } - }, - "id": "IdentityAwareProxy", - "description": "Identity-Aware Proxy", - "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", "type": "object", @@ -2447,6 +1587,29 @@ }, "id": "Status" }, + "IdentityAwareProxy": { + "description": "Identity-Aware Proxy", + "type": "object", + "properties": { + "oauth2ClientSecret": { + "description": "OAuth2 client secret to use for the authentication flow.For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly", + "type": "string" + }, + "oauth2ClientId": { + "description": "OAuth2 client ID to use for the authentication flow.", + "type": "string" + }, + "oauth2ClientSecretSha256": { + "description": "Hex-encoded SHA-256 hash of the client secret.@OutputOnly", + "type": "string" + }, + "enabled": { + "description": "Whether the serving infrastructure will authenticate and authorize all incoming requests.If true, the oauth2_client_id and oauth2_client_secret fields must be non-empty.", + "type": "boolean" + } + }, + "id": "IdentityAwareProxy" + }, "ManualScaling": { "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", "type": "object", @@ -2463,13 +1626,13 @@ "description": "Metadata for the given google.cloud.location.Location.", "type": "object", "properties": { - "flexibleEnvironmentAvailable": { - "description": "App Engine Flexible Environment is available in the given location.@OutputOnly", - "type": "boolean" - }, "standardEnvironmentAvailable": { "description": "App Engine Standard Environment is available in the given location.@OutputOnly", "type": "boolean" + }, + "flexibleEnvironmentAvailable": { + "description": "App Engine Flexible Environment is available in the given location.@OutputOnly", + "type": "boolean" } }, "id": "LocationMetadata" @@ -2478,24 +1641,22 @@ "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle tasks such as backend data analysis or API requests from mobile devices. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.", "type": "object", "properties": { + "name": { + "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, "split": { - "$ref": "TrafficSplit", - "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service." + "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the service.", + "$ref": "TrafficSplit" }, "id": { "description": "Relative name of the service within the application. Example: default.@OutputOnly", "type": "string" - }, - "name": { - "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" } }, "id": "Service" }, "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", @@ -2509,12 +1670,16 @@ } } }, - "id": "ListOperationsResponse" + "id": "ListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object" }, "FirewallRule": { - "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.", - "type": "object", "properties": { + "description": { + "description": "An optional string description of this rule. This field has a maximum length of 100 characters.", + "type": "string" + }, "sourceRange": { "description": "IP address or range, defined using CIDR notation, of requests that this rule applies to. You can use the wildcard character \"*\" to match all IPs equivalent to \"0/0\" and \"::/0\" together. Examples: 192.168.1.1 or 192.168.0.0/16 or 2001:db8::/32 or 2001:0db8:0000:0042:0000:8a2e:0370:7334.\u003cp\u003eTruncation will be silently performed on addresses which are not properly truncated. For example, 1.2.3.4/24 is accepted as the same address as 1.2.3.0/24. Similarly, for IPv6, 2001:db8::1/32 is accepted as the same address as 2001:db8::/32.", "type": "string" @@ -2525,6 +1690,8 @@ "type": "integer" }, "action": { + "description": "The action to take on matched requests.", + "type": "string", "enumDescriptions": [ "", "Matching requests are allowed.", @@ -2534,34 +1701,15 @@ "UNSPECIFIED_ACTION", "ALLOW", "DENY" - ], - "description": "The action to take on matched requests.", - "type": "string" - }, - "description": { - "description": "An optional string description of this rule. This field has a maximum length of 100 characters.", - "type": "string" + ] } }, - "id": "FirewallRule" + "id": "FirewallRule", + "description": "A single firewall rule that is evaluated against incoming traffic and provides an action to take on matched requests.", + "type": "object" }, "OperationMetadata": { - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object", "properties": { - "insertTime": { - "description": "Timestamp that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly", - "type": "string" - }, "method": { "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly", "type": "string" @@ -2574,9 +1722,24 @@ "operationType": { "description": "Type of this operation. Deprecated, use method field instead. Example: \"create_version\".@OutputOnly", "type": "string" + }, + "insertTime": { + "description": "Timestamp that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" } }, - "id": "OperationMetadata" + "id": "OperationMetadata", + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object" }, "ListAuthorizedCertificatesResponse": { "description": "Response message for AuthorizedCertificates.ListAuthorizedCertificates.", @@ -2597,70 +1760,63 @@ "id": "ListAuthorizedCertificatesResponse" }, "CreateVersionMetadataV1Beta": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.", - "type": "object", "properties": { "cloudBuildId": { "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", "type": "string" } }, - "id": "CreateVersionMetadataV1Beta" + "id": "CreateVersionMetadataV1Beta", + "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.", + "type": "object" }, "FeatureSettings": { "description": "The feature specific settings to be used in the application. These define behaviors that are user configurable.", "type": "object", "properties": { - "splitHealthChecks": { - "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.", - "type": "boolean" - }, "useContainerOptimizedOs": { "description": "If true, use Container-Optimized OS (https://cloud.google.com/container-optimized-os/) base image for VMs, rather than a base Debian image.", "type": "boolean" + }, + "splitHealthChecks": { + "description": "Boolean value indicating if split health checks should be used instead of the legacy health checks. At an app.yaml level, this means defaulting to 'readiness_check' and 'liveness_check' values instead of 'health_check' ones. Once the legacy 'health_check' behavior is deprecated, and this value is always true, this setting can be removed.", + "type": "boolean" } }, "id": "FeatureSettings" }, - "OperationMetadataV1": { - "description": "Metadata for the given google.longrunning.Operation.", + "ErrorHandler": { + "description": "Custom static error page to be served when an error occurs.", "type": "object", "properties": { - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", + "errorCode": { + "enumDescriptions": [ + "Not specified. ERROR_CODE_DEFAULT is assumed.", + "All other error types.", + "Application has exceeded a resource quota.", + "Client blocked by the application's Denial of Service protection configuration.", + "Deadline reached before the application responds." + ], + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "ERROR_CODE_DEFAULT", + "ERROR_CODE_OVER_QUOTA", + "ERROR_CODE_DOS_API_DENIAL", + "ERROR_CODE_TIMEOUT" + ], + "description": "Error condition this handler applies to.", "type": "string" }, - "user": { - "description": "User who requested this operation.@OutputOnly", + "mimeType": { + "description": "MIME type of file. Defaults to text/html.", "type": "string" }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", + "staticFile": { + "description": "Static file content to be served for this error.", "type": "string" } }, - "id": "OperationMetadataV1" + "id": "ErrorHandler" }, "SslSettings": { "properties": { @@ -2689,43 +1845,65 @@ "description": "SSL configuration for a DomainMapping resource.", "type": "object" }, - "ErrorHandler": { - "description": "Custom static error page to be served when an error occurs.", + "OperationMetadataV1": { + "description": "Metadata for the given google.longrunning.Operation.", "type": "object", "properties": { - "errorCode": { - "enum": [ - "ERROR_CODE_UNSPECIFIED", - "ERROR_CODE_DEFAULT", - "ERROR_CODE_OVER_QUOTA", - "ERROR_CODE_DOS_API_DENIAL", - "ERROR_CODE_TIMEOUT" - ], - "description": "Error condition this handler applies to.", - "type": "string", - "enumDescriptions": [ - "Not specified. ERROR_CODE_DEFAULT is assumed.", - "All other error types.", - "Application has exceeded a resource quota.", - "Client blocked by the application's Denial of Service protection configuration.", - "Deadline reached before the application responds." - ] - }, - "mimeType": { - "description": "MIME type of file. Defaults to text/html.", + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", "type": "string" }, - "staticFile": { - "description": "Static file content to be served for this error.", + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly", "type": "string" } }, - "id": "ErrorHandler" + "id": "OperationMetadataV1" }, "Application": { "description": "An Application resource contains the top-level configuration of an App Engine application.", "type": "object", "properties": { + "dispatchRules": { + "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly", + "type": "array", + "items": { + "$ref": "UrlDispatchRule" + } + }, + "gcrDomain": { + "description": "The Google Container Registry domain used for storing managed build docker images for this application.", + "type": "string" + }, + "name": { + "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", + "type": "string" + }, "id": { "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", "type": "string" @@ -2777,21 +1955,6 @@ "defaultBucket": { "description": "Google Cloud Storage bucket that can be used by this application to store content.@OutputOnly", "type": "string" - }, - "dispatchRules": { - "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent. Up to 20 dispatch rules can be supported.@OutputOnly", - "type": "array", - "items": { - "$ref": "UrlDispatchRule" - } - }, - "gcrDomain": { - "description": "The Google Container Registry domain used for storing managed build docker images for this application.", - "type": "string" - }, - "name": { - "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", - "type": "string" } }, "id": "Application" @@ -2826,23 +1989,31 @@ "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.", "type": "object", "properties": { - "qps": { - "description": "Average queries per second (QPS) over the last minute.@OutputOnly", - "format": "float", - "type": "number" + "appEngineRelease": { + "description": "App Engine release this instance is running on.@OutputOnly", + "type": "string" + }, + "vmName": { + "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" }, "vmId": { "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", "type": "string" }, - "vmZoneName": { - "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" + "qps": { + "description": "Average queries per second (QPS) over the last minute.@OutputOnly", + "format": "float", + "type": "number" }, "name": { "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly", "type": "string" }, + "vmZoneName": { + "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, "averageLatency": { "description": "Average latency (ms) over the last minute.@OutputOnly", "format": "int32", @@ -2852,31 +2023,13 @@ "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", "type": "string" }, - "memoryUsage": { - "description": "Total memory in use (bytes).@OutputOnly", - "format": "int64", - "type": "string" - }, "vmIp": { "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", "type": "string" }, - "vmStatus": { - "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "availability": { - "enumDescriptions": [ - "", - "", - "" - ], - "enum": [ - "UNSPECIFIED", - "RESIDENT", - "DYNAMIC" - ], - "description": "Availability of the instance.@OutputOnly", + "memoryUsage": { + "description": "Total memory in use (bytes).@OutputOnly", + "format": "int64", "type": "string" }, "errors": { @@ -2884,6 +2037,24 @@ "format": "int32", "type": "integer" }, + "availability": { + "enum": [ + "UNSPECIFIED", + "RESIDENT", + "DYNAMIC" + ], + "description": "Availability of the instance.@OutputOnly", + "type": "string", + "enumDescriptions": [ + "", + "", + "" + ] + }, + "vmStatus": { + "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, "startTime": { "description": "Time that this instance was started.@OutputOnly", "format": "google-datetime", @@ -2897,20 +2068,27 @@ "description": "Number of requests since this instance was started.@OutputOnly", "format": "int32", "type": "integer" - }, - "appEngineRelease": { - "description": "App Engine release this instance is running on.@OutputOnly", - "type": "string" - }, - "vmName": { - "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" } }, "id": "Instance" }, "LivenessCheck": { "properties": { + "timeout": { + "description": "Time before the check is considered failed.", + "format": "google-duration", + "type": "string" + }, + "failureThreshold": { + "description": "Number of consecutive failed checks required before considering the VM unhealthy.", + "format": "uint32", + "type": "integer" + }, + "initialDelay": { + "description": "The initial delay before starting to execute the checks.", + "format": "google-duration", + "type": "string" + }, "path": { "description": "The request path.", "type": "string" @@ -2928,21 +2106,6 @@ "description": "Interval between health checks.", "format": "google-duration", "type": "string" - }, - "timeout": { - "description": "Time before the check is considered failed.", - "format": "google-duration", - "type": "string" - }, - "failureThreshold": { - "description": "Number of consecutive failed checks required before considering the VM unhealthy.", - "format": "uint32", - "type": "integer" - }, - "initialDelay": { - "description": "The initial delay before starting to execute the checks.", - "format": "google-duration", - "type": "string" } }, "id": "LivenessCheck", @@ -2964,8 +2127,6 @@ "id": "BatchUpdateIngressRulesRequest" }, "CloudBuildOptions": { - "description": "Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.", - "type": "object", "properties": { "cloudBuildTimeout": { "description": "The Cloud Build timeout used as part of any dependent builds performed by version creation. Defaults to 10 minutes.", @@ -2977,12 +2138,17 @@ "type": "string" } }, - "id": "CloudBuildOptions" + "id": "CloudBuildOptions", + "description": "Options for the build operations performed as a part of the version deployment. Only applicable for App Engine flexible environment when creating a version using source code directly.", + "type": "object" }, "NetworkUtilization": { - "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.", - "type": "object", "properties": { + "targetSentBytesPerSecond": { + "description": "Target bytes sent per second.", + "format": "int32", + "type": "integer" + }, "targetSentPacketsPerSecond": { "description": "Target packets sent per second.", "format": "int32", @@ -2997,30 +2163,16 @@ "description": "Target packets received per second.", "format": "int32", "type": "integer" - }, - "targetSentBytesPerSecond": { - "description": "Target bytes sent per second.", - "format": "int32", - "type": "integer" } }, - "id": "NetworkUtilization" + "id": "NetworkUtilization", + "description": "Target scaling by network usage. Only applicable in the App Engine flexible environment.", + "type": "object" }, "Location": { "description": "A resource that represents Google Cloud Platform location.", "type": "object", "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", - "type": "string" - }, "locationId": { "description": "The canonical id for this location. For example: \"us-east1\".", "type": "string" @@ -3032,6 +2184,17 @@ }, "description": "Service-specific metadata. For example the available capacity at the given location.", "type": "object" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", + "type": "string" } }, "id": "Location" @@ -3040,21 +2203,6 @@ "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.", "type": "object", "properties": { - "restartThreshold": { - "description": "Number of consecutive failed health checks required before an instance is restarted.", - "format": "uint32", - "type": "integer" - }, - "healthyThreshold": { - "description": "Number of consecutive successful health checks required before receiving traffic.", - "format": "uint32", - "type": "integer" - }, - "checkInterval": { - "description": "Interval between health checks.", - "format": "google-duration", - "type": "string" - }, "timeout": { "description": "Time before the health check is considered failed.", "format": "google-duration", @@ -3072,6 +2220,21 @@ "host": { "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"", "type": "string" + }, + "healthyThreshold": { + "description": "Number of consecutive successful health checks required before receiving traffic.", + "format": "uint32", + "type": "integer" + }, + "restartThreshold": { + "description": "Number of consecutive failed health checks required before an instance is restarted.", + "format": "uint32", + "type": "integer" + }, + "checkInterval": { + "description": "Interval between health checks.", + "format": "google-duration", + "type": "string" } }, "id": "HealthCheck" @@ -3080,6 +2243,19 @@ "description": "Readiness checking configuration for VM instances. Unhealthy instances are removed from traffic rotation.", "type": "object", "properties": { + "path": { + "description": "The request path.", + "type": "string" + }, + "successThreshold": { + "description": "Number of consecutive successful checks required before receiving traffic.", + "format": "uint32", + "type": "integer" + }, + "host": { + "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"", + "type": "string" + }, "checkInterval": { "description": "Interval between health checks.", "format": "google-duration", @@ -3099,19 +2275,6 @@ "description": "A maximum time limit on application initialization, measured from moment the application successfully replies to a healthcheck until it is ready to serve traffic.", "format": "google-duration", "type": "string" - }, - "path": { - "description": "The request path.", - "type": "string" - }, - "successThreshold": { - "description": "Number of consecutive successful checks required before receiving traffic.", - "format": "uint32", - "type": "integer" - }, - "host": { - "description": "Host header to send when performing a HTTP Readiness check. Example: \"myapp.appspot.com\"", - "type": "string" } }, "id": "ReadinessCheck" @@ -3154,17 +2317,6 @@ }, "id": "StandardSchedulerSettings" }, - "CreateVersionMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", - "type": "object", - "properties": { - "cloudBuildId": { - "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", - "type": "string" - } - }, - "id": "CreateVersionMetadataV1Alpha" - }, "OperationMetadataV1Beta5": { "description": "Metadata for the given google.longrunning.Operation.", "type": "object", @@ -3194,10 +2346,66 @@ }, "id": "OperationMetadataV1Beta5" }, + "CreateVersionMetadataV1Alpha": { + "properties": { + "cloudBuildId": { + "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", + "type": "string" + } + }, + "id": "CreateVersionMetadataV1Alpha", + "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", + "type": "object" + }, "Version": { "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", "type": "object", "properties": { + "createTime": { + "description": "Time that this version was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "inboundServices": { + "enumDescriptions": [ + "Not specified.", + "Allows an application to receive mail.", + "Allows an application to receive email-bound notifications.", + "Allows an application to receive error stanzas.", + "Allows an application to receive instant messages.", + "Allows an application to receive user subscription POSTs.", + "Allows an application to receive a user's chat presence.", + "Registers an application for notifications when a client connects or disconnects from a channel.", + "Enables warmup requests." + ], + "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.", + "type": "array", + "items": { + "enum": [ + "INBOUND_SERVICE_UNSPECIFIED", + "INBOUND_SERVICE_MAIL", + "INBOUND_SERVICE_MAIL_BOUNCE", + "INBOUND_SERVICE_XMPP_ERROR", + "INBOUND_SERVICE_XMPP_MESSAGE", + "INBOUND_SERVICE_XMPP_SUBSCRIBE", + "INBOUND_SERVICE_XMPP_PRESENCE", + "INBOUND_SERVICE_CHANNEL_PRESENCE", + "INBOUND_SERVICE_WARMUP" + ], + "type": "string" + } + }, + "resources": { + "description": "Machine resources for this version. Only applicable for VM runtimes.", + "$ref": "Resources" + }, + "errorHandlers": { + "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.", + "type": "array", + "items": { + "$ref": "ErrorHandler" + } + }, "defaultExpiration": { "description": "Duration that static files should be cached by web proxies and browsers. Only applicable if the corresponding StaticFilesHandler (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta/apps.services.versions#staticfileshandler) does not specify its own expiration time.Only returned in GET requests if view=FULL is set.", "format": "google-duration", @@ -3215,8 +2423,8 @@ "type": "string" }, "basicScaling": { - "$ref": "BasicScaling", - "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity." + "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", + "$ref": "BasicScaling" }, "runtime": { "description": "Desired runtime. Example: python27.", @@ -3238,8 +2446,8 @@ } }, "livenessCheck": { - "$ref": "LivenessCheck", - "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set." + "description": "Configures liveness health checking for VM instances. Unhealthy instances are stopped and replaced with new instancesOnly returned in GET requests if view=FULL is set.", + "$ref": "LivenessCheck" }, "network": { "$ref": "Network", @@ -3280,16 +2488,16 @@ "type": "string" }, "healthCheck": { - "$ref": "HealthCheck", - "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set." + "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable in the App Engine flexible environment.Only returned in GET requests if view=FULL is set.", + "$ref": "HealthCheck" }, "threadsafe": { "description": "Whether multiple requests can be dispatched to this version at once.", "type": "boolean" }, "readinessCheck": { - "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set.", - "$ref": "ReadinessCheck" + "$ref": "ReadinessCheck", + "description": "Configures readiness health checking for VM instances. Unhealthy instances are not put into the backend traffic rotation.Only returned in GET requests if view=FULL is set." }, "manualScaling": { "$ref": "ManualScaling", @@ -3304,8 +2512,8 @@ "$ref": "ApiConfigHandler" }, "endpointsApiService": { - "$ref": "EndpointsApiService", - "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app." + "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app.", + "$ref": "EndpointsApiService" }, "vm": { "description": "Whether to deploy this version in a container on a virtual machine.", @@ -3338,53 +2546,8 @@ "type": "string" }, "deployment": { - "$ref": "Deployment", - "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." - }, - "createTime": { - "description": "Time that this version was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "inboundServices": { - "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.", - "type": "array", - "items": { - "enum": [ - "INBOUND_SERVICE_UNSPECIFIED", - "INBOUND_SERVICE_MAIL", - "INBOUND_SERVICE_MAIL_BOUNCE", - "INBOUND_SERVICE_XMPP_ERROR", - "INBOUND_SERVICE_XMPP_MESSAGE", - "INBOUND_SERVICE_XMPP_SUBSCRIBE", - "INBOUND_SERVICE_XMPP_PRESENCE", - "INBOUND_SERVICE_CHANNEL_PRESENCE", - "INBOUND_SERVICE_WARMUP" - ], - "type": "string" - }, - "enumDescriptions": [ - "Not specified.", - "Allows an application to receive mail.", - "Allows an application to receive email-bound notifications.", - "Allows an application to receive error stanzas.", - "Allows an application to receive instant messages.", - "Allows an application to receive user subscription POSTs.", - "Allows an application to receive a user's chat presence.", - "Registers an application for notifications when a client connects or disconnects from a channel.", - "Enables warmup requests." - ] - }, - "resources": { - "$ref": "Resources", - "description": "Machine resources for this version. Only applicable for VM runtimes." - }, - "errorHandlers": { - "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.", - "type": "array", - "items": { - "$ref": "ErrorHandler" - } + "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set.", + "$ref": "Deployment" } }, "id": "Version" @@ -3395,6 +2558,17 @@ "properties": {}, "id": "RepairApplicationRequest" }, + "BuildInfo": { + "description": "Google Cloud Container Builder build information.", + "type": "object", + "properties": { + "cloudBuildId": { + "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"", + "type": "string" + } + }, + "id": "BuildInfo" + }, "CertificateRawData": { "description": "An SSL certificate obtained from a certificate authority.", "type": "object", @@ -3410,32 +2584,25 @@ }, "id": "CertificateRawData" }, - "BuildInfo": { - "properties": { - "cloudBuildId": { - "description": "The Google Cloud Container Builder build id. Example: \"f966068f-08b2-42c8-bdfe-74137dff2bf9\"", - "type": "string" - } - }, - "id": "BuildInfo", - "description": "Google Cloud Container Builder build information.", - "type": "object" - }, "ScriptHandler": { - "description": "Executes a script to handle the request that matches the URL pattern.", - "type": "object", "properties": { "scriptPath": { "description": "Path to the script from the application root directory.", "type": "string" } }, - "id": "ScriptHandler" + "id": "ScriptHandler", + "description": "Executes a script to handle the request that matches the URL pattern.", + "type": "object" }, "FileInfo": { "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.", "type": "object", "properties": { + "sourceUrl": { + "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", + "type": "string" + }, "sha1Sum": { "description": "The SHA1 hash of the file, in hex.", "type": "string" @@ -3443,10 +2610,6 @@ "mimeType": { "description": "The MIME type of the file.Defaults to the value from Google Cloud Storage.", "type": "string" - }, - "sourceUrl": { - "description": "URL source to use to fetch this file. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", - "type": "string" } }, "id": "FileInfo" @@ -3467,16 +2630,8 @@ "id": "AuthorizedDomain" }, "TrafficSplit": { - "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.", - "type": "object", "properties": { "shardBy": { - "enum": [ - "UNSPECIFIED", - "COOKIE", - "IP", - "RANDOM" - ], "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.", "type": "string", "enumDescriptions": [ @@ -3484,6 +2639,12 @@ "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or no diversion will occur.", "Diversion based on applying the modulus operation to a fingerprint of the IP address.", "Diversion based on weighted random assignment. An incoming request is randomly routed to a version in the traffic split, with probability proportional to the version's traffic share." + ], + "enum": [ + "UNSPECIFIED", + "COOKIE", + "IP", + "RANDOM" ] }, "allocations": { @@ -3495,10 +2656,18 @@ "type": "object" } }, - "id": "TrafficSplit" + "id": "TrafficSplit", + "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.", + "type": "object" }, "OperationMetadataV1Beta": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", "properties": { + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, "method": { "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", "type": "string" @@ -3530,15 +2699,9 @@ "target": { "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" } }, - "id": "OperationMetadataV1Beta", - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object" + "id": "OperationMetadataV1Beta" }, "ListServicesResponse": { "description": "Response message for Services.ListServices.", @@ -3559,44 +2722,881 @@ "id": "ListServicesResponse" }, "ListIngressRulesResponse": { + "description": "Response message for Firewall.ListIngressRules.", + "type": "object", "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, "ingressRules": { "description": "The ingress FirewallRules for this application.", "type": "array", "items": { "$ref": "FirewallRule" } + }, + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" } }, - "id": "ListIngressRulesResponse", - "description": "Response message for Firewall.ListIngressRules.", + "id": "ListIngressRulesResponse" + }, + "Deployment": { + "properties": { + "zip": { + "description": "The zip file for this deployment, if this is a zip deployment.", + "$ref": "ZipInfo" + }, + "container": { + "$ref": "ContainerInfo", + "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment." + }, + "build": { + "$ref": "BuildInfo", + "description": "Google Cloud Container Builder build information." + }, + "files": { + "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", + "type": "object", + "additionalProperties": { + "$ref": "FileInfo" + } + }, + "cloudBuildOptions": { + "$ref": "CloudBuildOptions", + "description": "Options for any Google Cloud Container Builder builds created as a part of this deployment.Note that this is orthogonal to the build parameter, where the deployment depends on an already existing cloud build. These options will only be used if a new build is created, such as when deploying to the App Engine flexible environment using files or zip." + } + }, + "id": "Deployment", + "description": "Code and application artifacts used to deploy a version to App Engine.", "type": "object" + }, + "Resources": { + "properties": { + "cpu": { + "description": "Number of CPU cores needed.", + "format": "double", + "type": "number" + }, + "memoryGb": { + "description": "Memory (GB) needed.", + "format": "double", + "type": "number" + }, + "volumes": { + "description": "User specified volumes.", + "type": "array", + "items": { + "$ref": "Volume" + } + }, + "diskGb": { + "description": "Disk size (GB) needed.", + "format": "double", + "type": "number" + } + }, + "id": "Resources", + "description": "Machine resources for a version.", + "type": "object" + }, + "Volume": { + "description": "Volumes mounted within the app container. Only applicable in the App Engine flexible environment.", + "type": "object", + "properties": { + "sizeGb": { + "description": "Volume size in gigabytes.", + "format": "double", + "type": "number" + }, + "name": { + "description": "Unique name for the volume.", + "type": "string" + }, + "volumeType": { + "description": "Underlying volume type, e.g. 'tmpfs'.", + "type": "string" + } + }, + "id": "Volume" + }, + "BatchUpdateIngressRulesResponse": { + "description": "Response message for Firewall.UpdateAllIngressRules.", + "type": "object", + "properties": { + "ingressRules": { + "description": "The full list of ingress FirewallRules for this application.", + "type": "array", + "items": { + "$ref": "FirewallRule" + } + } + }, + "id": "BatchUpdateIngressRulesResponse" + }, + "ManagedCertificate": { + "description": "A certificate managed by App Engine.", + "type": "object", + "properties": { + "lastRenewalTime": { + "description": "Time at which the certificate was last renewed. The renewal process is fully managed. Certificate renewal will automatically occur before the certificate expires. Renewal errors can be tracked via ManagementStatus.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "status": { + "enumDescriptions": [ + "", + "Certificate was successfully obtained and inserted into the serving system.", + "Certificate is under active attempts to acquire or renew.", + "Most recent renewal failed due to an invalid DNS setup and will be retried. Renewal attempts will continue to fail until the certificate domain's DNS configuration is fixed. The last successfully provisioned certificate may still be serving.", + "All renewal attempts have been exhausted, likely due to an invalid DNS setup.", + "Most recent renewal failed due to an explicit CAA record that does not include the in-use CA, Let's Encrypt. Renewals will continue to fail until the CAA is reconfigured. The last successfully provisioned certificate may still be serving.", + "Most recent renewal failed due to a CAA retrieval failure. This means that the domain's DNS provider does not properly handle CAA records, failing requests for CAA records when no CAA records are defined. Renewals will continue to fail until the DNS provider is changed or a CAA record is added for the given domain. The last successfully provisioned certificate may still be serving." + ], + "enum": [ + "MANAGEMENT_STATUS_UNSPECIFIED", + "OK", + "PENDING", + "FAILED_RETRYING_NOT_VISIBLE", + "FAILED_PERMANENT", + "FAILED_RETRYING_CAA_FORBIDDEN", + "FAILED_RETRYING_CAA_CHECKING" + ], + "description": "Status of certificate management. Refers to the most recent certificate acquisition or renewal attempt.@OutputOnly", + "type": "string" + } + }, + "id": "ManagedCertificate" + }, + "ListInstancesResponse": { + "description": "Response message for Instances.ListInstances.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "instances": { + "description": "The instances belonging to the requested version.", + "type": "array", + "items": { + "$ref": "Instance" + } + } + }, + "id": "ListInstancesResponse" + }, + "ListDomainMappingsResponse": { + "description": "Response message for DomainMappings.ListDomainMappings.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "domainMappings": { + "description": "The domain mappings for the application.", + "type": "array", + "items": { + "$ref": "DomainMapping" + } + } + }, + "id": "ListDomainMappingsResponse" + }, + "OperationMetadataV1Alpha": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", + "properties": { + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Alpha" + }, + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", + "type": "string" + } + }, + "id": "OperationMetadataV1Alpha" + }, + "UrlDispatchRule": { + "description": "Rules to match an HTTP request and dispatch that request to a service.", + "type": "object", + "properties": { + "path": { + "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path.The sum of the lengths of the domain and path may not exceed 100 characters.", + "type": "string" + }, + "domain": { + "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", + "type": "string" + }, + "service": { + "description": "Resource ID of a service in this application that should serve the matched request. The service must already exist. Example: default.", + "type": "string" + } + }, + "id": "UrlDispatchRule" + }, + "ListVersionsResponse": { + "description": "Response message for Versions.ListVersions.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "versions": { + "description": "The versions belonging to the requested service.", + "type": "array", + "items": { + "$ref": "Version" + } + } + }, + "id": "ListVersionsResponse" + }, + "ListAuthorizedDomainsResponse": { + "description": "Response message for AuthorizedDomains.ListAuthorizedDomains.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "domains": { + "description": "The authorized domains belonging to the user.", + "type": "array", + "items": { + "$ref": "AuthorizedDomain" + } + } + }, + "id": "ListAuthorizedDomainsResponse" + }, + "DomainMapping": { + "description": "A domain serving an App Engine application.", + "type": "object", + "properties": { + "id": { + "description": "Relative name of the domain serving the application. Example: example.com.", + "type": "string" + }, + "resourceRecords": { + "description": "The resource records required to configure this domain mapping. These records must be added to the domain's DNS configuration in order to serve the application via this domain mapping.@OutputOnly", + "type": "array", + "items": { + "$ref": "ResourceRecord" + } + }, + "name": { + "description": "Full path to the DomainMapping resource in the API. Example: apps/myapp/domainMapping/example.com.@OutputOnly", + "type": "string" + }, + "sslSettings": { + "$ref": "SslSettings", + "description": "SSL configuration for this domain. If unconfigured, this domain will not serve with SSL." + } + }, + "id": "DomainMapping" + }, + "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "ApiEndpointHandler": { + "description": "Uses Google Cloud Endpoints to handle requests.", + "type": "object", + "properties": { + "scriptPath": { + "description": "Path to the script from the application root directory.", + "type": "string" + } + }, + "id": "ApiEndpointHandler" + }, + "AutomaticScaling": { + "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", + "type": "object", + "properties": { + "maxConcurrentRequests": { + "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", + "format": "int32", + "type": "integer" + }, + "coolDownPeriod": { + "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable in the App Engine flexible environment.", + "format": "google-duration", + "type": "string" + }, + "maxPendingLatency": { + "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "cpuUtilization": { + "description": "Target scaling by CPU usage.", + "$ref": "CpuUtilization" + }, + "diskUtilization": { + "$ref": "DiskUtilization", + "description": "Target scaling by disk usage." + }, + "minPendingLatency": { + "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "requestUtilization": { + "$ref": "RequestUtilization", + "description": "Target scaling by request utilization." + }, + "maxIdleInstances": { + "description": "Maximum number of idle instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "standardSchedulerSettings": { + "$ref": "StandardSchedulerSettings", + "description": "Scheduler settings for standard environment." + }, + "minIdleInstances": { + "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a service.", + "format": "int32", + "type": "integer" + }, + "maxTotalInstances": { + "description": "Maximum number of instances that should be started to handle requests.", + "format": "int32", + "type": "integer" + }, + "minTotalInstances": { + "description": "Minimum number of instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "networkUtilization": { + "description": "Target scaling by network usage.", + "$ref": "NetworkUtilization" + } + }, + "id": "AutomaticScaling" + }, + "ZipInfo": { + "properties": { + "sourceUrl": { + "description": "URL of the zip file to deploy from. Must be a URL to a resource in Google Cloud Storage in the form 'http(s)://storage.googleapis.com/\u003cbucket\u003e/\u003cobject\u003e'.", + "type": "string" + }, + "filesCount": { + "description": "An estimate of the number of files in a zip for a zip deployment. If set, must be greater than or equal to the actual number of files. Used for optimizing performance; if not provided, deployment may be slow.", + "format": "int32", + "type": "integer" + } + }, + "id": "ZipInfo", + "description": "The zip file information for a zip deployment.", + "type": "object" + }, + "AuthorizedCertificate": { + "description": "An SSL certificate that a user has been authorized to administer. A user is authorized to administer any certificate that applies to one of their authorized domains.", + "type": "object", + "properties": { + "displayName": { + "description": "The user-specified display name of the certificate. This is not guaranteed to be unique. Example: My Certificate.", + "type": "string" + }, + "certificateRawData": { + "$ref": "CertificateRawData", + "description": "The SSL certificate serving the AuthorizedCertificate resource. This must be obtained independently from a certificate authority." + }, + "managedCertificate": { + "description": "Only applicable if this certificate is managed by App Engine. Managed certificates are tied to the lifecycle of a DomainMapping and cannot be updated or deleted via the AuthorizedCertificates API. If this certificate is manually administered by the user, this field will be empty.@OutputOnly", + "$ref": "ManagedCertificate" + }, + "visibleDomainMappings": { + "description": "The full paths to user visible Domain Mapping resources that have this certificate mapped. Example: apps/myapp/domainMappings/example.com.This may not represent the full list of mapped domain mappings if the user does not have VIEWER permissions on all of the applications that have this certificate mapped. See domain_mappings_count for a complete count.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "expireTime": { + "description": "The time when this certificate expires. To update the renewal time on this certificate, upload an SSL certificate with a different expiration time using AuthorizedCertificates.UpdateAuthorizedCertificate.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Full path to the AuthorizedCertificate resource in the API. Example: apps/myapp/authorizedCertificates/12345.@OutputOnly", + "type": "string" + }, + "domainMappingsCount": { + "description": "Aggregate count of the domain mappings with this certificate mapped. This count includes domain mappings on applications for which the user does not have VIEWER permissions.Only returned by GET or LIST requests when specifically requested by the view=FULL_CERTIFICATE option.@OutputOnly", + "format": "int32", + "type": "integer" + }, + "domainNames": { + "description": "Topmost applicable domains of this certificate. This certificate applies to these domains and their subdomains. Example: example.com.@OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Relative name of the certificate. This is a unique value autogenerated on AuthorizedCertificate resource creation. Example: 12345.@OutputOnly", + "type": "string" + } + }, + "id": "AuthorizedCertificate" + }, + "ResourceRecord": { + "description": "A DNS resource record.", + "type": "object", + "properties": { + "name": { + "description": "Relative name of the object affected by this record. Only applicable for CNAME records. Example: 'www'.", + "type": "string" + }, + "type": { + "enumDescriptions": [ + "An A resource record. Data is an IPv4 address.", + "An AAAA resource record. Data is an IPv6 address.", + "A CNAME resource record. Data is a domain name to be aliased." + ], + "enum": [ + "A", + "AAAA", + "CNAME" + ], + "description": "Resource record type. Example: AAAA.", + "type": "string" + }, + "rrdata": { + "description": "Data for this record. Values vary by record type, as defined in RFC 1035 (section 5) and RFC 1034 (section 3.6.1).", + "type": "string" + } + }, + "id": "ResourceRecord" + }, + "Library": { + "properties": { + "version": { + "description": "Version of the library to select, or \"latest\".", + "type": "string" + }, + "name": { + "description": "Name of the library. Example: \"django\".", + "type": "string" + } + }, + "id": "Library", + "description": "Third-party Python runtime library that is required by the application.", + "type": "object" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "type": "object", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Location" + } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "id": "ListLocationsResponse" + }, + "ContainerInfo": { + "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", + "type": "object", + "properties": { + "image": { + "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"", + "type": "string" + } + }, + "id": "ContainerInfo" + }, + "RequestUtilization": { + "properties": { + "targetRequestCountPerSecond": { + "description": "Target requests per second.", + "format": "int32", + "type": "integer" + }, + "targetConcurrentRequests": { + "description": "Target number of concurrent requests.", + "format": "int32", + "type": "integer" + } + }, + "id": "RequestUtilization", + "description": "Target scaling by request utilization. Only applicable in the App Engine flexible environment.", + "type": "object" + }, + "UrlMap": { + "properties": { + "staticFiles": { + "description": "Returns the contents of a file, such as an image, as the response.", + "$ref": "StaticFilesHandler" + }, + "redirectHttpResponseCode": { + "enum": [ + "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", + "REDIRECT_HTTP_RESPONSE_CODE_301", + "REDIRECT_HTTP_RESPONSE_CODE_302", + "REDIRECT_HTTP_RESPONSE_CODE_303", + "REDIRECT_HTTP_RESPONSE_CODE_307" + ], + "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", + "type": "string", + "enumDescriptions": [ + "Not specified. 302 is assumed.", + "301 Moved Permanently code.", + "302 Moved Temporarily code.", + "303 See Other code.", + "307 Temporary Redirect code." + ] + }, + "securityLevel": { + "enum": [ + "SECURE_UNSPECIFIED", + "SECURE_DEFAULT", + "SECURE_NEVER", + "SECURE_OPTIONAL", + "SECURE_ALWAYS" + ], + "description": "Security (HTTPS) enforcement for this URL.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", + "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", + "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." + ] + }, + "authFailAction": { + "description": "Action to take when users access resources that require authentication. Defaults to redirect.", + "type": "string", + "enumDescriptions": [ + "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", + "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", + "Rejects request with a 401 HTTP status code and an error message." + ], + "enum": [ + "AUTH_FAIL_ACTION_UNSPECIFIED", + "AUTH_FAIL_ACTION_REDIRECT", + "AUTH_FAIL_ACTION_UNAUTHORIZED" + ] + }, + "script": { + "$ref": "ScriptHandler", + "description": "Executes a script to handle the request that matches this URL pattern." + }, + "urlRegex": { + "description": "URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", + "type": "string" + }, + "login": { + "enumDescriptions": [ + "Not specified. LOGIN_OPTIONAL is assumed.", + "Does not require that the user is signed in.", + "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", + "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." + ], + "enum": [ + "LOGIN_UNSPECIFIED", + "LOGIN_OPTIONAL", + "LOGIN_ADMIN", + "LOGIN_REQUIRED" + ], + "description": "Level of login required to access this resource.", + "type": "string" + }, + "apiEndpoint": { + "description": "Uses API Endpoints to handle requests.", + "$ref": "ApiEndpointHandler" + } + }, + "id": "UrlMap", + "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", + "type": "object" + }, + "EndpointsApiService": { + "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", + "type": "object", + "properties": { + "name": { + "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", + "type": "string" + }, + "configId": { + "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.", + "type": "string" + } + }, + "id": "EndpointsApiService" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "type": "object", + "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": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "done": { + "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", + "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 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" + }, + "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 operations/some/unique/name.", + "type": "string" + } + }, + "id": "Operation" + }, + "ApiConfigHandler": { + "properties": { + "login": { + "enum": [ + "LOGIN_UNSPECIFIED", + "LOGIN_OPTIONAL", + "LOGIN_ADMIN", + "LOGIN_REQUIRED" + ], + "description": "Level of login required to access this resource. Defaults to optional.", + "type": "string", + "enumDescriptions": [ + "Not specified. LOGIN_OPTIONAL is assumed.", + "Does not require that the user is signed in.", + "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", + "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." + ] + }, + "url": { + "description": "URL to serve the endpoint at.", + "type": "string" + }, + "securityLevel": { + "enumDescriptions": [ + "Not specified.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", + "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", + "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." + ], + "enum": [ + "SECURE_UNSPECIFIED", + "SECURE_DEFAULT", + "SECURE_NEVER", + "SECURE_OPTIONAL", + "SECURE_ALWAYS" + ], + "description": "Security (HTTPS) enforcement for this URL.", + "type": "string" + }, + "authFailAction": { + "enum": [ + "AUTH_FAIL_ACTION_UNSPECIFIED", + "AUTH_FAIL_ACTION_REDIRECT", + "AUTH_FAIL_ACTION_UNAUTHORIZED" + ], + "description": "Action to take when users access resources that require authentication. Defaults to redirect.", + "type": "string", + "enumDescriptions": [ + "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", + "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", + "Rejects request with a 401 HTTP status code and an error message." + ] + }, + "script": { + "description": "Path to the script from the application root directory.", + "type": "string" + } + }, + "id": "ApiConfigHandler", + "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", + "type": "object" + }, + "StaticFilesHandler": { + "properties": { + "uploadPathRegex": { + "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", + "type": "string" + }, + "path": { + "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", + "type": "string" + }, + "mimeType": { + "description": "MIME type used to serve all files served by this handler.Defaults to file-specific MIME types, which are derived from each file's filename extension.", + "type": "string" + }, + "requireMatchingFile": { + "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", + "type": "boolean" + }, + "expiration": { + "description": "Time a static file served by this handler should be cached by web proxies and browsers.", + "format": "google-duration", + "type": "string" + }, + "httpHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "HTTP headers to use for all responses from these URLs.", + "type": "object" + }, + "applicationReadable": { + "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", + "type": "boolean" + } + }, + "id": "StaticFilesHandler", + "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", + "type": "object" + }, + "BasicScaling": { + "properties": { + "maxInstances": { + "description": "Maximum number of instances to create for this version.", + "format": "int32", + "type": "integer" + }, + "idleTimeout": { + "description": "Duration of time after the last request that an instance must wait before the instance is shut down.", + "format": "google-duration", + "type": "string" + } + }, + "id": "BasicScaling", + "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", + "type": "object" + }, + "DiskUtilization": { + "properties": { + "targetReadBytesPerSecond": { + "description": "Target bytes read per second.", + "format": "int32", + "type": "integer" + }, + "targetReadOpsPerSecond": { + "description": "Target ops read per seconds.", + "format": "int32", + "type": "integer" + }, + "targetWriteOpsPerSecond": { + "description": "Target ops written per second.", + "format": "int32", + "type": "integer" + }, + "targetWriteBytesPerSecond": { + "description": "Target bytes written per second.", + "format": "int32", + "type": "integer" + } + }, + "id": "DiskUtilization", + "description": "Target scaling by disk usage. Only applicable in the App Engine flexible environment.", + "type": "object" + }, + "CpuUtilization": { + "description": "Target scaling by CPU usage.", + "type": "object", + "properties": { + "aggregationWindowLength": { + "description": "Period of time over which CPU utilization is calculated.", + "format": "google-duration", + "type": "string" + }, + "targetUtilization": { + "description": "Target CPU utilization ratio to maintain when scaling. Must be between 0 and 1.", + "format": "double", + "type": "number" + } + }, + "id": "CpuUtilization" } }, - "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, + "protocol": "rest", "version": "v1beta", "baseUrl": "https://appengine.googleapis.com/", "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" }, "https://www.googleapis.com/auth/appengine.admin": { "description": "View and manage your applications deployed on Google App Engine" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" } } } - } + }, + "kind": "discovery#restDescription", + "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", + "servicePath": "", + "rootUrl": "https://appengine.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "appengine" }
diff --git a/appengine/v1beta4/appengine-api.json b/appengine/v1beta4/appengine-api.json index 4ee7f5a..cfda1f4 100644 --- a/appengine/v1beta4/appengine-api.json +++ b/appengine/v1beta4/appengine-api.json
@@ -1,28 +1,4 @@ { - "baseUrl": "https://appengine.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/appengine.admin": { - "description": "View and manage your applications deployed on Google App Engine" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "servicePath": "", - "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", - "kind": "discovery#restDescription", - "rootUrl": "https://appengine.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "appengine", - "batchPath": "batch", "revision": "20171220", "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", "id": "appengine:v1beta4", @@ -31,92 +7,14 @@ "ownerName": "Google", "resources": { "apps": { - "methods": { - "get": { - "flatPath": "v1beta4/apps/{appsId}", - "path": "v1beta4/apps/{appsId}", - "id": "appengine.apps.get", - "description": "Gets information about an application.", - "response": { - "$ref": "Application" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "ensureResourcesExist": { - "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.", - "type": "boolean", - "location": "query" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the application to get. Example: apps/myapp.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "flatPath": "v1beta4/apps/{appsId}", - "path": "v1beta4/apps/{appsId}", - "id": "appengine.apps.patch", - "request": { - "$ref": "Application" - }, - "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "PATCH", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", - "required": true, - "type": "string" - }, - "mask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).", - "request": { - "$ref": "Application" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {}, - "flatPath": "v1beta4/apps", - "path": "v1beta4/apps", - "id": "appengine.apps.create" - } - }, "resources": { "locations": { "methods": { "list": { + "flatPath": "v1beta4/apps/{appsId}/locations", + "path": "v1beta4/apps/{appsId}/locations", + "id": "appengine.apps.locations.list", + "description": "Lists information about the supported locations for this service.", "response": { "$ref": "ListLocationsResponse" }, @@ -130,39 +28,31 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "appsId": { + "location": "path", "description": "Part of `name`. The resource that owns the locations collection, if applicable.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "pageToken": { - "location": "query", "description": "The standard list page token.", - "type": "string" + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" } - }, - "flatPath": "v1beta4/apps/{appsId}/locations", - "path": "v1beta4/apps/{appsId}/locations", - "id": "appengine.apps.locations.list", - "description": "Lists information about the supported locations for this service." + } }, "get": { - "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}", - "path": "v1beta4/apps/{appsId}/locations/{locationsId}", - "id": "appengine.apps.locations.get", - "description": "Get information about a location.", "response": { "$ref": "Location" }, @@ -172,107 +62,184 @@ ], "httpMethod": "GET", "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Resource name for the location.", - "required": true, - "type": "string" - }, "locationsId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string", "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Resource name for the location.", + "required": true, + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" - ] + ], + "flatPath": "v1beta4/apps/{appsId}/locations/{locationsId}", + "path": "v1beta4/apps/{appsId}/locations/{locationsId}", + "id": "appengine.apps.locations.get", + "description": "Get information about a location." } } }, "modules": { + "methods": { + "get": { + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}", + "id": "appengine.apps.modules.get", + "description": "Gets the current configuration of the specified module.", + "response": { + "$ref": "Module" + }, + "parameterOrder": [ + "appsId", + "modulesId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "modulesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.", + "required": true, + "type": "string", + "location": "path" + } + } + }, + "list": { + "response": { + "$ref": "ListModulesResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer" + }, + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Continuation token for fetching the next page of results.", + "type": "string" + } + }, + "flatPath": "v1beta4/apps/{appsId}/modules", + "path": "v1beta4/apps/{appsId}/modules", + "id": "appengine.apps.modules.list", + "description": "Lists all the modules in the application." + }, + "patch": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "modulesId" + ], + "httpMethod": "PATCH", + "parameters": { + "migrateTraffic": { + "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", + "type": "boolean", + "location": "query" + }, + "modulesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "mask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}", + "id": "appengine.apps.modules.patch", + "request": { + "$ref": "Module" + }, + "description": "Updates the configuration of the specified module." + }, + "delete": { + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}", + "id": "appengine.apps.modules.delete", + "description": "Deletes the specified module and all enclosed versions.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "modulesId" + ], + "httpMethod": "DELETE", + "parameters": { + "modulesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, "resources": { "versions": { "methods": { - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "modulesId" - ], - "httpMethod": "POST", - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.", - "required": true, - "type": "string" - }, - "modulesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions", - "id": "appengine.apps.modules.versions.create", - "request": { - "$ref": "Version" - }, - "description": "Deploys code and resource files to a new version." - }, - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "modulesId", - "versionsId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "modulesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", - "id": "appengine.apps.modules.versions.delete", - "description": "Deletes an existing version." - }, "get": { - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", - "id": "appengine.apps.modules.versions.get", "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", "response": { "$ref": "Version" @@ -289,6 +256,12 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.", + "required": true, + "type": "string" + }, "modulesId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, @@ -302,24 +275,20 @@ "type": "string" }, "view": { - "location": "query", "enum": [ "BASIC", "FULL" ], "description": "Controls the set of fields returned in the Get response.", - "type": "string" - }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.", - "required": true, "type": "string", - "location": "path" + "location": "query" } - } + }, + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "id": "appengine.apps.modules.versions.get" }, "list": { - "description": "Lists the versions of a module.", "response": { "$ref": "ListVersionsResponse" }, @@ -335,10 +304,10 @@ ], "parameters": { "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "pageToken": { "location": "query", @@ -346,10 +315,10 @@ "type": "string" }, "pageSize": { - "location": "query", "description": "Maximum results to return per page.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "modulesId": { "description": "Part of `name`. See documentation of `appsId`.", @@ -369,25 +338,30 @@ }, "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions", "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions", - "id": "appengine.apps.modules.versions.list" + "id": "appengine.apps.modules.versions.list", + "description": "Lists the versions of a module." }, "patch": { - "id": "appengine.apps.modules.versions.patch", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", "request": { "$ref": "Version" }, "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.", - "httpMethod": "PATCH", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "appsId", "modulesId", "versionsId" ], - "response": { - "$ref": "Operation" - }, + "httpMethod": "PATCH", "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.", + "required": true, + "type": "string", + "location": "path" + }, "modulesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", @@ -395,28 +369,96 @@ "type": "string" }, "versionsId": { - "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "mask": { "description": "Standard field mask for the set of fields to be updated.", "format": "google-fieldmask", "type": "string", "location": "query" - }, - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default/versions/1.", - "required": true, - "type": "string", - "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}" + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "id": "appengine.apps.modules.versions.patch" + }, + "create": { + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions", + "id": "appengine.apps.modules.versions.create", + "request": { + "$ref": "Version" + }, + "description": "Deploys code and resource files to a new version.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "modulesId" + ], + "httpMethod": "POST", + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.", + "required": true, + "type": "string", + "location": "path" + }, + "modulesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}", + "id": "appengine.apps.modules.versions.delete", + "description": "Deletes an existing version.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId", + "modulesId", + "versionsId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.", + "required": true, + "type": "string", + "location": "path" + }, + "modulesId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + } + } } }, "resources": { @@ -438,10 +480,10 @@ ], "parameters": { "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "instancesId": { "location": "path", @@ -468,17 +510,16 @@ "description": "Stops a running instance." }, "get": { - "description": "Gets instance information.", - "response": { - "$ref": "Instance" - }, + "httpMethod": "GET", "parameterOrder": [ "appsId", "modulesId", "versionsId", "instancesId" ], - "httpMethod": "GET", + "response": { + "$ref": "Instance" + }, "parameters": { "appsId": { "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1/instances/instance-1.", @@ -511,8 +552,9 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}", + "id": "appengine.apps.modules.versions.instances.get", "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}", - "id": "appengine.apps.modules.versions.instances.get" + "description": "Gets instance information." }, "list": { "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", @@ -531,6 +573,24 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { + "pageSize": { + "description": "Maximum results to return per page.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "modulesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, "appsId": { "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default/versions/v1.", @@ -541,24 +601,6 @@ "description": "Continuation token for fetching the next page of results.", "type": "string", "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - }, - "modulesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" } }, "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances", @@ -566,10 +608,12 @@ "id": "appengine.apps.modules.versions.instances.list" }, "debug": { + "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug", + "id": "appengine.apps.modules.versions.instances.debug", + "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", "request": { "$ref": "DebugInstanceRequest" }, - "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", "response": { "$ref": "Operation" }, @@ -580,6 +624,9 @@ "instancesId" ], "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "modulesId": { "description": "Part of `name`. See documentation of `appsId`.", @@ -588,10 +635,10 @@ "location": "path" }, "versionsId": { + "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "appsId": { "location": "path", @@ -606,214 +653,59 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug", - "id": "appengine.apps.modules.versions.instances.debug" + "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}/versions/{versionsId}/instances/{instancesId}:debug" } } } } } - }, - "methods": { - "get": { - "response": { - "$ref": "Module" - }, - "parameterOrder": [ - "appsId", - "modulesId" - ], - "httpMethod": "GET", - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.", - "required": true, - "type": "string", - "location": "path" - }, - "modulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}", - "id": "appengine.apps.modules.get", - "description": "Gets the current configuration of the specified module." - }, - "list": { - "path": "v1beta4/apps/{appsId}/modules", - "id": "appengine.apps.modules.list", - "description": "Lists all the modules in the application.", - "response": { - "$ref": "ListModulesResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum results to return per page.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v1beta4/apps/{appsId}/modules" - }, - "patch": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "modulesId" - ], - "httpMethod": "PATCH", - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/modules/default.", - "required": true, - "type": "string", - "location": "path" - }, - "migrateTraffic": { - "location": "query", - "description": "Set to true to gradually shift traffic to one or more versions that you specify. By default, traffic is shifted immediately. For gradual traffic migration, the target versions must be located within instances that are configured for both warmup requests (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#inboundservicetype) and automatic scaling (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules.versions#automaticscaling). You must specify the shardBy (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps.modules#shardby) field in the Module resource. Gradual traffic migration is not supported in the App Engine flexible environment. For examples, see Migrating and Splitting Traffic (https://cloud.google.com/appengine/docs/admin-api/migrating-splitting-traffic).", - "type": "boolean" - }, - "modulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "mask": { - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}", - "id": "appengine.apps.modules.patch", - "request": { - "$ref": "Module" - }, - "description": "Updates the configuration of the specified module." - }, - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "appsId", - "modulesId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/modules/default.", - "required": true, - "type": "string", - "location": "path" - }, - "modulesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta4/apps/{appsId}/modules/{modulesId}", - "id": "appengine.apps.modules.delete", - "path": "v1beta4/apps/{appsId}/modules/{modulesId}", - "description": "Deletes the specified module and all enclosed versions." - } } }, "operations": { "methods": { "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "httpMethod": "GET", "response": { "$ref": "ListOperationsResponse" }, "parameterOrder": [ "appsId" ], - "httpMethod": "GET", + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. The name of the operation's parent resource.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + } + }, "scopes": [ "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "parameters": { - "appsId": { - "description": "Part of `name`. The name of the operation's parent resource.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - } - }, "flatPath": "v1beta4/apps/{appsId}/operations", - "path": "v1beta4/apps/{appsId}/operations", "id": "appengine.apps.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." + "path": "v1beta4/apps/{appsId}/operations" }, "get": { - "id": "appengine.apps.operations.get", - "path": "v1beta4/apps/{appsId}/operations/{operationsId}", "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", "response": { @@ -825,16 +717,16 @@ ], "parameters": { "appsId": { + "location": "path", "description": "Part of `name`. The name of the operation resource.", "required": true, + "type": "string" + }, + "operationsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, "type": "string", "location": "path" - }, - "operationsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" } }, "scopes": [ @@ -842,17 +734,154 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}" + "flatPath": "v1beta4/apps/{appsId}/operations/{operationsId}", + "id": "appengine.apps.operations.get", + "path": "v1beta4/apps/{appsId}/operations/{operationsId}" } } } + }, + "methods": { + "create": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta4/apps", + "path": "v1beta4/apps", + "id": "appengine.apps.create", + "request": { + "$ref": "Application" + }, + "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)." + }, + "get": { + "httpMethod": "GET", + "response": { + "$ref": "Application" + }, + "parameterOrder": [ + "appsId" + ], + "parameters": { + "ensureResourcesExist": { + "location": "query", + "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete.", + "type": "boolean" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the application to get. Example: apps/myapp.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta4/apps/{appsId}", + "id": "appengine.apps.get", + "path": "v1beta4/apps/{appsId}", + "description": "Gets information about an application." + }, + "patch": { + "flatPath": "v1beta4/apps/{appsId}", + "id": "appengine.apps.patch", + "path": "v1beta4/apps/{appsId}", + "request": { + "$ref": "Application" + }, + "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta4/apps#Application.FIELDS.default_cookie_expiration)", + "httpMethod": "PATCH", + "parameterOrder": [ + "appsId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + }, + "mask": { + "location": "query", + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } } } }, "parameters": { - "fields": { - "description": "Selector specifying which fields to include in a partial response.", + "alt": { + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], "type": "string", + "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" + }, + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", "location": "query" }, "uploadType": { @@ -860,10 +889,10 @@ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" }, "$.xgafv": { "enumDescriptions": [ @@ -878,81 +907,254 @@ "description": "V1 error format.", "type": "string" }, - "alt": { - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ], + "callback": { "location": "query", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], + "description": "JSONP", "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" } }, "schemas": { - "Library": { + "ListInstancesResponse": { + "description": "Response message for Instances.ListInstances.", + "type": "object", "properties": { - "name": { - "description": "Name of the library. Example: \"django\".", + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", "type": "string" }, - "version": { - "description": "Version of the library to select, or \"latest\".", + "instances": { + "description": "The instances belonging to the requested version.", + "type": "array", + "items": { + "$ref": "Instance" + } + } + }, + "id": "ListInstancesResponse" + }, + "OperationMetadataV1Alpha": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", + "properties": { + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Alpha" + }, + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", "type": "string" } }, - "id": "Library", - "description": "Third-party Python runtime library that is required by the application.", + "id": "OperationMetadataV1Alpha" + }, + "UrlDispatchRule": { + "properties": { + "path": { + "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.", + "type": "string" + }, + "domain": { + "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", + "type": "string" + }, + "module": { + "description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.", + "type": "string" + } + }, + "id": "UrlDispatchRule", + "description": "Rules to match an HTTP request and dispatch that request to a module.", "type": "object" }, + "Module": { + "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.", + "type": "object", + "properties": { + "name": { + "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly", + "type": "string" + }, + "split": { + "$ref": "TrafficSplit", + "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module." + }, + "id": { + "description": "Relative name of the module within the application. Example: default.@OutputOnly", + "type": "string" + } + }, + "id": "Module" + }, + "ListVersionsResponse": { + "description": "Response message for Versions.ListVersions.", + "type": "object", + "properties": { + "versions": { + "description": "The versions belonging to the requested module.", + "type": "array", + "items": { + "$ref": "Version" + } + }, + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + } + }, + "id": "ListVersionsResponse" + }, + "ApiEndpointHandler": { + "description": "Uses Google Cloud Endpoints to handle requests.", + "type": "object", + "properties": { + "scriptPath": { + "description": "Path to the script from the application root directory.", + "type": "string" + } + }, + "id": "ApiEndpointHandler" + }, + "StaticDirectoryHandler": { + "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.", + "type": "object", + "properties": { + "requireMatchingFile": { + "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", + "type": "boolean" + }, + "expiration": { + "description": "Time a static file served by this handler should be cached.", + "format": "google-duration", + "type": "string" + }, + "httpHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "HTTP headers to use for all responses from these URLs.", + "type": "object" + }, + "applicationReadable": { + "description": "Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", + "type": "boolean" + }, + "directory": { + "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.", + "type": "string" + }, + "mimeType": { + "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.", + "type": "string" + } + }, + "id": "StaticDirectoryHandler" + }, + "AutomaticScaling": { + "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", + "type": "object", + "properties": { + "diskUtilization": { + "$ref": "DiskUtilization", + "description": "Target scaling by disk usage." + }, + "minPendingLatency": { + "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "requestUtilization": { + "$ref": "RequestUtilization", + "description": "Target scaling by request utilization." + }, + "maxIdleInstances": { + "description": "Maximum number of idle instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "minIdleInstances": { + "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.", + "format": "int32", + "type": "integer" + }, + "maxTotalInstances": { + "description": "Maximum number of instances that should be started to handle requests.", + "format": "int32", + "type": "integer" + }, + "minTotalInstances": { + "description": "Minimum number of instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "networkUtilization": { + "$ref": "NetworkUtilization", + "description": "Target scaling by network usage." + }, + "maxConcurrentRequests": { + "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", + "format": "int32", + "type": "integer" + }, + "coolDownPeriod": { + "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.", + "format": "google-duration", + "type": "string" + }, + "maxPendingLatency": { + "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "cpuUtilization": { + "$ref": "CpuUtilization", + "description": "Target scaling by CPU usage." + } + }, + "id": "AutomaticScaling" + }, + "Library": { + "description": "Third-party Python runtime library that is required by the application.", + "type": "object", + "properties": { + "version": { + "description": "Version of the library to select, or \"latest\".", + "type": "string" + }, + "name": { + "description": "Name of the library. Example: \"django\".", + "type": "string" + } + }, + "id": "Library" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", @@ -972,15 +1174,15 @@ "id": "ListLocationsResponse" }, "ContainerInfo": { - "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", - "type": "object", "properties": { "image": { "description": "URI to the hosted container image in Google Container Registry. The URI must be fully qualified and include a tag or digest. Examples: \"gcr.io/my-project/image:tag\" or \"gcr.io/my-project/image@digest\"", "type": "string" } }, - "id": "ContainerInfo" + "id": "ContainerInfo", + "description": "Docker image that is used to create a container and start a VM instance for the version that you deploy. Only applicable for instances running in the App Engine flexible environment.", + "type": "object" }, "RequestUtilization": { "description": "Target scaling by request utilization. Only applicable for VM runtimes.", @@ -999,52 +1201,18 @@ }, "id": "RequestUtilization" }, - "EndpointsApiService": { - "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", + "UrlMap": { + "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", "type": "object", "properties": { - "name": { - "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", - "type": "string" - }, - "configId": { - "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.", - "type": "string" - } - }, - "id": "EndpointsApiService" - }, - "UrlMap": { - "properties": { - "login": { - "description": "Level of login required to access this resource.", - "type": "string", - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ], - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ] - }, - "apiEndpoint": { - "$ref": "ApiEndpointHandler", - "description": "Uses API Endpoints to handle requests." - }, - "staticDirectory": { - "$ref": "StaticDirectoryHandler", - "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files." - }, - "staticFiles": { - "$ref": "StaticFilesHandler", - "description": "Returns the contents of a file, such as an image, as the response." - }, "redirectHttpResponseCode": { + "enum": [ + "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", + "REDIRECT_HTTP_RESPONSE_CODE_301", + "REDIRECT_HTTP_RESPONSE_CODE_302", + "REDIRECT_HTTP_RESPONSE_CODE_303", + "REDIRECT_HTTP_RESPONSE_CODE_307" + ], "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", "type": "string", "enumDescriptions": [ @@ -1053,13 +1221,6 @@ "302 Moved Temporarily code.", "303 See Other code.", "307 Temporary Redirect code." - ], - "enum": [ - "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", - "REDIRECT_HTTP_RESPONSE_CODE_301", - "REDIRECT_HTTP_RESPONSE_CODE_302", - "REDIRECT_HTTP_RESPONSE_CODE_303", - "REDIRECT_HTTP_RESPONSE_CODE_307" ] }, "securityLevel": { @@ -1081,18 +1242,18 @@ "type": "string" }, "authFailAction": { - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with a 401 HTTP status code and an error message." - ], "enum": [ "AUTH_FAIL_ACTION_UNSPECIFIED", "AUTH_FAIL_ACTION_REDIRECT", "AUTH_FAIL_ACTION_UNAUTHORIZED" ], "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", + "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", + "Rejects request with a 401 HTTP status code and an error message." + ] }, "script": { "$ref": "ScriptHandler", @@ -1101,15 +1262,54 @@ "urlRegex": { "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", "type": "string" + }, + "login": { + "description": "Level of login required to access this resource.", + "type": "string", + "enumDescriptions": [ + "Not specified. LOGIN_OPTIONAL is assumed.", + "Does not require that the user is signed in.", + "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", + "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." + ], + "enum": [ + "LOGIN_UNSPECIFIED", + "LOGIN_OPTIONAL", + "LOGIN_ADMIN", + "LOGIN_REQUIRED" + ] + }, + "apiEndpoint": { + "description": "Uses API Endpoints to handle requests.", + "$ref": "ApiEndpointHandler" + }, + "staticDirectory": { + "description": "Serves the entire contents of a directory as static files.This attribute is deprecated. You can mimic the behavior of static directories using static files.", + "$ref": "StaticDirectoryHandler" + }, + "staticFiles": { + "description": "Returns the contents of a file, such as an image, as the response.", + "$ref": "StaticFilesHandler" } }, - "id": "UrlMap", - "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", - "type": "object" + "id": "UrlMap" + }, + "EndpointsApiService": { + "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", + "type": "object", + "properties": { + "name": { + "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", + "type": "string" + }, + "configId": { + "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.", + "type": "string" + } + }, + "id": "EndpointsApiService" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "type": "object", "properties": { "done": { "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", @@ -1132,34 +1332,22 @@ "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" } }, - "id": "Operation" + "id": "Operation", + "description": "This resource represents a long-running operation that is the result of a network API call.", + "type": "object" }, "ApiConfigHandler": { + "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", + "type": "object", "properties": { - "login": { - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" - ], - "description": "Level of login required to access this resource. Defaults to optional.", - "type": "string", - "enumDescriptions": [ - "Not specified. LOGIN_OPTIONAL is assumed.", - "Does not require that the user is signed in.", - "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", - "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." - ] - }, "url": { "description": "URL to serve the endpoint at.", "type": "string" @@ -1183,40 +1371,46 @@ "type": "string" }, "authFailAction": { - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ], "description": "Action to take when users access resources that require authentication. Defaults to redirect.", "type": "string", "enumDescriptions": [ "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", "Rejects request with a 401 HTTP status code and an error message." + ], + "enum": [ + "AUTH_FAIL_ACTION_UNSPECIFIED", + "AUTH_FAIL_ACTION_REDIRECT", + "AUTH_FAIL_ACTION_UNAUTHORIZED" ] }, "script": { "description": "Path to the script from the application root directory.", "type": "string" + }, + "login": { + "enumDescriptions": [ + "Not specified. LOGIN_OPTIONAL is assumed.", + "Does not require that the user is signed in.", + "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", + "If the user has signed in, the handler proceeds normally. Otherwise, the auth_fail_action is taken." + ], + "enum": [ + "LOGIN_UNSPECIFIED", + "LOGIN_OPTIONAL", + "LOGIN_ADMIN", + "LOGIN_REQUIRED" + ], + "description": "Level of login required to access this resource. Defaults to optional.", + "type": "string" } }, - "id": "ApiConfigHandler", - "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", - "type": "object" + "id": "ApiConfigHandler" }, "StaticFilesHandler": { "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", "type": "object", "properties": { - "uploadPathRegex": { - "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", - "type": "string" - }, - "path": { - "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", - "type": "string" - }, "mimeType": { "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.", "type": "string" @@ -1240,6 +1434,14 @@ }, "description": "HTTP headers to use for all responses from these URLs.", "type": "object" + }, + "uploadPathRegex": { + "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", + "type": "string" + }, + "path": { + "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", + "type": "string" } }, "id": "StaticFilesHandler" @@ -1248,21 +1450,26 @@ "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", "type": "object", "properties": { - "maxInstances": { - "description": "Maximum number of instances to create for this version.", - "format": "int32", - "type": "integer" - }, "idleTimeout": { "description": "Duration of time after the last request that an instance must wait before the instance is shut down.", "format": "google-duration", "type": "string" + }, + "maxInstances": { + "description": "Maximum number of instances to create for this version.", + "format": "int32", + "type": "integer" } }, "id": "BasicScaling" }, "DiskUtilization": { "properties": { + "targetWriteBytesPerSec": { + "description": "Target bytes written per second.", + "format": "int32", + "type": "integer" + }, "targetReadOpsPerSec": { "description": "Target ops read per second.", "format": "int32", @@ -1277,11 +1484,6 @@ "description": "Target ops written per second.", "format": "int32", "type": "integer" - }, - "targetWriteBytesPerSec": { - "description": "Target bytes written per second.", - "format": "int32", - "type": "integer" } }, "id": "DiskUtilization", @@ -1289,6 +1491,8 @@ "type": "object" }, "CpuUtilization": { + "description": "Target scaling by CPU usage.", + "type": "object", "properties": { "aggregationWindowLength": { "description": "Period of time over which CPU utilization is calculated.", @@ -1301,13 +1505,36 @@ "type": "number" } }, - "id": "CpuUtilization", - "description": "Target scaling by CPU usage.", - "type": "object" + "id": "CpuUtilization" + }, + "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "type": "object", + "properties": { + "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 field, or localized by the client.", + "type": "string" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + } + }, + "id": "Status" }, "IdentityAwareProxy": { - "description": "Identity-Aware Proxy", - "type": "object", "properties": { "oauth2ClientSecret": { "description": "For security reasons, this value cannot be retrieved via the API. Instead, the SHA-256 hash of the value is returned in the oauth2_client_secret_sha256 field.@InputOnly", @@ -1326,36 +1553,13 @@ "type": "boolean" } }, - "id": "IdentityAwareProxy" - }, - "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", - "type": "object", - "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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - } - }, - "id": "Status" + "id": "IdentityAwareProxy", + "description": "Identity-Aware Proxy", + "type": "object" }, "ManualScaling": { + "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", + "type": "object", "properties": { "instances": { "description": "Number of instances to assign to the module at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.", @@ -1363,39 +1567,37 @@ "type": "integer" } }, - "id": "ManualScaling", - "description": "A module with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", - "type": "object" + "id": "ManualScaling" }, "LocationMetadata": { - "description": "Metadata for the given google.cloud.location.Location.", - "type": "object", "properties": { - "flexibleEnvironmentAvailable": { - "description": "App Engine Flexible Environment is available in the given location.@OutputOnly", - "type": "boolean" - }, "standardEnvironmentAvailable": { "description": "App Engine Standard Environment is available in the given location.@OutputOnly", "type": "boolean" + }, + "flexibleEnvironmentAvailable": { + "description": "App Engine Flexible Environment is available in the given location.@OutputOnly", + "type": "boolean" } }, - "id": "LocationMetadata" + "id": "LocationMetadata", + "description": "Metadata for the given google.cloud.location.Location.", + "type": "object" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "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.", "type": "array", "items": { "$ref": "Operation" } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } }, "id": "ListOperationsResponse" @@ -1444,6 +1646,39 @@ }, "id": "CreateVersionMetadataV1Beta" }, + "ErrorHandler": { + "description": "Custom static error page to be served when an error occurs.", + "type": "object", + "properties": { + "errorCode": { + "enumDescriptions": [ + "Not specified. ERROR_CODE_DEFAULT is assumed.", + "All other error types.", + "Application has exceeded a resource quota.", + "Client blocked by the application's Denial of Service protection configuration.", + "Deadline reached before the application responds." + ], + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "ERROR_CODE_DEFAULT", + "ERROR_CODE_OVER_QUOTA", + "ERROR_CODE_DOS_API_DENIAL", + "ERROR_CODE_TIMEOUT" + ], + "description": "Error condition this handler applies to.", + "type": "string" + }, + "mimeType": { + "description": "MIME type of file. Defaults to text/html.", + "type": "string" + }, + "staticFile": { + "description": "Static file content to be served for this error.", + "type": "string" + } + }, + "id": "ErrorHandler" + }, "OperationMetadataV1": { "description": "Metadata for the given google.longrunning.Operation.", "type": "object", @@ -1484,38 +1719,27 @@ }, "id": "OperationMetadataV1" }, - "ErrorHandler": { - "description": "Custom static error page to be served when an error occurs.", + "Network": { + "description": "Extra network settings. Only applicable for VM runtimes.", "type": "object", "properties": { - "errorCode": { - "enum": [ - "ERROR_CODE_UNSPECIFIED", - "ERROR_CODE_DEFAULT", - "ERROR_CODE_OVER_QUOTA", - "ERROR_CODE_DOS_API_DENIAL", - "ERROR_CODE_TIMEOUT" - ], - "description": "Error condition this handler applies to.", - "type": "string", - "enumDescriptions": [ - "Not specified. ERROR_CODE_DEFAULT is assumed.", - "All other error types.", - "Application has exceeded a resource quota.", - "Client blocked by the application's Denial of Service protection configuration.", - "Deadline reached before the application responds." - ] + "forwardedPorts": { + "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.", + "type": "array", + "items": { + "type": "string" + } }, - "mimeType": { - "description": "MIME type of file. Defaults to text/html.", + "instanceTag": { + "description": "Tag to apply to the VM instance during creation.", "type": "string" }, - "staticFile": { - "description": "Static file content to be served for this error.", + "name": { + "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.", "type": "string" } }, - "id": "ErrorHandler" + "id": "Network" }, "Application": { "description": "An Application resource contains the top-level configuration of an App Engine application.", @@ -1529,13 +1753,13 @@ "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", "type": "string" }, + "iap": { + "$ref": "IdentityAwareProxy" + }, "authDomain": { "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.", "type": "string" }, - "iap": { - "$ref": "IdentityAwareProxy" - }, "id": { "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", "type": "string" @@ -1567,87 +1791,10 @@ }, "id": "Application" }, - "Network": { - "description": "Extra network settings. Only applicable for VM runtimes.", - "type": "object", - "properties": { - "forwardedPorts": { - "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.", - "type": "array", - "items": { - "type": "string" - } - }, - "instanceTag": { - "description": "Tag to apply to the VM instance during creation.", - "type": "string" - }, - "name": { - "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.", - "type": "string" - } - }, - "id": "Network" - }, "Instance": { "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.", "type": "object", "properties": { - "averageLatency": { - "description": "Average latency (ms) over the last minute.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "id": { - "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", - "type": "string" - }, - "memoryUsage": { - "description": "Total memory in use (bytes).@OutputOnly", - "format": "int64", - "type": "string" - }, - "vmIp": { - "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "vmStatus": { - "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "availability": { - "enumDescriptions": [ - "", - "", - "" - ], - "enum": [ - "UNSPECIFIED", - "RESIDENT", - "DYNAMIC" - ], - "description": "Availability of the instance.@OutputOnly", - "type": "string" - }, - "errors": { - "description": "Number of errors since this instance was started.@OutputOnly", - "format": "uint32", - "type": "integer" - }, - "requests": { - "description": "Number of requests since this instance was started.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "appEngineRelease": { - "description": "App Engine release this instance is running on.@OutputOnly", - "type": "string" - }, - "startTimestamp": { - "description": "Time that this instance was started.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, "vmName": { "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", "type": "string" @@ -1672,37 +1819,65 @@ "vmUnlocked": { "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly", "type": "boolean" + }, + "averageLatency": { + "description": "Average latency (ms) over the last minute.@OutputOnly", + "format": "int32", + "type": "integer" + }, + "vmIp": { + "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "memoryUsage": { + "description": "Total memory in use (bytes).@OutputOnly", + "format": "int64", + "type": "string" + }, + "id": { + "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", + "type": "string" + }, + "vmStatus": { + "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "availability": { + "description": "Availability of the instance.@OutputOnly", + "type": "string", + "enumDescriptions": [ + "", + "", + "" + ], + "enum": [ + "UNSPECIFIED", + "RESIDENT", + "DYNAMIC" + ] + }, + "errors": { + "description": "Number of errors since this instance was started.@OutputOnly", + "format": "uint32", + "type": "integer" + }, + "requests": { + "description": "Number of requests since this instance was started.@OutputOnly", + "format": "int32", + "type": "integer" + }, + "appEngineRelease": { + "description": "App Engine release this instance is running on.@OutputOnly", + "type": "string" + }, + "startTimestamp": { + "description": "Time that this instance was started.@OutputOnly", + "format": "google-datetime", + "type": "string" } }, "id": "Instance" }, - "NetworkUtilization": { - "properties": { - "targetSentPacketsPerSec": { - "description": "Target packets sent per second.", - "format": "int32", - "type": "integer" - }, - "targetSentBytesPerSec": { - "description": "Target bytes sent per second.", - "format": "int32", - "type": "integer" - }, - "targetReceivedPacketsPerSec": { - "description": "Target packets received per second.", - "format": "int32", - "type": "integer" - }, - "targetReceivedBytesPerSec": { - "description": "Target bytes received per second.", - "format": "int32", - "type": "integer" - } - }, - "id": "NetworkUtilization", - "description": "Target scaling by network usage. Only applicable for VM runtimes.", - "type": "object" - }, "Location": { "description": "A resource that represents Google Cloud Platform location.", "type": "object", @@ -1723,16 +1898,43 @@ "type": "string" }, "metadata": { - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" } }, "id": "Location" }, + "NetworkUtilization": { + "description": "Target scaling by network usage. Only applicable for VM runtimes.", + "type": "object", + "properties": { + "targetReceivedBytesPerSec": { + "description": "Target bytes received per second.", + "format": "int32", + "type": "integer" + }, + "targetSentPacketsPerSec": { + "description": "Target packets sent per second.", + "format": "int32", + "type": "integer" + }, + "targetSentBytesPerSec": { + "description": "Target bytes sent per second.", + "format": "int32", + "type": "integer" + }, + "targetReceivedPacketsPerSec": { + "description": "Target packets received per second.", + "format": "int32", + "type": "integer" + } + }, + "id": "NetworkUtilization" + }, "HealthCheck": { "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.", "type": "object", @@ -1755,13 +1957,13 @@ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"", "type": "string" }, - "restartThreshold": { - "description": "Number of consecutive failed health checks required before an instance is restarted.", + "healthyThreshold": { + "description": "Number of consecutive successful health checks required before receiving traffic.", "format": "uint32", "type": "integer" }, - "healthyThreshold": { - "description": "Number of consecutive successful health checks required before receiving traffic.", + "restartThreshold": { + "description": "Number of consecutive failed health checks required before an instance is restarted.", "format": "uint32", "type": "integer" }, @@ -1773,36 +1975,42 @@ }, "id": "HealthCheck" }, - "SourceReference": { - "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.", - "type": "object", - "properties": { - "revisionId": { - "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"", - "type": "string" - }, - "repository": { - "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"", - "type": "string" - } - }, - "id": "SourceReference" - }, "DebugInstanceRequest": { - "description": "Request message for Instances.DebugInstance.", - "type": "object", "properties": { "sshKey": { "description": "Public SSH key to add to the instance. Examples:\n[USERNAME]:ssh-rsa [KEY_VALUE] [USERNAME]\n[USERNAME]:ssh-rsa [KEY_VALUE] google-ssh {\"userName\":\"[USERNAME]\",\"expireOn\":\"[EXPIRE_TIME]\"}For more information, see Adding and Removing SSH Keys (https://cloud.google.com/compute/docs/instances/adding-removing-ssh-keys).", "type": "string" } }, - "id": "DebugInstanceRequest" + "id": "DebugInstanceRequest", + "description": "Request message for Instances.DebugInstance.", + "type": "object" }, - "OperationMetadataV1Beta5": { - "description": "Metadata for the given google.longrunning.Operation.", + "SourceReference": { + "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.", "type": "object", "properties": { + "repository": { + "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"", + "type": "string" + }, + "revisionId": { + "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"", + "type": "string" + } + }, + "id": "SourceReference" + }, + "OperationMetadataV1Beta5": { + "properties": { + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, "method": { "description": "API method name that initiated this operation. Example: google.appengine.v1beta5.Version.CreateVersion.@OutputOnly", "type": "string" @@ -1816,17 +2024,11 @@ "description": "Timestamp that this operation completed.@OutputOnly", "format": "google-datetime", "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" } }, - "id": "OperationMetadataV1Beta5" + "id": "OperationMetadataV1Beta5", + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object" }, "CreateVersionMetadataV1Alpha": { "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", @@ -1840,14 +2042,39 @@ "id": "CreateVersionMetadataV1Alpha" }, "Version": { + "description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.", + "type": "object", "properties": { - "betaSettings": { + "basicScaling": { + "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", + "$ref": "BasicScaling" + }, + "runtime": { + "description": "Desired runtime. Example: python27.", + "type": "string" + }, + "id": { + "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".", + "type": "string" + }, + "envVariables": { "additionalProperties": { "type": "string" }, - "description": "Metadata settings that are supplied to this version to enable beta runtime features.", + "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.", "type": "object" }, + "network": { + "description": "Extra network settings. Only applicable for VM runtimes.", + "$ref": "Network" + }, + "betaSettings": { + "description": "Metadata settings that are supplied to this version to enable beta runtime features.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "env": { "description": "App Engine execution environment to use for this version.Defaults to 1.", "type": "string" @@ -1864,8 +2091,8 @@ "type": "string" }, "automaticScaling": { - "$ref": "AutomaticScaling", - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics." + "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", + "$ref": "AutomaticScaling" }, "healthCheck": { "description": "Configures health checking for VM instances. Unhealthy instances are stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.", @@ -1900,18 +2127,18 @@ "type": "string" }, "servingStatus": { + "enumDescriptions": [ + "Not specified.", + "Currently serving. Instances are created according to the scaling settings of the version.", + "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING." + ], "enum": [ "SERVING_STATUS_UNSPECIFIED", "SERVING", "STOPPED" ], "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.", - "type": "string", - "enumDescriptions": [ - "Not specified.", - "Currently serving. Instances are created according to the scaling settings of the version.", - "Disabled. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING." - ] + "type": "string" }, "runtimeApiVersion": { "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref", @@ -1922,20 +2149,10 @@ "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." }, "inboundServices": { - "enumDescriptions": [ - "Not specified.", - "Allows an application to receive mail.", - "Allows an application to receive email-bound notifications.", - "Allows an application to receive error stanzas.", - "Allows an application to receive instant messages.", - "Allows an application to receive user subscription POSTs.", - "Allows an application to receive a user's chat presence.", - "Registers an application for notifications when a client connects or disconnects from a channel.", - "Enables warmup requests." - ], "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.", "type": "array", "items": { + "type": "string", "enum": [ "INBOUND_SERVICE_UNSPECIFIED", "INBOUND_SERVICE_MAIL", @@ -1946,13 +2163,23 @@ "INBOUND_SERVICE_XMPP_PRESENCE", "INBOUND_SERVICE_CHANNEL_PRESENCE", "INBOUND_SERVICE_WARMUP" - ], - "type": "string" - } + ] + }, + "enumDescriptions": [ + "Not specified.", + "Allows an application to receive mail.", + "Allows an application to receive email-bound notifications.", + "Allows an application to receive error stanzas.", + "Allows an application to receive instant messages.", + "Allows an application to receive user subscription POSTs.", + "Allows an application to receive a user's chat presence.", + "Registers an application for notifications when a client connects or disconnects from a channel.", + "Enables warmup requests." + ] }, "resources": { - "description": "Machine resources for this version. Only applicable for VM runtimes.", - "$ref": "Resources" + "$ref": "Resources", + "description": "Machine resources for this version. Only applicable for VM runtimes." }, "errorHandlers": { "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.", @@ -1981,45 +2208,20 @@ "description": "Time that this version was created.@OutputOnly", "format": "google-datetime", "type": "string" - }, - "basicScaling": { - "$ref": "BasicScaling", - "description": "A module with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity." - }, - "runtime": { - "description": "Desired runtime. Example: python27.", - "type": "string" - }, - "id": { - "description": "Relative name of the version within the module. Example: v1. Version names can contain only lowercase letters, numbers, or hyphens. Reserved names: \"default\", \"latest\", and any name with the prefix \"ah-\".", - "type": "string" - }, - "envVariables": { - "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "network": { - "description": "Extra network settings. Only applicable for VM runtimes.", - "$ref": "Network" } }, - "id": "Version", - "description": "A Version resource is a specific set of source code and configuration files that are deployed into a module.", - "type": "object" + "id": "Version" }, "ScriptHandler": { - "description": "Executes a script to handle the request that matches the URL pattern.", - "type": "object", "properties": { "scriptPath": { "description": "Path to the script from the application root directory.", "type": "string" } }, - "id": "ScriptHandler" + "id": "ScriptHandler", + "description": "Executes a script to handle the request that matches the URL pattern.", + "type": "object" }, "FileInfo": { "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.", @@ -2043,8 +2245,6 @@ "TrafficSplit": { "properties": { "shardBy": { - "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.", - "type": "string", "enumDescriptions": [ "Diversion method unspecified.", "Diversion based on a specially named cookie, \"GOOGAPPUID.\" The cookie must be set by the application itself or else no diversion will occur.", @@ -2054,15 +2254,17 @@ "UNSPECIFIED", "COOKIE", "IP" - ] + ], + "description": "Mechanism used to determine which version a request is sent to. The traffic selection algorithm will be stable for either type until allocations are changed.", + "type": "string" }, "allocations": { - "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.", - "type": "object", "additionalProperties": { "format": "double", "type": "number" - } + }, + "description": "Mapping from version IDs within the module to fractional (0.000, 1] allocations of traffic for that version. Each version can be specified only once, but some versions in the module may not have any traffic allocation. Modules that have traffic allocated cannot be deleted until either the module is deleted or their traffic allocation is removed. Allocations must sum to 1. Up to two decimal place precision is supported for IP-based splits and up to three decimal places is supported for cookie-based splits.", + "type": "object" } }, "id": "TrafficSplit", @@ -2070,9 +2272,19 @@ "type": "object" }, "OperationMetadataV1Beta": { - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object", "properties": { + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", + "type": "string" + }, + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Beta" + }, "warning": { "description": "Durable messages that persist on every operation poll. @OutputOnly", "type": "array", @@ -2096,21 +2308,11 @@ "ephemeralMessage": { "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Beta" } }, - "id": "OperationMetadataV1Beta" + "id": "OperationMetadataV1Beta", + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object" }, "ListModulesResponse": { "description": "Response message for Modules.ListModules.", @@ -2130,8 +2332,45 @@ }, "id": "ListModulesResponse" }, - "Resources": { + "Deployment": { "properties": { + "files": { + "additionalProperties": { + "$ref": "FileInfo" + }, + "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", + "type": "object" + }, + "container": { + "$ref": "ContainerInfo", + "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment." + }, + "sourceReferences": { + "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.", + "type": "array", + "items": { + "$ref": "SourceReference" + } + } + }, + "id": "Deployment", + "description": "Code and application artifacts used to deploy a version to App Engine.", + "type": "object" + }, + "Resources": { + "description": "Machine resources for a version.", + "type": "object", + "properties": { + "cpu": { + "description": "Number of CPU cores needed.", + "format": "double", + "type": "number" + }, + "memoryGb": { + "description": "Memory (GB) needed.", + "format": "double", + "type": "number" + }, "volumes": { "description": "User specified volumes.", "type": "array", @@ -2143,50 +2382,11 @@ "description": "Disk size (GB) needed.", "format": "double", "type": "number" - }, - "cpu": { - "description": "Number of CPU cores needed.", - "format": "double", - "type": "number" - }, - "memoryGb": { - "description": "Memory (GB) needed.", - "format": "double", - "type": "number" } }, - "id": "Resources", - "description": "Machine resources for a version.", - "type": "object" - }, - "Deployment": { - "description": "Code and application artifacts used to deploy a version to App Engine.", - "type": "object", - "properties": { - "container": { - "$ref": "ContainerInfo", - "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment." - }, - "sourceReferences": { - "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.", - "type": "array", - "items": { - "$ref": "SourceReference" - } - }, - "files": { - "additionalProperties": { - "$ref": "FileInfo" - }, - "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", - "type": "object" - } - }, - "id": "Deployment" + "id": "Resources" }, "Volume": { - "description": "Volumes mounted within the app container. Only applicable for VM runtimes.", - "type": "object", "properties": { "sizeGb": { "description": "Volume size in gigabytes.", @@ -2202,239 +2402,39 @@ "type": "string" } }, - "id": "Volume" - }, - "ListInstancesResponse": { - "description": "Response message for Instances.ListInstances.", - "type": "object", - "properties": { - "instances": { - "description": "The instances belonging to the requested version.", - "type": "array", - "items": { - "$ref": "Instance" - } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "id": "ListInstancesResponse" - }, - "OperationMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object", - "properties": { - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Alpha" - } - }, - "id": "OperationMetadataV1Alpha" - }, - "UrlDispatchRule": { - "properties": { - "domain": { - "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", - "type": "string" - }, - "module": { - "description": "Resource ID of a module in this application that should serve the matched request. The module must already exist. Example: default.", - "type": "string" - }, - "path": { - "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.", - "type": "string" - } - }, - "id": "UrlDispatchRule", - "description": "Rules to match an HTTP request and dispatch that request to a module.", - "type": "object" - }, - "ListVersionsResponse": { - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "versions": { - "description": "The versions belonging to the requested module.", - "type": "array", - "items": { - "$ref": "Version" - } - } - }, - "id": "ListVersionsResponse", - "description": "Response message for Versions.ListVersions.", - "type": "object" - }, - "Module": { - "description": "A Module resource is a logical component of an application that can share state and communicate in a secure fashion with other modules. For example, an application that handles customer requests might include separate modules to handle tasks such as backend data analysis or API requests from mobile devices. Each module has a collection of versions that define a specific set of code used to implement the functionality of that module.", - "type": "object", - "properties": { - "name": { - "description": "Full path to the Module resource in the API. Example: apps/myapp/modules/default.@OutputOnly", - "type": "string" - }, - "split": { - "$ref": "TrafficSplit", - "description": "Mapping that defines fractional HTTP traffic diversion to different versions within the module." - }, - "id": { - "description": "Relative name of the module within the application. Example: default.@OutputOnly", - "type": "string" - } - }, - "id": "Module" - }, - "ApiEndpointHandler": { - "description": "Uses Google Cloud Endpoints to handle requests.", - "type": "object", - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "id": "ApiEndpointHandler" - }, - "StaticDirectoryHandler": { - "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static directory handlers make it easy to serve the entire contents of a directory as static files.", - "type": "object", - "properties": { - "mimeType": { - "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are direved from each file's filename extension.", - "type": "string" - }, - "requireMatchingFile": { - "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", - "type": "boolean" - }, - "expiration": { - "description": "Time a static file served by this handler should be cached.", - "format": "google-duration", - "type": "string" - }, - "applicationReadable": { - "description": "Whether files should also be uploaded as code data. By default, files declared in static directory handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", - "type": "boolean" - }, - "httpHeaders": { - "additionalProperties": { - "type": "string" - }, - "description": "HTTP headers to use for all responses from these URLs.", - "type": "object" - }, - "directory": { - "description": "Path to the directory containing the static files from the application root directory. Everything after the end of the matched URL pattern is appended to static_dir to form the full path to the requested file.", - "type": "string" - } - }, - "id": "StaticDirectoryHandler" - }, - "AutomaticScaling": { - "properties": { - "diskUtilization": { - "description": "Target scaling by disk usage.", - "$ref": "DiskUtilization" - }, - "minPendingLatency": { - "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "maxIdleInstances": { - "description": "Maximum number of idle instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "requestUtilization": { - "$ref": "RequestUtilization", - "description": "Target scaling by request utilization." - }, - "minIdleInstances": { - "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.", - "format": "int32", - "type": "integer" - }, - "maxTotalInstances": { - "description": "Maximum number of instances that should be started to handle requests.", - "format": "int32", - "type": "integer" - }, - "minTotalInstances": { - "description": "Minimum number of instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "networkUtilization": { - "$ref": "NetworkUtilization", - "description": "Target scaling by network usage." - }, - "coolDownPeriod": { - "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.", - "format": "google-duration", - "type": "string" - }, - "maxConcurrentRequests": { - "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", - "format": "int32", - "type": "integer" - }, - "maxPendingLatency": { - "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "cpuUtilization": { - "$ref": "CpuUtilization", - "description": "Target scaling by CPU usage." - } - }, - "id": "AutomaticScaling", - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", + "id": "Volume", + "description": "Volumes mounted within the app container. Only applicable for VM runtimes.", "type": "object" } }, + "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest", - "version": "v1beta4" + "version": "v1beta4", + "baseUrl": "https://appengine.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/appengine.admin": { + "description": "View and manage your applications deployed on Google App Engine" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", + "servicePath": "", + "rootUrl": "https://appengine.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "appengine", + "batchPath": "batch" }
diff --git a/appengine/v1beta5/appengine-api.json b/appengine/v1beta5/appengine-api.json index 877fc5d..c90c0ba 100644 --- a/appengine/v1beta5/appengine-api.json +++ b/appengine/v1beta5/appengine-api.json
@@ -1,186 +1,27 @@ { - "revision": "20171220", - "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", - "id": "appengine:v1beta5", "title": "Google App Engine Admin API", - "discoveryVersion": "v1", "ownerName": "Google", + "discoveryVersion": "v1", "resources": { "apps": { - "methods": { - "get": { - "flatPath": "v1beta5/apps/{appsId}", - "path": "v1beta5/apps/{appsId}", - "id": "appengine.apps.get", - "description": "Gets information about an application.", - "response": { - "$ref": "Application" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "ensureResourcesExist": { - "location": "query", - "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.", - "type": "boolean" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the application to get. Example: apps/myapp.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "patch": { - "request": { - "$ref": "Application" - }, - "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "PATCH", - "parameters": { - "mask": { - "location": "query", - "description": "Standard field mask for the set of fields to be updated.", - "format": "google-fieldmask", - "type": "string" - }, - "appsId": { - "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta5/apps/{appsId}", - "path": "v1beta5/apps/{appsId}", - "id": "appengine.apps.patch" - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {}, - "flatPath": "v1beta5/apps", - "path": "v1beta5/apps", - "id": "appengine.apps.create", - "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/).", - "request": { - "$ref": "Application" - } - } - }, "resources": { - "locations": { - "methods": { - "list": { - "flatPath": "v1beta5/apps/{appsId}/locations", - "path": "v1beta5/apps/{appsId}/locations", - "id": "appengine.apps.locations.list", - "description": "Lists information about the supported locations for this service.", - "response": { - "$ref": "ListLocationsResponse" - }, - "parameterOrder": [ - "appsId" - ], - "httpMethod": "GET", - "parameters": { - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - }, - "appsId": { - "description": "Part of `name`. The resource that owns the locations collection, if applicable.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "get": { - "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}", - "id": "appengine.apps.locations.get", - "path": "v1beta5/apps/{appsId}/locations/{locationsId}", - "description": "Get information about a location.", - "httpMethod": "GET", - "response": { - "$ref": "Location" - }, - "parameterOrder": [ - "appsId", - "locationsId" - ], - "parameters": { - "appsId": { - "description": "Part of `name`. Resource name for the location.", - "required": true, - "type": "string", - "location": "path" - }, - "locationsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - }, "services": { "methods": { - "get": { - "description": "Gets the current configuration of the specified service.", + "delete": { + "path": "v1beta5/apps/{appsId}/services/{servicesId}", + "id": "appengine.apps.services.delete", + "description": "Deletes the specified service and all enclosed versions.", "response": { - "$ref": "Service" + "$ref": "Operation" }, "parameterOrder": [ "appsId", "servicesId" ], - "httpMethod": "GET", + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "servicesId": { "location": "path", @@ -189,23 +30,48 @@ "type": "string" }, "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, + "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}" + }, + "get": { + "response": { + "$ref": "Service" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], + "parameters": { + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "required": true, + "type": "string" + } + }, "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}", "path": "v1beta5/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.get" + "id": "appengine.apps.services.get", + "description": "Gets the current configuration of the specified service." }, "list": { - "description": "Lists all the services in the application.", "response": { "$ref": "ListServicesResponse" }, @@ -215,16 +81,16 @@ "httpMethod": "GET", "parameters": { "pageSize": { - "location": "query", "description": "Maximum results to return per page.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "pageToken": { "description": "Continuation token for fetching the next page of results.", @@ -239,15 +105,17 @@ ], "flatPath": "v1beta5/apps/{appsId}/services", "path": "v1beta5/apps/{appsId}/services", - "id": "appengine.apps.services.list" + "id": "appengine.apps.services.list", + "description": "Lists all the services in the application." }, "patch": { + "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}", "path": "v1beta5/apps/{appsId}/services/{servicesId}", "id": "appengine.apps.services.patch", + "description": "Updates the configuration of the specified service.", "request": { "$ref": "Service" }, - "description": "Updates the configuration of the specified service.", "response": { "$ref": "Operation" }, @@ -256,18 +124,21 @@ "servicesId" ], "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "servicesId": { - "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "appsId": { - "location": "path", "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "migrateTraffic": { "location": "query", @@ -280,50 +151,13 @@ "format": "google-fieldmask", "type": "string" } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}" - }, - "delete": { - "description": "Deletes the specified service and all enclosed versions.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "DELETE", - "parameters": { - "servicesId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}", - "path": "v1beta5/apps/{appsId}/services/{servicesId}", - "id": "appengine.apps.services.delete" + } } }, "resources": { "versions": { "methods": { "delete": { - "description": "Deletes an existing version.", - "httpMethod": "DELETE", "response": { "$ref": "Operation" }, @@ -332,6 +166,10 @@ "servicesId", "versionsId" ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "servicesId": { "location": "path", @@ -340,24 +178,22 @@ "type": "string" }, "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "versionsId": { + "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", "id": "appengine.apps.services.versions.delete", - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}" + "description": "Deletes an existing version." }, "get": { "description": "Gets the specified Version resource. By default, only a BASIC_VIEW will be returned. Specify the FULL_VIEW parameter to get the full resource.", @@ -370,25 +206,18 @@ "versionsId" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { - "servicesId": { - "location": "path", + "versionsId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" - }, - "appsId": { - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", - "required": true, "type": "string", "location": "path" }, - "versionsId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, "view": { "location": "query", "enum": [ @@ -397,35 +226,7 @@ ], "description": "Controls the set of fields returned in the Get response.", "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "id": "appengine.apps.services.versions.get" - }, - "list": { - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions", - "id": "appengine.apps.services.versions.list", - "description": "Lists the versions of a service.", - "response": { - "$ref": "ListVersionsResponse" - }, - "parameterOrder": [ - "appsId", - "servicesId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { + }, "servicesId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, @@ -434,9 +235,33 @@ }, "appsId": { "location": "path", - "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", "required": true, "type": "string" + } + }, + "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", + "id": "appengine.apps.services.versions.get" + }, + "list": { + "id": "appengine.apps.services.versions.list", + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions", + "description": "Lists the versions of a service.", + "httpMethod": "GET", + "response": { + "$ref": "ListVersionsResponse" + }, + "parameterOrder": [ + "appsId", + "servicesId" + ], + "parameters": { + "appsId": { + "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default.", + "required": true, + "type": "string", + "location": "path" }, "pageToken": { "description": "Continuation token for fetching the next page of results.", @@ -444,49 +269,49 @@ "location": "query" }, "pageSize": { - "location": "query", "description": "Maximum results to return per page.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "view": { + "description": "Controls the set of fields returned in the List response.", + "type": "string", "location": "query", "enum": [ "BASIC", "FULL" - ], - "description": "Controls the set of fields returned in the List response.", - "type": "string" - } - }, - "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions" - }, - "patch": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "appsId", - "servicesId", - "versionsId" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { + ] + }, "servicesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" - }, - "appsId": { - "location": "path", - "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", - "required": true, - "type": "string" - }, + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions" + }, + "patch": { + "request": { + "$ref": "Version" + }, + "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.", + "httpMethod": "PATCH", + "parameterOrder": [ + "appsId", + "servicesId", + "versionsId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { "versionsId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", @@ -498,15 +323,26 @@ "format": "google-fieldmask", "type": "string", "location": "query" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "appsId": { + "description": "Part of `name`. Name of the resource to update. Example: apps/myapp/services/default/versions/1.", + "required": true, + "type": "string", + "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}", "id": "appengine.apps.services.versions.patch", - "description": "Updates the specified Version resource. You can specify the following fields depending on the App Engine environment and type of scaling that the version resource uses:\nserving_status (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.serving_status): For Version resources that use basic scaling, manual scaling, or run in the App Engine flexible environment.\ninstance_class (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.instance_class): For Version resources that run in the App Engine standard environment.\nautomatic_scaling.min_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.\nautomatic_scaling.max_idle_instances (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps.services.versions#Version.FIELDS.automatic_scaling): For Version resources that use automatic scaling and run in the App Engine standard environment.", - "request": { - "$ref": "Version" - } + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}" }, "create": { "description": "Deploys new code and resource files to a new version.", @@ -526,16 +362,16 @@ ], "parameters": { "servicesId": { - "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" - }, - "appsId": { - "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".", - "required": true, "type": "string", "location": "path" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the resource to update. For example: \"apps/myapp/services/default\".", + "required": true, + "type": "string" } }, "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions", @@ -547,6 +383,7 @@ "instances": { "methods": { "delete": { + "description": "Stops a running instance.", "httpMethod": "DELETE", "response": { "$ref": "Operation" @@ -559,23 +396,23 @@ ], "parameters": { "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. For example: \"apps/myapp/services/default/versions/v1/instances/instance-1\".", "required": true, + "type": "string" + }, + "instancesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, "type": "string", "location": "path" }, - "instancesId": { + "versionsId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, "servicesId": { "description": "Part of `name`. See documentation of `appsId`.", "required": true, @@ -588,38 +425,26 @@ ], "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", "id": "appengine.apps.services.versions.instances.delete", - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "description": "Stops a running instance." + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}" }, "get": { "description": "Gets instance information.", - "response": { - "$ref": "Instance" - }, + "httpMethod": "GET", "parameterOrder": [ "appsId", "servicesId", "versionsId", "instancesId" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/appengine.admin", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], + "response": { + "$ref": "Instance" + }, "parameters": { - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" - }, "appsId": { + "location": "path", "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "instancesId": { "location": "path", @@ -628,17 +453,29 @@ "type": "string" }, "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "servicesId": { "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}", - "id": "appengine.apps.services.versions.instances.get" + "id": "appengine.apps.services.versions.instances.get", + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}" }, "list": { + "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list).", "response": { "$ref": "ListInstancesResponse" }, @@ -655,10 +492,10 @@ ], "parameters": { "servicesId": { - "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "appsId": { "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1.", @@ -672,24 +509,25 @@ "type": "string" }, "pageSize": { + "location": "query", "description": "Maximum results to return per page.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" }, "versionsId": { + "location": "path", "description": "Part of `name`. See documentation of `appsId`.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances", - "id": "appengine.apps.services.versions.instances.list", - "description": "Lists the instances of a version.Tip: To aggregate details about instances over time, see the Stackdriver Monitoring API (https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.timeSeries/list)." + "id": "appengine.apps.services.versions.instances.list" }, "debug": { + "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", + "id": "appengine.apps.services.versions.instances.debug", "description": "Enables debugging on a VM instance. This allows you to use the SSH command to connect to the virtual machine where the instance lives. While in \"debug mode\", the instance continues to serve live traffic. You should delete the instance when you are done debugging and then allow the system to take over and determine if another instance should be started.Only applicable for instances in App Engine flexible environment.", "request": { "$ref": "DebugInstanceRequest" @@ -708,6 +546,18 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { + "versionsId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, + "servicesId": { + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string", + "location": "path" + }, "appsId": { "description": "Part of `name`. Name of the resource requested. Example: apps/myapp/services/default/versions/v1/instances/instance-1.", "required": true, @@ -719,23 +569,9 @@ "description": "Part of `name`. See documentation of `appsId`.", "required": true, "type": "string" - }, - "versionsId": { - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string", - "location": "path" - }, - "servicesId": { - "location": "path", - "description": "Part of `name`. See documentation of `appsId`.", - "required": true, - "type": "string" } }, - "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", - "path": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug", - "id": "appengine.apps.services.versions.instances.debug" + "flatPath": "v1beta5/apps/{appsId}/services/{servicesId}/versions/{versionsId}/instances/{instancesId}:debug" } } } @@ -746,7 +582,6 @@ "operations": { "methods": { "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", "response": { "$ref": "ListOperationsResponse" }, @@ -755,6 +590,12 @@ ], "httpMethod": "GET", "parameters": { + "pageSize": { + "location": "query", + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + }, "filter": { "location": "query", "description": "The standard list filter.", @@ -770,12 +611,6 @@ "description": "The standard list page token.", "type": "string", "location": "query" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" } }, "scopes": [ @@ -785,11 +620,11 @@ ], "flatPath": "v1beta5/apps/{appsId}/operations", "path": "v1beta5/apps/{appsId}/operations", - "id": "appengine.apps.operations.list" + "id": "appengine.apps.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." }, "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", "response": { "$ref": "Operation" }, @@ -797,12 +632,18 @@ "appsId", "operationsId" ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { "appsId": { - "location": "path", "description": "Part of `name`. The name of the operation resource.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "operationsId": { "location": "path", @@ -811,17 +652,173 @@ "type": "string" } }, + "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}", + "path": "v1beta5/apps/{appsId}/operations/{operationsId}", + "id": "appengine.apps.operations.get" + } + } + }, + "locations": { + "methods": { + "list": { + "path": "v1beta5/apps/{appsId}/locations", + "id": "appengine.apps.locations.list", + "description": "Lists information about the supported locations for this service.", + "response": { + "$ref": "ListLocationsResponse" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. The resource that owns the locations collection, if applicable.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/appengine.admin", "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1beta5/apps/{appsId}/operations/{operationsId}", - "id": "appengine.apps.operations.get", - "path": "v1beta5/apps/{appsId}/operations/{operationsId}" + "flatPath": "v1beta5/apps/{appsId}/locations" + }, + "get": { + "description": "Get information about a location.", + "response": { + "$ref": "Location" + }, + "parameterOrder": [ + "appsId", + "locationsId" + ], + "httpMethod": "GET", + "parameters": { + "locationsId": { + "location": "path", + "description": "Part of `name`. See documentation of `appsId`.", + "required": true, + "type": "string" + }, + "appsId": { + "description": "Part of `name`. Resource name for the location.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/appengine.admin", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta5/apps/{appsId}/locations/{locationsId}", + "path": "v1beta5/apps/{appsId}/locations/{locationsId}", + "id": "appengine.apps.locations.get" } } } + }, + "methods": { + "get": { + "response": { + "$ref": "Application" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "GET", + "parameters": { + "ensureResourcesExist": { + "location": "query", + "description": "Certain resources associated with an application are created on-demand. Controls whether these resources should be created when performing the GET operation. If specified and any resources could not be created, the request will fail with an error code. Additionally, this parameter can cause the request to take longer to complete. Note: This parameter will be deprecated in a future version of the API.", + "type": "boolean" + }, + "appsId": { + "description": "Part of `name`. Name of the application to get. Example: apps/myapp.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta5/apps/{appsId}", + "path": "v1beta5/apps/{appsId}", + "id": "appengine.apps.get", + "description": "Gets information about an application." + }, + "patch": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "appsId" + ], + "httpMethod": "PATCH", + "parameters": { + "mask": { + "description": "Standard field mask for the set of fields to be updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "appsId": { + "location": "path", + "description": "Part of `name`. Name of the Application resource to update. Example: apps/myapp.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta5/apps/{appsId}", + "path": "v1beta5/apps/{appsId}", + "id": "appengine.apps.patch", + "request": { + "$ref": "Application" + }, + "description": "Updates the specified Application resource. You can update the following fields:\nauth_domain (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.auth_domain)\ndefault_cookie_expiration (https://cloud.google.com/appengine/docs/admin-api/reference/rest/v1beta5/apps#Application.FIELDS.default_cookie_expiration)" + }, + "create": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta5/apps", + "path": "v1beta5/apps", + "id": "appengine.apps.create", + "request": { + "$ref": "Application" + }, + "description": "Creates an App Engine application for a Google Cloud Platform project. Required fields:\nid - The ID of the target Cloud Platform project.\nlocation - The region (https://cloud.google.com/appengine/docs/locations) where you want the App Engine application located.For more information about App Engine applications, see Managing Projects, Applications, and Billing (https://cloud.google.com/appengine/docs/python/console/)." + } } } }, @@ -848,9 +845,9 @@ "type": "string" }, "access_token": { - "location": "query", "description": "OAuth access token.", - "type": "string" + "type": "string", + "location": "query" }, "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.", @@ -863,16 +860,16 @@ "default": "true", "location": "query" }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", @@ -890,504 +887,34 @@ "type": "string" }, "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { "location": "query", - "description": "JSONP", + "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], "location": "query" } }, "schemas": { - "ListInstancesResponse": { - "description": "Response message for Instances.ListInstances.", - "type": "object", - "properties": { - "instances": { - "description": "The instances belonging to the requested version.", - "type": "array", - "items": { - "$ref": "Instance" - } - }, - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - } - }, - "id": "ListInstancesResponse" - }, - "ErrorHandler": { - "description": "Custom static error page to be served when an error occurs.", - "type": "object", - "properties": { - "errorCode": { - "description": "Error condition this handler applies to.", - "type": "string", - "enumDescriptions": [ - "Not specified. ERROR_CODE_DEFAULT is assumed.", - "All other error types.", - "Application has exceeded a resource quota.", - "Client blocked by the application's Denial of Service protection configuration.", - "Deadline reached before the application responds." - ], - "enum": [ - "ERROR_CODE_UNSPECIFIED", - "ERROR_CODE_DEFAULT", - "ERROR_CODE_OVER_QUOTA", - "ERROR_CODE_DOS_API_DENIAL", - "ERROR_CODE_TIMEOUT" - ] - }, - "mimeType": { - "description": "MIME type of file. Defaults to text/html.", - "type": "string" - }, - "staticFile": { - "description": "Static file content to be served for this error.", - "type": "string" - } - }, - "id": "ErrorHandler" - }, - "OperationMetadataV1": { - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object", - "properties": { - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - } - }, - "id": "OperationMetadataV1" - }, - "OperationMetadataV1Alpha": { - "properties": { - "warning": { - "description": "Durable messages that persist on every operation poll. @OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "insertTime": { - "description": "Time that this operation was created.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "user": { - "description": "User who requested this operation.@OutputOnly", - "type": "string" - }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", - "type": "string" - }, - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "createVersionMetadata": { - "$ref": "CreateVersionMetadataV1Alpha" - } - }, - "id": "OperationMetadataV1Alpha", - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object" - }, - "Network": { - "description": "Extra network settings. Only applicable for VM runtimes.", - "type": "object", - "properties": { - "forwardedPorts": { - "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.", - "type": "array", - "items": { - "type": "string" - } - }, - "instanceTag": { - "description": "Tag to apply to the VM instance during creation.", - "type": "string" - }, - "subnetworkName": { - "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.", - "type": "string" - }, - "name": { - "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.", - "type": "string" - } - }, - "id": "Network" - }, - "Application": { - "properties": { - "codeBucket": { - "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly", - "type": "string" - }, - "location": { - "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US", - "type": "string" - }, - "defaultBucket": { - "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly", - "type": "string" - }, - "dispatchRules": { - "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly", - "type": "array", - "items": { - "$ref": "UrlDispatchRule" - } - }, - "defaultHostname": { - "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly", - "type": "string" - }, - "name": { - "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", - "type": "string" - }, - "iap": { - "$ref": "IdentityAwareProxy" - }, - "authDomain": { - "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.", - "type": "string" - }, - "defaultCookieExpiration": { - "description": "Cookie expiration policy for this application.", - "format": "google-duration", - "type": "string" - }, - "id": { - "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", - "type": "string" - } - }, - "id": "Application", - "description": "An Application resource contains the top-level configuration of an App Engine application.", - "type": "object" - }, - "UrlDispatchRule": { - "properties": { - "path": { - "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.", - "type": "string" - }, - "domain": { - "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", - "type": "string" - }, - "service": { - "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.", - "type": "string" - } - }, - "id": "UrlDispatchRule", - "description": "Rules to match an HTTP request and dispatch that request to a service.", - "type": "object" - }, - "Instance": { - "properties": { - "requests": { - "description": "Number of requests since this instance was started.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "appEngineRelease": { - "description": "App Engine release this instance is running on.@OutputOnly", - "type": "string" - }, - "startTimestamp": { - "description": "Time that this instance was started.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "vmName": { - "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "qps": { - "description": "Average queries per second (QPS) over the last minute.@OutputOnly", - "format": "float", - "type": "number" - }, - "vmId": { - "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "vmZoneName": { - "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "name": { - "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly", - "type": "string" - }, - "vmUnlocked": { - "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "boolean" - }, - "averageLatency": { - "description": "Average latency (ms) over the last minute.@OutputOnly", - "format": "int32", - "type": "integer" - }, - "vmIp": { - "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "memoryUsage": { - "description": "Total memory in use (bytes).@OutputOnly", - "format": "int64", - "type": "string" - }, - "id": { - "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", - "type": "string" - }, - "errors": { - "description": "Number of errors since this instance was started.@OutputOnly", - "format": "uint32", - "type": "integer" - }, - "vmStatus": { - "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", - "type": "string" - }, - "availability": { - "enum": [ - "UNSPECIFIED", - "RESIDENT", - "DYNAMIC" - ], - "description": "Availability of the instance.@OutputOnly", - "type": "string", - "enumDescriptions": [ - "", - "", - "" - ] - } - }, - "id": "Instance", - "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.", - "type": "object" - }, - "ListVersionsResponse": { - "properties": { - "nextPageToken": { - "description": "Continuation token for fetching the next page of results.", - "type": "string" - }, - "versions": { - "description": "The versions belonging to the requested service.", - "type": "array", - "items": { - "$ref": "Version" - } - } - }, - "id": "ListVersionsResponse", - "description": "Response message for Versions.ListVersions.", - "type": "object" - }, - "ApiEndpointHandler": { - "description": "Uses Google Cloud Endpoints to handle requests.", - "type": "object", - "properties": { - "scriptPath": { - "description": "Path to the script from the application root directory.", - "type": "string" - } - }, - "id": "ApiEndpointHandler" - }, - "AutomaticScaling": { - "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", - "type": "object", - "properties": { - "diskUtilization": { - "$ref": "DiskUtilization", - "description": "Target scaling by disk usage." - }, - "minPendingLatency": { - "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "requestUtilization": { - "$ref": "RequestUtilization", - "description": "Target scaling by request utilization." - }, - "maxIdleInstances": { - "description": "Maximum number of idle instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "minIdleInstances": { - "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.", - "format": "int32", - "type": "integer" - }, - "maxTotalInstances": { - "description": "Maximum number of instances that should be started to handle requests.", - "format": "int32", - "type": "integer" - }, - "minTotalInstances": { - "description": "Minimum number of instances that should be maintained for this version.", - "format": "int32", - "type": "integer" - }, - "networkUtilization": { - "$ref": "NetworkUtilization", - "description": "Target scaling by network usage." - }, - "maxConcurrentRequests": { - "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", - "format": "int32", - "type": "integer" - }, - "coolDownPeriod": { - "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.", - "format": "google-duration", - "type": "string" - }, - "maxPendingLatency": { - "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", - "format": "google-duration", - "type": "string" - }, - "cpuUtilization": { - "$ref": "CpuUtilization", - "description": "Target scaling by CPU usage." - } - }, - "id": "AutomaticScaling" - }, - "NetworkUtilization": { - "properties": { - "targetSentPacketsPerSec": { - "description": "Target packets sent per second.", - "format": "int32", - "type": "integer" - }, - "targetSentBytesPerSec": { - "description": "Target bytes sent per second.", - "format": "int32", - "type": "integer" - }, - "targetReceivedPacketsPerSec": { - "description": "Target packets received per second.", - "format": "int32", - "type": "integer" - }, - "targetReceivedBytesPerSec": { - "description": "Target bytes received per second.", - "format": "int32", - "type": "integer" - } - }, - "id": "NetworkUtilization", - "description": "Target scaling by network usage. Only applicable for VM runtimes.", - "type": "object" - }, - "Location": { - "properties": { - "labels": { - "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "name": { - "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", - "type": "string" - }, - "locationId": { - "description": "The canonical id for this location. For example: \"us-east1\".", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given location.", - "type": "object" - } - }, - "id": "Location", - "description": "A resource that represents Google Cloud Platform location.", - "type": "object" - }, "HealthCheck": { "description": "Health checking configuration for VM instances. Unhealthy instances are killed and replaced with new instances. Only applicable for instances in App Engine flexible environment.", "type": "object", "properties": { - "timeout": { - "description": "Time before the health check is considered failed.", - "format": "google-duration", - "type": "string" - }, "unhealthyThreshold": { "description": "Number of consecutive failed health checks required before removing traffic.", "format": "uint32", @@ -1401,13 +928,13 @@ "description": "Host header to send when performing an HTTP health check. Example: \"myapp.appspot.com\"", "type": "string" }, - "restartThreshold": { - "description": "Number of consecutive failed health checks required before an instance is restarted.", + "healthyThreshold": { + "description": "Number of consecutive successful health checks required before receiving traffic.", "format": "uint32", "type": "integer" }, - "healthyThreshold": { - "description": "Number of consecutive successful health checks required before receiving traffic.", + "restartThreshold": { + "description": "Number of consecutive failed health checks required before an instance is restarted.", "format": "uint32", "type": "integer" }, @@ -1415,24 +942,29 @@ "description": "Interval between health checks.", "format": "google-duration", "type": "string" + }, + "timeout": { + "description": "Time before the health check is considered failed.", + "format": "google-duration", + "type": "string" } }, "id": "HealthCheck" }, "SourceReference": { - "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.", - "type": "object", "properties": { - "repository": { - "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"", - "type": "string" - }, "revisionId": { "description": "The canonical, persistent identifier of the deployed revision. Aliases that include tags or branch names are not allowed. Example (git): \"2198322f89e0bb2e25021667c2ed489d1fd34e6b\"", "type": "string" + }, + "repository": { + "description": "URI string identifying the repository. Example: \"https://source.developers.google.com/p/app-123/r/default\"", + "type": "string" } }, - "id": "SourceReference" + "id": "SourceReference", + "description": "Reference to a particular snapshot of the source tree used to build and deploy the application.", + "type": "object" }, "DebugInstanceRequest": { "description": "Request message for Instances.DebugInstance.", @@ -1445,20 +977,16 @@ }, "id": "DebugInstanceRequest" }, - "Library": { - "description": "Third-party Python runtime library that is required by the application.", - "type": "object", + "CreateVersionMetadataV1Alpha": { "properties": { - "version": { - "description": "Version of the library to select, or \"latest\".", - "type": "string" - }, - "name": { - "description": "Name of the library. Example: \"django\".", + "cloudBuildId": { + "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", "type": "string" } }, - "id": "Library" + "id": "CreateVersionMetadataV1Alpha", + "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", + "type": "object" }, "OperationMetadataV1Beta5": { "description": "Metadata for the given google.longrunning.Operation.", @@ -1489,31 +1017,35 @@ }, "id": "OperationMetadataV1Beta5" }, - "CreateVersionMetadataV1Alpha": { - "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1alpha.CreateVersionRequest.", + "Library": { + "description": "Third-party Python runtime library that is required by the application.", "type": "object", "properties": { - "cloudBuildId": { - "description": "The Cloud Build ID if one was created as part of the version create. @OutputOnly", + "version": { + "description": "Version of the library to select, or \"latest\".", + "type": "string" + }, + "name": { + "description": "Name of the library. Example: \"django\".", "type": "string" } }, - "id": "CreateVersionMetadataV1Alpha" + "id": "Library" }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, "locations": { "description": "A list of locations that matches the specified filter in the request.", "type": "array", "items": { "$ref": "Location" } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } }, "id": "ListLocationsResponse" @@ -1530,7 +1062,88 @@ "id": "ContainerInfo" }, "Version": { + "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", + "type": "object", "properties": { + "manualScaling": { + "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", + "$ref": "ManualScaling" + }, + "name": { + "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", + "type": "string" + }, + "apiConfig": { + "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.", + "$ref": "ApiConfigHandler" + }, + "endpointsApiService": { + "$ref": "EndpointsApiService", + "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app." + }, + "vm": { + "description": "Whether to deploy this version in a container on a virtual machine.", + "type": "boolean" + }, + "instanceClass": { + "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.", + "type": "string" + }, + "servingStatus": { + "enum": [ + "SERVING_STATUS_UNSPECIFIED", + "SERVING", + "STOPPED" + ], + "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "Currently serving. Instances are created according to the scaling settings of the version.", + "Disabled from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING." + ] + }, + "runtimeApiVersion": { + "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref", + "type": "string" + }, + "deployment": { + "$ref": "Deployment", + "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." + }, + "inboundServices": { + "enumDescriptions": [ + "Not specified.", + "Allows an application to receive mail.", + "Allows an application to receive email-bound notifications.", + "Allows an application to receive error stanzas.", + "Allows an application to receive instant messages.", + "Allows an application to receive user subscription POSTs.", + "Allows an application to receive a user's chat presence.", + "Registers an application for notifications when a client connects or disconnects from a channel.", + "Enables warmup requests." + ], + "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.", + "type": "array", + "items": { + "enum": [ + "INBOUND_SERVICE_UNSPECIFIED", + "INBOUND_SERVICE_MAIL", + "INBOUND_SERVICE_MAIL_BOUNCE", + "INBOUND_SERVICE_XMPP_ERROR", + "INBOUND_SERVICE_XMPP_MESSAGE", + "INBOUND_SERVICE_XMPP_SUBSCRIBE", + "INBOUND_SERVICE_XMPP_PRESENCE", + "INBOUND_SERVICE_CHANNEL_PRESENCE", + "INBOUND_SERVICE_WARMUP" + ], + "type": "string" + } + }, + "resources": { + "$ref": "Resources", + "description": "Machine resources for this version. Only applicable for VM runtimes." + }, "errorHandlers": { "description": "Custom static error pages. Limited to 10KB per page.Only returned in GET requests if view=FULL is set.", "type": "array", @@ -1572,15 +1185,15 @@ "type": "string" }, "envVariables": { - "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Environment variables made available to the application.Only returned in GET requests if view=FULL is set.", + "type": "object" }, "network": { - "$ref": "Network", - "description": "Extra network settings. Only applicable for VM runtimes." + "description": "Extra network settings. Only applicable for VM runtimes.", + "$ref": "Network" }, "betaSettings": { "additionalProperties": { @@ -1614,96 +1227,15 @@ "type": "string" }, "healthCheck": { - "$ref": "HealthCheck", - "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set." + "description": "Configures health checking for VM instances. Unhealthy instances are be stopped and replaced with new instances. Only applicable for VM runtimes.Only returned in GET requests if view=FULL is set.", + "$ref": "HealthCheck" }, "threadsafe": { "description": "Whether multiple requests can be dispatched to this version at once.", "type": "boolean" - }, - "manualScaling": { - "$ref": "ManualScaling", - "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time." - }, - "name": { - "description": "Full path to the Version resource in the API. Example: apps/myapp/services/default/versions/v1.@OutputOnly", - "type": "string" - }, - "apiConfig": { - "description": "Serving configuration for Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/).Only returned in GET requests if view=FULL is set.", - "$ref": "ApiConfigHandler" - }, - "endpointsApiService": { - "$ref": "EndpointsApiService", - "description": "Cloud Endpoints configuration.If endpoints_api_service is set, the Cloud Endpoints Extensible Service Proxy will be provided to serve the API implemented by the app." - }, - "vm": { - "description": "Whether to deploy this version in a container on a virtual machine.", - "type": "boolean" - }, - "instanceClass": { - "description": "Instance class that is used to run this version. Valid values are:\nAutomaticScaling: F1, F2, F4, F4_1G\nManualScaling or BasicScaling: B1, B2, B4, B8, B4_1GDefaults to F1 for AutomaticScaling and B1 for ManualScaling or BasicScaling.", - "type": "string" - }, - "servingStatus": { - "enumDescriptions": [ - "Not specified.", - "Currently serving. Instances are created according to the scaling settings of the version.", - "Disabled from serving. No instances will be created and the scaling settings are ignored until the state of the version changes to SERVING." - ], - "enum": [ - "SERVING_STATUS_UNSPECIFIED", - "SERVING", - "STOPPED" - ], - "description": "Current serving status of this version. Only the versions with a SERVING status create instances and can be billed.SERVING_STATUS_UNSPECIFIED is an invalid value. Defaults to SERVING.", - "type": "string" - }, - "runtimeApiVersion": { - "description": "The version of the API in the given runtime environment. Please see the app.yaml reference for valid values at https://cloud.google.com/appengine/docs/standard/\u003clanguage\u003e/config/appref", - "type": "string" - }, - "deployment": { - "$ref": "Deployment", - "description": "Code and application artifacts that make up this version.Only returned in GET requests if view=FULL is set." - }, - "inboundServices": { - "description": "Before an application can receive email or XMPP messages, the application must be configured to enable the service.", - "type": "array", - "items": { - "enum": [ - "INBOUND_SERVICE_UNSPECIFIED", - "INBOUND_SERVICE_MAIL", - "INBOUND_SERVICE_MAIL_BOUNCE", - "INBOUND_SERVICE_XMPP_ERROR", - "INBOUND_SERVICE_XMPP_MESSAGE", - "INBOUND_SERVICE_XMPP_SUBSCRIBE", - "INBOUND_SERVICE_XMPP_PRESENCE", - "INBOUND_SERVICE_CHANNEL_PRESENCE", - "INBOUND_SERVICE_WARMUP" - ], - "type": "string" - }, - "enumDescriptions": [ - "Not specified.", - "Allows an application to receive mail.", - "Allows an application to receive email-bound notifications.", - "Allows an application to receive error stanzas.", - "Allows an application to receive instant messages.", - "Allows an application to receive user subscription POSTs.", - "Allows an application to receive a user's chat presence.", - "Registers an application for notifications when a client connects or disconnects from a channel.", - "Enables warmup requests." - ] - }, - "resources": { - "$ref": "Resources", - "description": "Machine resources for this version. Only applicable for VM runtimes." } }, - "id": "Version", - "description": "A Version resource is a specific set of source code and configuration files that are deployed into a service.", - "type": "object" + "id": "Version" }, "RequestUtilization": { "description": "Target scaling by request utilization. Only applicable for VM runtimes.", @@ -1722,14 +1254,49 @@ }, "id": "RequestUtilization" }, + "EndpointsApiService": { + "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", + "type": "object", + "properties": { + "name": { + "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", + "type": "string" + }, + "configId": { + "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.", + "type": "string" + } + }, + "id": "EndpointsApiService" + }, "UrlMap": { "description": "URL pattern and description of how the URL should be handled. App Engine can handle URLs by executing application code, or by serving static files uploaded with the version, such as images, CSS, or JavaScript.", "type": "object", "properties": { - "securityLevel": { - "description": "Security (HTTPS) enforcement for this URL.", + "staticFiles": { + "$ref": "StaticFilesHandler", + "description": "Returns the contents of a file, such as an image, as the response." + }, + "redirectHttpResponseCode": { + "enum": [ + "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", + "REDIRECT_HTTP_RESPONSE_CODE_301", + "REDIRECT_HTTP_RESPONSE_CODE_302", + "REDIRECT_HTTP_RESPONSE_CODE_303", + "REDIRECT_HTTP_RESPONSE_CODE_307" + ], + "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", "type": "string", "enumDescriptions": [ + "Not specified. 302 is assumed.", + "301 Moved Permanently code.", + "302 Moved Temporarily code.", + "303 See Other code.", + "307 Temporary Redirect code." + ] + }, + "securityLevel": { + "enumDescriptions": [ "Not specified.", "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", @@ -1742,7 +1309,9 @@ "SECURE_NEVER", "SECURE_OPTIONAL", "SECURE_ALWAYS" - ] + ], + "description": "Security (HTTPS) enforcement for this URL.", + "type": "string" }, "authFailAction": { "description": "Action to take when users access resources that require authentication. Defaults to redirect.", @@ -1759,14 +1328,20 @@ ] }, "script": { - "description": "Executes a script to handle the request that matches this URL pattern.", - "$ref": "ScriptHandler" + "$ref": "ScriptHandler", + "description": "Executes a script to handle the request that matches this URL pattern." }, "urlRegex": { "description": "A URL prefix. Uses regular expression syntax, which means regexp special characters must be escaped, but should not contain groupings. All URLs that begin with this prefix are handled by this handler, using the portion of the URL after the prefix as part of the file path.", "type": "string" }, "login": { + "enum": [ + "LOGIN_UNSPECIFIED", + "LOGIN_OPTIONAL", + "LOGIN_ADMIN", + "LOGIN_REQUIRED" + ], "description": "Level of login required to access this resource.", "type": "string", "enumDescriptions": [ @@ -1774,97 +1349,51 @@ "Does not require that the user is signed in.", "If the user is not signed in, the auth_fail_action is taken. In addition, if the user is not an administrator for the application, they are given an error message regardless of auth_fail_action. If the user is an administrator, the handler proceeds.", "If the user has signed in, the handler proceeds normally. Otherwise, the action given in auth_fail_action is taken." - ], - "enum": [ - "LOGIN_UNSPECIFIED", - "LOGIN_OPTIONAL", - "LOGIN_ADMIN", - "LOGIN_REQUIRED" ] }, "apiEndpoint": { "description": "Uses API Endpoints to handle requests.", "$ref": "ApiEndpointHandler" - }, - "staticFiles": { - "$ref": "StaticFilesHandler", - "description": "Returns the contents of a file, such as an image, as the response." - }, - "redirectHttpResponseCode": { - "enumDescriptions": [ - "Not specified. 302 is assumed.", - "301 Moved Permanently code.", - "302 Moved Temporarily code.", - "303 See Other code.", - "307 Temporary Redirect code." - ], - "enum": [ - "REDIRECT_HTTP_RESPONSE_CODE_UNSPECIFIED", - "REDIRECT_HTTP_RESPONSE_CODE_301", - "REDIRECT_HTTP_RESPONSE_CODE_302", - "REDIRECT_HTTP_RESPONSE_CODE_303", - "REDIRECT_HTTP_RESPONSE_CODE_307" - ], - "description": "30x code to use when performing redirects for the secure field. Defaults to 302.", - "type": "string" } }, "id": "UrlMap" }, - "EndpointsApiService": { - "description": "Cloud Endpoints (https://cloud.google.com/endpoints) configuration. The Endpoints API Service provides tooling for serving Open API and gRPC endpoints via an NGINX proxy.The fields here refer to the name and configuration id of a \"service\" resource in the Service Management API (https://cloud.google.com/service-management/overview).", - "type": "object", - "properties": { - "name": { - "description": "Endpoints service name which is the name of the \"service\" resource in the Service Management API. For example \"myapi.endpoints.myproject.cloud.goog\"", - "type": "string" - }, - "configId": { - "description": "Endpoints service configuration id as specified by the Service Management API. For example \"2016-09-19r1\"By default, the Endpoints service configuration id is fixed and config_id must be specified. To keep the Endpoints service configuration id updated with each rollout, specify RolloutStrategy.MANAGED and omit config_id.", - "type": "string" - } - }, - "id": "EndpointsApiService" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a network API call.", - "type": "object", - "properties": { - "response": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "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 operations/some/unique/name.", - "type": "string" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object" - }, - "done": { - "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", - "type": "boolean" - } - }, - "id": "Operation" - }, "ApiConfigHandler": { "description": "Google Cloud Endpoints (https://cloud.google.com/appengine/docs/python/endpoints/) configuration for API handlers.", "type": "object", "properties": { + "securityLevel": { + "enum": [ + "SECURE_UNSPECIFIED", + "SECURE_DEFAULT", + "SECURE_NEVER", + "SECURE_OPTIONAL", + "SECURE_ALWAYS" + ], + "description": "Security (HTTPS) enforcement for this URL.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", + "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", + "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", + "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." + ] + }, + "authFailAction": { + "enum": [ + "AUTH_FAIL_ACTION_UNSPECIFIED", + "AUTH_FAIL_ACTION_REDIRECT", + "AUTH_FAIL_ACTION_UNAUTHORIZED" + ], + "description": "Action to take when users access resources that require authentication. Defaults to redirect.", + "type": "string", + "enumDescriptions": [ + "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", + "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", + "Rejects request with an401 HTTP status code and an error message." + ] + }, "script": { "description": "Path to the script from the application root directory.", "type": "string" @@ -1888,42 +1417,45 @@ "url": { "description": "URL to serve the endpoint at.", "type": "string" - }, - "securityLevel": { - "enum": [ - "SECURE_UNSPECIFIED", - "SECURE_DEFAULT", - "SECURE_NEVER", - "SECURE_OPTIONAL", - "SECURE_ALWAYS" - ], - "description": "Security (HTTPS) enforcement for this URL.", - "type": "string", - "enumDescriptions": [ - "Not specified.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used, and respond accordingly.", - "Requests for a URL that match this handler that use HTTPS are automatically redirected to the HTTP equivalent URL.", - "Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly.", - "Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect." - ] - }, - "authFailAction": { - "enum": [ - "AUTH_FAIL_ACTION_UNSPECIFIED", - "AUTH_FAIL_ACTION_REDIRECT", - "AUTH_FAIL_ACTION_UNAUTHORIZED" - ], - "description": "Action to take when users access resources that require authentication. Defaults to redirect.", - "type": "string", - "enumDescriptions": [ - "Not specified. AUTH_FAIL_ACTION_REDIRECT is assumed.", - "Redirects user to \"accounts.google.com\". The user is redirected back to the application URL after signing in or creating an account.", - "Rejects request with an401 HTTP status code and an error message." - ] } }, "id": "ApiConfigHandler" }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "type": "object", + "properties": { + "done": { + "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", + "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 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" + }, + "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 operations/some/unique/name.", + "type": "string" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "id": "Operation" + }, "ScriptHandler": { "description": "Executes a script to handle the request that matches the URL pattern.", "type": "object", @@ -1935,45 +1467,6 @@ }, "id": "ScriptHandler" }, - "StaticFilesHandler": { - "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", - "type": "object", - "properties": { - "uploadPathRegex": { - "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", - "type": "string" - }, - "path": { - "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", - "type": "string" - }, - "mimeType": { - "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.", - "type": "string" - }, - "requireMatchingFile": { - "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", - "type": "boolean" - }, - "expiration": { - "description": "Time a static file served by this handler should be cached.", - "format": "google-duration", - "type": "string" - }, - "applicationReadable": { - "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", - "type": "boolean" - }, - "httpHeaders": { - "description": "HTTP headers to use for all responses from these URLs.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "id": "StaticFilesHandler" - }, "FileInfo": { "description": "Single source file that is part of the version to be deployed. Each source file that is deployed must be specified separately.", "type": "object", @@ -1993,34 +1486,48 @@ }, "id": "FileInfo" }, - "DiskUtilization": { - "description": "Target scaling by disk usage. Only applicable for VM runtimes.", + "StaticFilesHandler": { + "description": "Files served directly to the user for a given URL, such as images, CSS stylesheets, or JavaScript source files. Static file handlers describe which files in the application directory are static files, and which URLs serve them.", "type": "object", "properties": { - "targetReadBytesPerSec": { - "description": "Target bytes read per second.", - "format": "int32", - "type": "integer" + "applicationReadable": { + "description": "Whether files should also be uploaded as code data. By default, files declared in static file handlers are uploaded as static data and are only served to end users; they cannot be read by the application. If enabled, uploads are charged against both your code and static data storage resource quotas.", + "type": "boolean" }, - "targetWriteOpsPerSec": { - "description": "Target ops written per second.", - "format": "int32", - "type": "integer" + "httpHeaders": { + "additionalProperties": { + "type": "string" + }, + "description": "HTTP headers to use for all responses from these URLs.", + "type": "object" }, - "targetWriteBytesPerSec": { - "description": "Target bytes written per second.", - "format": "int32", - "type": "integer" + "uploadPathRegex": { + "description": "Regular expression that matches the file paths for all files that should be referenced by this handler.", + "type": "string" }, - "targetReadOpsPerSec": { - "description": "Target ops read per second.", - "format": "int32", - "type": "integer" + "path": { + "description": "Path to the static files matched by the URL pattern, from the application root directory. The path can refer to text matched in groupings in the URL pattern.", + "type": "string" + }, + "mimeType": { + "description": "MIME type used to serve all files served by this handler. Defaults to file-specific MIME types, which are derived from each file's filename extension.", + "type": "string" + }, + "requireMatchingFile": { + "description": "Whether this handler should match the request if the file referenced by the handler does not exist.", + "type": "boolean" + }, + "expiration": { + "description": "Time a static file served by this handler should be cached.", + "format": "google-duration", + "type": "string" } }, - "id": "DiskUtilization" + "id": "StaticFilesHandler" }, "BasicScaling": { + "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", + "type": "object", "properties": { "maxInstances": { "description": "Maximum number of instances to create for this version.", @@ -2033,9 +1540,34 @@ "type": "string" } }, - "id": "BasicScaling", - "description": "A service with basic scaling will create an instance when the application receives a request. The instance will be turned down when the app becomes idle. Basic scaling is ideal for work that is intermittent or driven by user activity.", - "type": "object" + "id": "BasicScaling" + }, + "DiskUtilization": { + "description": "Target scaling by disk usage. Only applicable for VM runtimes.", + "type": "object", + "properties": { + "targetWriteBytesPerSec": { + "description": "Target bytes written per second.", + "format": "int32", + "type": "integer" + }, + "targetReadOpsPerSec": { + "description": "Target ops read per second.", + "format": "int32", + "type": "integer" + }, + "targetReadBytesPerSec": { + "description": "Target bytes read per second.", + "format": "int32", + "type": "integer" + }, + "targetWriteOpsPerSec": { + "description": "Target ops written per second.", + "format": "int32", + "type": "integer" + } + }, + "id": "DiskUtilization" }, "CpuUtilization": { "description": "Target scaling by CPU usage.", @@ -2054,6 +1586,33 @@ }, "id": "CpuUtilization" }, + "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "type": "object", + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "id": "Status" + }, "IdentityAwareProxy": { "description": "Identity-Aware Proxy", "type": "object", @@ -2077,32 +1636,17 @@ }, "id": "IdentityAwareProxy" }, - "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "ManualScaling": { + "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", "type": "object", "properties": { - "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 field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", + "instances": { + "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.", "format": "int32", "type": "integer" } }, - "id": "Status" + "id": "ManualScaling" }, "TrafficSplit": { "description": "Traffic routing configuration for versions within a single service. Traffic splits define how traffic directed to the service is assigned to versions.", @@ -2133,18 +1677,6 @@ }, "id": "TrafficSplit" }, - "ManualScaling": { - "properties": { - "instances": { - "description": "Number of instances to assign to the service at the start. This number can later be altered by using the Modules API (https://cloud.google.com/appengine/docs/python/modules/functions) set_num_instances() function.", - "format": "int32", - "type": "integer" - } - }, - "id": "ManualScaling", - "description": "A service with manual scaling runs continuously, allowing you to perform complex initialization and rely on the state of its memory over time.", - "type": "object" - }, "LocationMetadata": { "description": "Metadata for the given google.cloud.location.Location.", "type": "object", @@ -2161,22 +1693,7 @@ "id": "LocationMetadata" }, "OperationMetadataV1Beta": { - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object", "properties": { - "ephemeralMessage": { - "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", - "type": "string" - }, - "method": { - "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", - "type": "string" - }, - "endTime": { - "description": "Time that this operation completed.@OutputOnly", - "format": "google-datetime", - "type": "string" - }, "createVersionMetadata": { "$ref": "CreateVersionMetadataV1Beta" }, @@ -2192,18 +1709,35 @@ "format": "google-datetime", "type": "string" }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, "target": { "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", "type": "string" }, - "user": { - "description": "User who requested this operation.@OutputOnly", + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1beta.Versions.CreateVersion.@OutputOnly", + "type": "string" + }, + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", "type": "string" } }, - "id": "OperationMetadataV1Beta" + "id": "OperationMetadataV1Beta", + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object" }, "ListServicesResponse": { + "description": "Response message for Services.ListServices.", + "type": "object", "properties": { "services": { "description": "The services belonging to the requested application.", @@ -2217,34 +1751,7 @@ "type": "string" } }, - "id": "ListServicesResponse", - "description": "Response message for Services.ListServices.", - "type": "object" - }, - "Deployment": { - "description": "Code and application artifacts used to deploy a version to App Engine.", - "type": "object", - "properties": { - "files": { - "additionalProperties": { - "$ref": "FileInfo" - }, - "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", - "type": "object" - }, - "container": { - "$ref": "ContainerInfo", - "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment." - }, - "sourceReferences": { - "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.", - "type": "array", - "items": { - "$ref": "SourceReference" - } - } - }, - "id": "Deployment" + "id": "ListServicesResponse" }, "Resources": { "description": "Machine resources for a version.", @@ -2275,6 +1782,31 @@ }, "id": "Resources" }, + "Deployment": { + "description": "Code and application artifacts used to deploy a version to App Engine.", + "type": "object", + "properties": { + "files": { + "additionalProperties": { + "$ref": "FileInfo" + }, + "description": "Manifest of the files stored in Google Cloud Storage that are included as part of this version. All files must be readable using the credentials supplied with this call.", + "type": "object" + }, + "container": { + "$ref": "ContainerInfo", + "description": "The Docker image for the container that runs the version. Only applicable for instances running in the App Engine flexible environment." + }, + "sourceReferences": { + "description": "Origin of the source code for this deployment. There can be more than one source reference per version if source code is distributed among multiple repositories.", + "type": "array", + "items": { + "$ref": "SourceReference" + } + } + }, + "id": "Deployment" + }, "Volume": { "description": "Volumes mounted within the app container. Only applicable for VM runtimes.", "type": "object", @@ -2296,8 +1828,6 @@ "id": "Volume" }, "Service": { - "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.", - "type": "object", "properties": { "name": { "description": "Full path to the Service resource in the API. Example: apps/myapp/services/default.@OutputOnly", @@ -2312,41 +1842,45 @@ "type": "string" } }, - "id": "Service" + "id": "Service", + "description": "A Service resource is a logical component of an application that can share state and communicate in a secure fashion with other services. For example, an application that handles customer requests might include separate services to handle other tasks such as API requests from mobile devices or backend data analysis. Each service has a collection of versions that define a specific set of code used to implement the functionality of that service.", + "type": "object" }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "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.", "type": "array", "items": { "$ref": "Operation" } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" } }, "id": "ListOperationsResponse" }, "OperationMetadata": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", "properties": { "insertTime": { "description": "Timestamp that this operation was created.@OutputOnly", "format": "google-datetime", "type": "string" }, - "target": { - "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly", - "type": "string" - }, "user": { "description": "User who requested this operation.@OutputOnly", "type": "string" }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/modules/default.@OutputOnly", + "type": "string" + }, "method": { "description": "API method that initiated this operation. Example: google.appengine.v1beta4.Version.CreateVersion.@OutputOnly", "type": "string" @@ -2361,9 +1895,7 @@ "type": "string" } }, - "id": "OperationMetadata", - "description": "Metadata for the given google.longrunning.Operation.", - "type": "object" + "id": "OperationMetadata" }, "CreateVersionMetadataV1Beta": { "description": "Metadata for the given google.longrunning.Operation during a google.appengine.v1beta.CreateVersionRequest.", @@ -2375,13 +1907,478 @@ } }, "id": "CreateVersionMetadataV1Beta" + }, + "ListInstancesResponse": { + "description": "Response message for Instances.ListInstances.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "instances": { + "description": "The instances belonging to the requested version.", + "type": "array", + "items": { + "$ref": "Instance" + } + } + }, + "id": "ListInstancesResponse" + }, + "ErrorHandler": { + "description": "Custom static error page to be served when an error occurs.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error condition this handler applies to.", + "type": "string", + "enumDescriptions": [ + "Not specified. ERROR_CODE_DEFAULT is assumed.", + "All other error types.", + "Application has exceeded a resource quota.", + "Client blocked by the application's Denial of Service protection configuration.", + "Deadline reached before the application responds." + ], + "enum": [ + "ERROR_CODE_UNSPECIFIED", + "ERROR_CODE_DEFAULT", + "ERROR_CODE_OVER_QUOTA", + "ERROR_CODE_DOS_API_DENIAL", + "ERROR_CODE_TIMEOUT" + ] + }, + "mimeType": { + "description": "MIME type of file. Defaults to text/html.", + "type": "string" + }, + "staticFile": { + "description": "Static file content to be served for this error.", + "type": "string" + } + }, + "id": "ErrorHandler" + }, + "OperationMetadataV1": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", + "properties": { + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1.Versions.CreateVersion.@OutputOnly", + "type": "string" + } + }, + "id": "OperationMetadataV1" + }, + "OperationMetadataV1Alpha": { + "description": "Metadata for the given google.longrunning.Operation.", + "type": "object", + "properties": { + "warning": { + "description": "Durable messages that persist on every operation poll. @OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, + "insertTime": { + "description": "Time that this operation was created.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "user": { + "description": "User who requested this operation.@OutputOnly", + "type": "string" + }, + "target": { + "description": "Name of the resource that this operation is acting on. Example: apps/myapp/services/default.@OutputOnly", + "type": "string" + }, + "ephemeralMessage": { + "description": "Ephemeral message that may change every time the operation is polled. @OutputOnly", + "type": "string" + }, + "method": { + "description": "API method that initiated this operation. Example: google.appengine.v1alpha.Versions.CreateVersion.@OutputOnly", + "type": "string" + }, + "endTime": { + "description": "Time that this operation completed.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "createVersionMetadata": { + "$ref": "CreateVersionMetadataV1Alpha" + } + }, + "id": "OperationMetadataV1Alpha" + }, + "Network": { + "properties": { + "forwardedPorts": { + "description": "List of ports, or port pairs, to forward from the virtual machine to the application container.", + "type": "array", + "items": { + "type": "string" + } + }, + "instanceTag": { + "description": "Tag to apply to the VM instance during creation.", + "type": "string" + }, + "subnetworkName": { + "description": "Google Cloud Platform sub-network where the virtual machines are created. Specify the short name, not the resource path.If a subnetwork name is specified, a network name will also be required unless it is for the default network.\nIf the network the VM instance is being created in is a Legacy network, then the IP address is allocated from the IPv4Range.\nIf the network the VM instance is being created in is an auto Subnet Mode Network, then only network name should be specified (not the subnetwork_name) and the IP address is created from the IPCidrRange of the subnetwork that exists in that zone for that network.\nIf the network the VM instance is being created in is a custom Subnet Mode Network, then the subnetwork_name must be specified and the IP address is created from the IPCidrRange of the subnetwork.If specified, the subnetwork must exist in the same region as the Flex app.", + "type": "string" + }, + "name": { + "description": "Google Cloud Platform network where the virtual machines are created. Specify the short name, not the resource path.Defaults to default.", + "type": "string" + } + }, + "id": "Network", + "description": "Extra network settings. Only applicable for VM runtimes.", + "type": "object" + }, + "Application": { + "properties": { + "name": { + "description": "Full path to the Application resource in the API. Example: apps/myapp.@OutputOnly", + "type": "string" + }, + "iap": { + "$ref": "IdentityAwareProxy" + }, + "authDomain": { + "description": "Google Apps authentication domain that controls which users can access this application.Defaults to open access for any Google Account.", + "type": "string" + }, + "id": { + "description": "Identifier of the Application resource. This identifier is equivalent to the project ID of the Google Cloud Platform project where you want to deploy your application. Example: myapp.", + "type": "string" + }, + "defaultCookieExpiration": { + "description": "Cookie expiration policy for this application.", + "format": "google-duration", + "type": "string" + }, + "codeBucket": { + "description": "A Google Cloud Storage bucket that can be used for storing files associated with this application. This bucket is associated with the application and can be used by the gcloud deployment commands.@OutputOnly", + "type": "string" + }, + "location": { + "description": "Location from which this application will be run. Application instances will run out of data centers in the chosen location, which is also where all of the application's end user content is stored.Defaults to us-central.Options are:us-central - Central USeurope-west - Western Europeus-east1 - Eastern US", + "type": "string" + }, + "defaultBucket": { + "description": "A Google Cloud Storage bucket that can be used by the application to store content.@OutputOnly", + "type": "string" + }, + "dispatchRules": { + "description": "HTTP path dispatch rules for requests to the application that do not explicitly target a service or version. Rules are order-dependent.@OutputOnly", + "type": "array", + "items": { + "$ref": "UrlDispatchRule" + } + }, + "defaultHostname": { + "description": "Hostname used to reach the application, as resolved by App Engine.@OutputOnly", + "type": "string" + } + }, + "id": "Application", + "description": "An Application resource contains the top-level configuration of an App Engine application.", + "type": "object" + }, + "Instance": { + "description": "An Instance resource is the computing unit that App Engine uses to automatically scale an application.", + "type": "object", + "properties": { + "appEngineRelease": { + "description": "App Engine release this instance is running on.@OutputOnly", + "type": "string" + }, + "startTimestamp": { + "description": "Time that this instance was started.@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "vmName": { + "description": "Name of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "vmId": { + "description": "Virtual machine ID of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "qps": { + "description": "Average queries per second (QPS) over the last minute.@OutputOnly", + "format": "float", + "type": "number" + }, + "vmUnlocked": { + "description": "Whether this instance is in debug mode. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "boolean" + }, + "name": { + "description": "Full path to the Instance resource in the API. Example: apps/myapp/services/default/versions/v1/instances/instance-1.@OutputOnly", + "type": "string" + }, + "vmZoneName": { + "description": "Zone where the virtual machine is located. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "averageLatency": { + "description": "Average latency (ms) over the last minute.@OutputOnly", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "Relative name of the instance within the version. Example: instance-1.@OutputOnly", + "type": "string" + }, + "memoryUsage": { + "description": "Total memory in use (bytes).@OutputOnly", + "format": "int64", + "type": "string" + }, + "vmIp": { + "description": "The IP address of this instance. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "errors": { + "description": "Number of errors since this instance was started.@OutputOnly", + "format": "uint32", + "type": "integer" + }, + "availability": { + "enumDescriptions": [ + "", + "", + "" + ], + "enum": [ + "UNSPECIFIED", + "RESIDENT", + "DYNAMIC" + ], + "description": "Availability of the instance.@OutputOnly", + "type": "string" + }, + "vmStatus": { + "description": "Status of the virtual machine where this instance lives. Only applicable for instances in App Engine flexible environment.@OutputOnly", + "type": "string" + }, + "requests": { + "description": "Number of requests since this instance was started.@OutputOnly", + "format": "int32", + "type": "integer" + } + }, + "id": "Instance" + }, + "UrlDispatchRule": { + "description": "Rules to match an HTTP request and dispatch that request to a service.", + "type": "object", + "properties": { + "domain": { + "description": "Domain name to match against. The wildcard \"*\" is supported if specified before a period: \"*.\".Defaults to matching all domains: \"*\".", + "type": "string" + }, + "service": { + "description": "Resource id of a service in this application that should serve the matched request. The service must already exist. Example: default.", + "type": "string" + }, + "path": { + "description": "Pathname within the host. Must start with a \"/\". A single \"*\" can be included at the end of the path. The sum of the lengths of the domain and path may not exceed 100 characters.", + "type": "string" + } + }, + "id": "UrlDispatchRule" + }, + "ListVersionsResponse": { + "description": "Response message for Versions.ListVersions.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Continuation token for fetching the next page of results.", + "type": "string" + }, + "versions": { + "description": "The versions belonging to the requested service.", + "type": "array", + "items": { + "$ref": "Version" + } + } + }, + "id": "ListVersionsResponse" + }, + "ApiEndpointHandler": { + "description": "Uses Google Cloud Endpoints to handle requests.", + "type": "object", + "properties": { + "scriptPath": { + "description": "Path to the script from the application root directory.", + "type": "string" + } + }, + "id": "ApiEndpointHandler" + }, + "AutomaticScaling": { + "description": "Automatic scaling is based on request rate, response latencies, and other application metrics.", + "type": "object", + "properties": { + "coolDownPeriod": { + "description": "Amount of time that the Autoscaler (https://cloud.google.com/compute/docs/autoscaler/) should wait between changes to the number of virtual machines. Only applicable for VM runtimes.", + "format": "google-duration", + "type": "string" + }, + "maxConcurrentRequests": { + "description": "Number of concurrent requests an automatic scaling instance can accept before the scheduler spawns a new instance.Defaults to a runtime-specific value.", + "format": "int32", + "type": "integer" + }, + "maxPendingLatency": { + "description": "Maximum amount of time that a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "cpuUtilization": { + "$ref": "CpuUtilization", + "description": "Target scaling by CPU usage." + }, + "diskUtilization": { + "description": "Target scaling by disk usage.", + "$ref": "DiskUtilization" + }, + "minPendingLatency": { + "description": "Minimum amount of time a request should wait in the pending queue before starting a new instance to handle it.", + "format": "google-duration", + "type": "string" + }, + "maxIdleInstances": { + "description": "Maximum number of idle instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "requestUtilization": { + "$ref": "RequestUtilization", + "description": "Target scaling by request utilization." + }, + "minIdleInstances": { + "description": "Minimum number of idle instances that should be maintained for this version. Only applicable for the default version of a module.", + "format": "int32", + "type": "integer" + }, + "maxTotalInstances": { + "description": "Maximum number of instances that should be started to handle requests.", + "format": "int32", + "type": "integer" + }, + "minTotalInstances": { + "description": "Minimum number of instances that should be maintained for this version.", + "format": "int32", + "type": "integer" + }, + "networkUtilization": { + "description": "Target scaling by network usage.", + "$ref": "NetworkUtilization" + } + }, + "id": "AutomaticScaling" + }, + "NetworkUtilization": { + "description": "Target scaling by network usage. Only applicable for VM runtimes.", + "type": "object", + "properties": { + "targetSentPacketsPerSec": { + "description": "Target packets sent per second.", + "format": "int32", + "type": "integer" + }, + "targetSentBytesPerSec": { + "description": "Target bytes sent per second.", + "format": "int32", + "type": "integer" + }, + "targetReceivedPacketsPerSec": { + "description": "Target packets received per second.", + "format": "int32", + "type": "integer" + }, + "targetReceivedBytesPerSec": { + "description": "Target bytes received per second.", + "format": "int32", + "type": "integer" + } + }, + "id": "NetworkUtilization" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "type": "object", + "properties": { + "name": { + "description": "Resource name for the location, which may vary between implementations. For example: \"projects/example-project/locations/us-east1\"", + "type": "string" + }, + "locationId": { + "description": "The canonical id for this location. For example: \"us-east1\".", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given location.", + "type": "object" + }, + "labels": { + "description": "Cross-service attributes for the location. For example\n{\"cloud.googleapis.com/region\": \"us-east1\"}\n", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "id": "Location" } }, - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, "protocol": "rest", + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" + }, "version": "v1beta5", "baseUrl": "https://appengine.googleapis.com/", "auth": { @@ -2399,12 +2396,15 @@ } } }, - "servicePath": "", - "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", "kind": "discovery#restDescription", + "description": "The App Engine Admin API enables developers to provision and manage their App Engine applications.", + "servicePath": "", "rootUrl": "https://appengine.googleapis.com/", "basePath": "", "ownerDomain": "google.com", "name": "appengine", - "batchPath": "batch" + "batchPath": "batch", + "revision": "20171220", + "documentationLink": "https://cloud.google.com/appengine/docs/admin-api/", + "id": "appengine:v1beta5" }
diff --git a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json index 121de58..972dc8d 100644 --- a/bigquerydatatransfer/v1/bigquerydatatransfer-api.json +++ b/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
@@ -1,1142 +1,7 @@ { - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "locations": { - "methods": { - "list": { - "id": "bigquerydatatransfer.projects.locations.list", - "path": "v1/{+name}/locations", - "description": "Lists information about the supported locations for this service.", - "httpMethod": "GET", - "response": { - "$ref": "ListLocationsResponse" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The resource that owns the locations collection, if applicable.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations" - }, - "get": { - "description": "Get information about a location.", - "response": { - "$ref": "Location" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Resource name for the location.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.locations.get" - } - }, - "resources": { - "dataSources": { - "methods": { - "checkValidCreds": { - "path": "v1/{+name}:checkValidCreds", - "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds", - "request": { - "$ref": "CheckValidCredsRequest" - }, - "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.", - "response": { - "$ref": "CheckValidCredsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds" - }, - "get": { - "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.", - "response": { - "$ref": "DataSource" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", - "location": "path", - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.locations.dataSources.get" - }, - "list": { - "path": "v1/{+parent}/dataSources", - "id": "bigquerydatatransfer.projects.locations.dataSources.list", - "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.", - "response": { - "$ref": "ListDataSourcesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "parent": { - "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string" - }, - "pageSize": { - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources" - } - } - }, - "transferConfigs": { - "resources": { - "runs": { - "resources": { - "transferLogs": { - "methods": { - "list": { - "description": "Returns user facing log messages for the data transfer run.", - "httpMethod": "GET", - "response": { - "$ref": "ListTransferLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "messageTypes": { - "repeated": true, - "location": "query", - "enum": [ - "MESSAGE_SEVERITY_UNSPECIFIED", - "INFO", - "WARNING", - "ERROR" - ], - "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list", - "path": "v1/{+parent}/transferLogs" - } - } - } - }, - "methods": { - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", - "location": "path", - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete", - "description": "Deletes the specified transfer run." - }, - "get": { - "description": "Returns information about the particular transfer run.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "TransferRun" - }, - "parameters": { - "name": { - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get", - "path": "v1/{+name}" - }, - "list": { - "path": "v1/{+parent}/runs", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list", - "description": "Returns information about running and completed jobs.", - "response": { - "$ref": "ListTransferRunsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "runAttempt": { - "enum": [ - "RUN_ATTEMPT_UNSPECIFIED", - "LATEST" - ], - "description": "Indicates how run attempts are to be pulled.", - "type": "string", - "location": "query" - }, - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", - "location": "path", - "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string" - }, - "states": { - "repeated": true, - "location": "query", - "enum": [ - "TRANSFER_STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED", - "CANCELLED" - ], - "description": "When specified, only transfer runs with requested states are returned.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs" - } - } - } - }, - "methods": { - "patch": { - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch", - "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.", - "request": { - "$ref": "TransferConfig" - }, - "response": { - "$ref": "TransferConfig" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", - "location": "path" - }, - "authorizationCode": { - "location": "query", - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", - "type": "string" - }, - "updateMask": { - "description": "Required list of fields to be updated in this request.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}" - }, - "get": { - "httpMethod": "GET", - "response": { - "$ref": "TransferConfig" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.get", - "path": "v1/{+name}", - "description": "Returns information about a data transfer config." - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete", - "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs." - }, - "list": { - "path": "v1/{+parent}/transferConfigs", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.list", - "description": "Returns information about all data transfers in the project.", - "response": { - "$ref": "ListTransferConfigsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "location": "query", - "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", - "required": true, - "type": "string" - }, - "dataSourceIds": { - "repeated": true, - "location": "query", - "description": "When specified, only configurations of requested data sources are returned.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs" - }, - "create": { - "response": { - "$ref": "TransferConfig" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", - "type": "string", - "location": "query" - }, - "parent": { - "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", - "path": "v1/{+parent}/transferConfigs", - "id": "bigquerydatatransfer.projects.locations.transferConfigs.create", - "description": "Creates a new data transfer configuration.", - "request": { - "$ref": "TransferConfig" - } - }, - "scheduleRuns": { - "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns", - "path": "v1/{+parent}:scheduleRuns", - "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.", - "request": { - "$ref": "ScheduleTransferRunsRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ScheduleTransferRunsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns" - } - } - } - } - }, - "dataSources": { - "methods": { - "get": { - "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.", - "response": { - "$ref": "DataSource" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "name": { - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/dataSources/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.dataSources.get" - }, - "list": { - "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.", - "httpMethod": "GET", - "response": { - "$ref": "ListDataSourcesResponse" - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/dataSources", - "id": "bigquerydatatransfer.projects.dataSources.list", - "path": "v1/{+parent}/dataSources" - }, - "checkValidCreds": { - "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.", - "request": { - "$ref": "CheckValidCredsRequest" - }, - "response": { - "$ref": "CheckValidCredsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/dataSources/[^/]+$", - "location": "path", - "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds", - "path": "v1/{+name}:checkValidCreds", - "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds" - } - } - }, - "transferConfigs": { - "resources": { - "runs": { - "resources": { - "transferLogs": { - "methods": { - "list": { - "description": "Returns user facing log messages for the data transfer run.", - "response": { - "$ref": "ListTransferLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer" - }, - "messageTypes": { - "enum": [ - "MESSAGE_SEVERITY_UNSPECIFIED", - "INFO", - "WARNING", - "ERROR" - ], - "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.", - "type": "string", - "repeated": true, - "location": "query" - }, - "parent": { - "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", - "location": "path", - "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs", - "path": "v1/{+parent}/transferLogs", - "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list" - } - } - } - }, - "methods": { - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", - "location": "path", - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete", - "description": "Deletes the specified transfer run." - }, - "get": { - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.transferConfigs.runs.get", - "description": "Returns information about the particular transfer run.", - "response": { - "$ref": "TransferRun" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", - "location": "path", - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}" - }, - "list": { - "description": "Returns information about running and completed jobs.", - "response": { - "$ref": "ListTransferRunsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "runAttempt": { - "enum": [ - "RUN_ATTEMPT_UNSPECIFIED", - "LATEST" - ], - "description": "Indicates how run attempts are to be pulled.", - "type": "string", - "location": "query" - }, - "parent": { - "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string", - "location": "query" - }, - "states": { - "repeated": true, - "location": "query", - "enum": [ - "TRANSFER_STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED", - "CANCELLED" - ], - "description": "When specified, only transfer runs with requested states are returned.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs", - "path": "v1/{+parent}/runs", - "id": "bigquerydatatransfer.projects.transferConfigs.runs.list" - } - } - } - }, - "methods": { - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.transferConfigs.delete", - "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs." - }, - "list": { - "path": "v1/{+parent}/transferConfigs", - "id": "bigquerydatatransfer.projects.transferConfigs.list", - "description": "Returns information about all data transfers in the project.", - "response": { - "$ref": "ListTransferConfigsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "dataSourceIds": { - "description": "When specified, only configurations of requested data sources are returned.", - "type": "string", - "repeated": true, - "location": "query" - }, - "pageToken": { - "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Page size. The default page size is the maximum value of 1000 results.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs" - }, - "create": { - "path": "v1/{+parent}/transferConfigs", - "id": "bigquerydatatransfer.projects.transferConfigs.create", - "description": "Creates a new data transfer configuration.", - "request": { - "$ref": "TransferConfig" - }, - "response": { - "$ref": "TransferConfig" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "authorizationCode": { - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", - "type": "string", - "location": "query" - }, - "parent": { - "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/transferConfigs" - }, - "scheduleRuns": { - "path": "v1/{+parent}:scheduleRuns", - "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns", - "request": { - "$ref": "ScheduleTransferRunsRequest" - }, - "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.", - "response": { - "$ref": "ScheduleTransferRunsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns" - }, - "get": { - "description": "Returns information about a data transfer config.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "TransferConfig" - }, - "parameters": { - "name": { - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", - "id": "bigquerydatatransfer.projects.transferConfigs.get", - "path": "v1/{+name}" - }, - "patch": { - "response": { - "$ref": "TransferConfig" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", - "location": "path", - "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.", - "required": true, - "type": "string" - }, - "authorizationCode": { - "location": "query", - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", - "type": "string" - }, - "updateMask": { - "location": "query", - "description": "Required list of fields to be updated in this request.", - "format": "google-fieldmask", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/bigquery", - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", - "path": "v1/{+name}", - "id": "bigquerydatatransfer.projects.transferConfigs.patch", - "request": { - "$ref": "TransferConfig" - }, - "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated." - } - } - } - } - } - }, - "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - } - }, - "version": "v1", - "baseUrl": "https://bigquerydatatransfer.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.", - "servicePath": "", - "basePath": "", - "id": "bigquerydatatransfer:v1", - "documentationLink": "https://cloud.google.com/bigquery/", "revision": "20180106", + "documentationLink": "https://cloud.google.com/bigquery/", + "id": "bigquerydatatransfer:v1", "discoveryVersion": "v1", "version_module": true, "schemas": { @@ -1144,17 +9,6 @@ "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.", "type": "object", "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", @@ -1163,35 +17,53 @@ "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 is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } } }, "id": "Status" }, "ScheduleTransferRunsRequest": { + "description": "A request to schedule transfer runs for a time range.", + "type": "object", "properties": { - "startTime": { - "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.", - "format": "google-datetime", - "type": "string" - }, "endTime": { "description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.", "format": "google-datetime", "type": "string" + }, + "startTime": { + "description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.", + "format": "google-datetime", + "type": "string" } }, - "id": "ScheduleTransferRunsRequest", - "description": "A request to schedule transfer runs for a time range.", - "type": "object" + "id": "ScheduleTransferRunsRequest" }, "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" + "type": "object", + "properties": {}, + "id": "Empty" }, "Location": { "properties": { + "labels": { + "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "name": { "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", "type": "string" @@ -1207,13 +79,6 @@ }, "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", "type": "object" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" } }, "id": "Location", @@ -1224,47 +89,6 @@ "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.", "type": "object", "properties": { - "state": { - "enum": [ - "TRANSFER_STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "SUCCEEDED", - "FAILED", - "CANCELLED" - ], - "description": "Output only. State of the most recently updated transfer run.", - "type": "string", - "enumDescriptions": [ - "State placeholder.", - "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", - "Data transfer is in progress.", - "Data transfer completed successsfully.", - "Data transfer failed.", - "Data transfer is cancelled." - ] - }, - "name": { - "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.", - "type": "string" - }, - "userId": { - "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.", - "format": "int64", - "type": "string" - }, - "destinationDatasetId": { - "description": "The BigQuery target dataset id.", - "type": "string" - }, - "params": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Data transfer specific parameters.", - "type": "object" - }, "datasetRegion": { "description": "Output only. Region in which BigQuery dataset is located.", "type": "string" @@ -1299,17 +123,16 @@ "dataSourceId": { "description": "Data source id. Cannot be changed once data transfer is created.", "type": "string" - } - }, - "id": "TransferConfig" - }, - "TransferRun": { - "properties": { - "dataSourceId": { - "description": "Output only. Data source id.", - "type": "string" }, "state": { + "enumDescriptions": [ + "State placeholder.", + "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.", + "Data transfer is in progress.", + "Data transfer completed successsfully.", + "Data transfer failed.", + "Data transfer is cancelled." + ], "enum": [ "TRANSFER_STATE_UNSPECIFIED", "PENDING", @@ -1318,6 +141,73 @@ "FAILED", "CANCELLED" ], + "description": "Output only. State of the most recently updated transfer run.", + "type": "string" + }, + "name": { + "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.", + "type": "string" + }, + "destinationDatasetId": { + "description": "The BigQuery target dataset id.", + "type": "string" + }, + "userId": { + "description": "Output only. Unique ID of the user on whose behalf transfer is done.\nApplicable only to data sources that do not support service accounts.\nWhen set to 0, the data source service account credentials are used.\nMay be negative. Note, that this identifier is not stable.\nIt may change over time even for the same user.", + "format": "int64", + "type": "string" + }, + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Data transfer specific parameters.", + "type": "object" + } + }, + "id": "TransferConfig" + }, + "TransferRun": { + "properties": { + "endTime": { + "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.", + "format": "google-datetime", + "type": "string" + }, + "scheduleTime": { + "description": "Minimum time after which a transfer run can be started.", + "format": "google-datetime", + "type": "string" + }, + "errorStatus": { + "$ref": "Status", + "description": "Status of the transfer run." + }, + "updateTime": { + "description": "Output only. Last time the data transfer run state was updated.", + "format": "google-datetime", + "type": "string" + }, + "schedule": { + "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.", + "type": "string" + }, + "runTime": { + "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.", + "format": "google-datetime", + "type": "string" + }, + "dataSourceId": { + "description": "Output only. Data source id.", + "type": "string" + }, + "state": { "description": "Data transfer run state. Ignored for input requests.", "type": "string", "enumDescriptions": [ @@ -1327,6 +217,14 @@ "Data transfer completed successsfully.", "Data transfer failed.", "Data transfer is cancelled." + ], + "enum": [ + "TRANSFER_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" ] }, "destinationDatasetId": { @@ -1349,39 +247,6 @@ }, "description": "Output only. Data transfer specific parameters.", "type": "object" - }, - "endTime": { - "description": "Output only. Time when transfer run ended.\nParameter ignored by server for input requests.", - "format": "google-datetime", - "type": "string" - }, - "startTime": { - "description": "Output only. Time when transfer run was started.\nParameter ignored by server for input requests.", - "format": "google-datetime", - "type": "string" - }, - "scheduleTime": { - "description": "Minimum time after which a transfer run can be started.", - "format": "google-datetime", - "type": "string" - }, - "errorStatus": { - "description": "Status of the transfer run.", - "$ref": "Status" - }, - "updateTime": { - "description": "Output only. Last time the data transfer run state was updated.", - "format": "google-datetime", - "type": "string" - }, - "schedule": { - "description": "Output only. Describes the schedule of this transfer run if it was\ncreated as part of a regular schedule. For batch transfer runs that are\nscheduled manually, this is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.", - "type": "string" - }, - "runTime": { - "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.", - "format": "google-datetime", - "type": "string" } }, "id": "TransferRun", @@ -1389,10 +254,10 @@ "type": "object" }, "CheckValidCredsRequest": { - "properties": {}, - "id": "CheckValidCredsRequest", "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.", - "type": "object" + "type": "object", + "properties": {}, + "id": "CheckValidCredsRequest" }, "CheckValidCredsResponse": { "description": "A response indicating whether the credentials exist and are valid.", @@ -1406,6 +271,8 @@ "id": "CheckValidCredsResponse" }, "ScheduleTransferRunsResponse": { + "description": "A response to schedule transfer runs for a time range.", + "type": "object", "properties": { "runs": { "description": "The transfer runs that were scheduled.", @@ -1415,13 +282,27 @@ } } }, - "id": "ScheduleTransferRunsResponse", - "description": "A response to schedule transfer runs for a time range.", - "type": "object" + "id": "ScheduleTransferRunsResponse" + }, + "ListTransferLogsResponse": { + "description": "The returned list transfer run messages.", + "type": "object", + "properties": { + "transferMessages": { + "description": "Output only. The stored pipeline transfer messages.", + "type": "array", + "items": { + "$ref": "TransferMessage" + } + }, + "nextPageToken": { + "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.", + "type": "string" + } + }, + "id": "ListTransferLogsResponse" }, "TransferMessage": { - "description": "Represents a user facing message for a particular data transfer run.", - "type": "object", "properties": { "messageTime": { "description": "Time when message was logged.", @@ -1449,25 +330,9 @@ "type": "string" } }, - "id": "TransferMessage" - }, - "ListTransferLogsResponse": { - "description": "The returned list transfer run messages.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.", - "type": "string" - }, - "transferMessages": { - "description": "Output only. The stored pipeline transfer messages.", - "type": "array", - "items": { - "$ref": "TransferMessage" - } - } - }, - "id": "ListTransferLogsResponse" + "id": "TransferMessage", + "description": "Represents a user facing message for a particular data transfer run.", + "type": "object" }, "ListDataSourcesResponse": { "properties": { @@ -1491,50 +356,6 @@ "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.", "type": "object", "properties": { - "allowedValues": { - "description": "All possible values for the parameter.", - "type": "array", - "items": { - "type": "string" - } - }, - "minValue": { - "description": "For integer and double values specifies minimum allowed value.", - "format": "double", - "type": "number" - }, - "validationHelpUrl": { - "description": "URL to a help document to further explain the naming requirements.", - "type": "string" - }, - "validationRegex": { - "description": "Regular expression which can be used for parameter validation.", - "type": "string" - }, - "paramId": { - "description": "Parameter identifier.", - "type": "string" - }, - "required": { - "description": "Is parameter required.", - "type": "boolean" - }, - "repeated": { - "description": "Can parameter have multiple values.", - "type": "boolean" - }, - "displayName": { - "description": "Parameter display name in the user interface.", - "type": "string" - }, - "validationDescription": { - "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.", - "type": "string" - }, - "immutable": { - "description": "Cannot be changed after initial creation.", - "type": "boolean" - }, "fields": { "description": "When parameter is a record, describes child fields.", "type": "array", @@ -1576,10 +397,72 @@ "description": { "description": "Parameter description.", "type": "string" + }, + "allowedValues": { + "description": "All possible values for the parameter.", + "type": "array", + "items": { + "type": "string" + } + }, + "minValue": { + "description": "For integer and double values specifies minimum allowed value.", + "format": "double", + "type": "number" + }, + "validationHelpUrl": { + "description": "URL to a help document to further explain the naming requirements.", + "type": "string" + }, + "validationRegex": { + "description": "Regular expression which can be used for parameter validation.", + "type": "string" + }, + "paramId": { + "description": "Parameter identifier.", + "type": "string" + }, + "required": { + "description": "Is parameter required.", + "type": "boolean" + }, + "repeated": { + "description": "Can parameter have multiple values.", + "type": "boolean" + }, + "displayName": { + "description": "Parameter display name in the user interface.", + "type": "string" + }, + "immutable": { + "description": "Cannot be changed after initial creation.", + "type": "boolean" + }, + "validationDescription": { + "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.", + "type": "string" } }, "id": "DataSourceParameter" }, + "ListTransferRunsResponse": { + "properties": { + "transferRuns": { + "description": "Output only. The stored pipeline transfer runs.", + "type": "array", + "items": { + "$ref": "TransferRun" + } + }, + "nextPageToken": { + "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.", + "type": "string" + } + }, + "id": "ListTransferRunsResponse", + "description": "The returned list of pipelines in the project.", + "type": "object" + }, "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "type": "object", @@ -1598,24 +481,6 @@ }, "id": "ListLocationsResponse" }, - "ListTransferRunsResponse": { - "description": "The returned list of pipelines in the project.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Output only. The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.", - "type": "string" - }, - "transferRuns": { - "description": "Output only. The stored pipeline transfer runs.", - "type": "array", - "items": { - "$ref": "TransferRun" - } - } - }, - "id": "ListTransferRunsResponse" - }, "ListTransferConfigsResponse": { "description": "The returned list of pipelines in the project.", "type": "object", @@ -1636,6 +501,41 @@ }, "DataSource": { "properties": { + "defaultDataRefreshWindowDays": { + "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.", + "format": "int32", + "type": "integer" + }, + "manualRunsDisabled": { + "description": "Disables backfilling and manual run scheduling\nfor the data source.", + "type": "boolean" + }, + "transferType": { + "enumDescriptions": [ + "Invalid or Unknown transfer type placeholder.", + "Batch data transfer.", + "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project." + ], + "enum": [ + "TRANSFER_TYPE_UNSPECIFIED", + "BATCH", + "STREAMING" + ], + "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.", + "type": "string" + }, + "description": { + "description": "User friendly data source description string.", + "type": "string" + }, + "dataSourceId": { + "description": "Data source id.", + "type": "string" + }, + "name": { + "description": "Data source resource name.", + "type": "string" + }, "scopes": { "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery", "type": "array", @@ -1643,10 +543,6 @@ "type": "string" } }, - "name": { - "description": "Data source resource name.", - "type": "string" - }, "minimumScheduleInterval": { "description": "The minimum interval for scheduler to schedule runs.", "format": "google-duration", @@ -1657,18 +553,18 @@ "type": "string" }, "authorizationType": { - "enumDescriptions": [ - "Type unspecified.", - "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.", - "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend." - ], "enum": [ "AUTHORIZATION_TYPE_UNSPECIFIED", "AUTHORIZATION_CODE", "GOOGLE_PLUS_AUTHORIZATION_CODE" ], "description": "Indicates the type of authorization.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Type unspecified.", + "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.", + "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend." + ] }, "supportsCustomSchedule": { "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.", @@ -1684,6 +580,8 @@ "type": "integer" }, "dataRefreshType": { + "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.", + "type": "string", "enumDescriptions": [ "The data source won't support data auto refresh, which is default value.", "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.", @@ -1693,9 +591,7 @@ "DATA_REFRESH_TYPE_UNSPECIFIED", "SLIDING_WINDOW", "CUSTOM_SLIDING_WINDOW" - ], - "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.", - "type": "string" + ] }, "parameters": { "description": "Data source parameters.", @@ -1715,37 +611,6 @@ "supportsMultipleTransfers": { "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.", "type": "boolean" - }, - "defaultDataRefreshWindowDays": { - "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.", - "format": "int32", - "type": "integer" - }, - "manualRunsDisabled": { - "description": "Disables backfilling and manual run scheduling\nfor the data source.", - "type": "boolean" - }, - "transferType": { - "enum": [ - "TRANSFER_TYPE_UNSPECIFIED", - "BATCH", - "STREAMING" - ], - "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.", - "type": "string", - "enumDescriptions": [ - "Invalid or Unknown transfer type placeholder.", - "Batch data transfer.", - "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project." - ] - }, - "description": { - "description": "User friendly data source description string.", - "type": "string" - }, - "dataSourceId": { - "description": "Data source id.", - "type": "string" } }, "id": "DataSource", @@ -1762,14 +627,14 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, "https://www.googleapis.com/auth/bigquery": { "description": "View and manage your data in Google BigQuery" }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" } } } @@ -1779,5 +644,1140 @@ "name": "bigquerydatatransfer", "batchPath": "batch", "fullyEncodeReservedExpansion": true, - "title": "BigQuery Data Transfer API" + "title": "BigQuery Data Transfer API", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "list": { + "response": { + "$ref": "ListLocationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + }, + "name": { + "location": "path", + "description": "The resource that owns the locations collection, if applicable.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1/projects/{projectsId}/locations", + "path": "v1/{+name}/locations", + "id": "bigquerydatatransfer.projects.locations.list", + "description": "Lists information about the supported locations for this service." + }, + "get": { + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.get", + "description": "Get information about a location.", + "response": { + "$ref": "Location" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "name": { + "description": "Resource name for the location.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}" + } + }, + "resources": { + "dataSources": { + "methods": { + "checkValidCreds": { + "path": "v1/{+name}:checkValidCreds", + "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds", + "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.", + "request": { + "$ref": "CheckValidCredsRequest" + }, + "response": { + "$ref": "CheckValidCredsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "name": { + "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds" + }, + "get": { + "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.", + "response": { + "$ref": "DataSource" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "location": "path", + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.dataSources.get" + }, + "list": { + "response": { + "$ref": "ListDataSourcesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "location": "path", + "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources", + "path": "v1/{+parent}/dataSources", + "id": "bigquerydatatransfer.projects.locations.dataSources.list", + "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering." + } + } + }, + "transferConfigs": { + "resources": { + "runs": { + "methods": { + "delete": { + "description": "Deletes the specified transfer run.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete" + }, + "get": { + "response": { + "$ref": "TransferRun" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", + "location": "path", + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get", + "description": "Returns information about the particular transfer run." + }, + "list": { + "response": { + "$ref": "ListTransferRunsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "location": "query", + "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string" + }, + "states": { + "location": "query", + "enum": [ + "TRANSFER_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "description": "When specified, only transfer runs with requested states are returned.", + "type": "string", + "repeated": true + }, + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "runAttempt": { + "location": "query", + "enum": [ + "RUN_ATTEMPT_UNSPECIFIED", + "LATEST" + ], + "description": "Indicates how run attempts are to be pulled.", + "type": "string" + }, + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", + "location": "path", + "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs", + "path": "v1/{+parent}/runs", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list", + "description": "Returns information about running and completed jobs." + } + }, + "resources": { + "transferLogs": { + "methods": { + "list": { + "path": "v1/{+parent}/transferLogs", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list", + "description": "Returns user facing log messages for the data transfer run.", + "response": { + "$ref": "ListTransferLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "messageTypes": { + "location": "query", + "enum": [ + "MESSAGE_SEVERITY_UNSPECIFIED", + "INFO", + "WARNING", + "ERROR" + ], + "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.", + "type": "string", + "repeated": true + }, + "parent": { + "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs" + } + } + } + } + } + }, + "methods": { + "create": { + "request": { + "$ref": "TransferConfig" + }, + "description": "Creates a new data transfer configuration.", + "response": { + "$ref": "TransferConfig" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "authorizationCode": { + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "type": "string", + "location": "query" + }, + "parent": { + "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", + "path": "v1/{+parent}/transferConfigs", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.create" + }, + "scheduleRuns": { + "response": { + "$ref": "ScheduleTransferRunsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns", + "path": "v1/{+parent}:scheduleRuns", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns", + "request": { + "$ref": "ScheduleTransferRunsRequest" + }, + "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range." + }, + "get": { + "response": { + "$ref": "TransferConfig" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.get", + "description": "Returns information about a data transfer config." + }, + "patch": { + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch", + "request": { + "$ref": "TransferConfig" + }, + "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.", + "response": { + "$ref": "TransferConfig" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "authorizationCode": { + "location": "query", + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "type": "string" + }, + "updateMask": { + "location": "query", + "description": "Required list of fields to be updated in this request.", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", + "location": "path", + "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete", + "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs." + }, + "list": { + "description": "Returns information about all data transfers in the project.", + "httpMethod": "GET", + "response": { + "$ref": "ListTransferConfigsResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageToken": { + "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer" + }, + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", + "required": true, + "type": "string" + }, + "dataSourceIds": { + "repeated": true, + "location": "query", + "description": "When specified, only configurations of requested data sources are returned.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs", + "id": "bigquerydatatransfer.projects.locations.transferConfigs.list", + "path": "v1/{+parent}/transferConfigs" + } + } + } + } + }, + "dataSources": { + "methods": { + "get": { + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.dataSources.get", + "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.", + "response": { + "$ref": "DataSource" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/dataSources/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}" + }, + "list": { + "id": "bigquerydatatransfer.projects.dataSources.list", + "path": "v1/{+parent}/dataSources", + "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.", + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListDataSourcesResponse" + }, + "parameters": { + "pageToken": { + "location": "query", + "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string" + }, + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/dataSources" + }, + "checkValidCreds": { + "flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds", + "path": "v1/{+name}:checkValidCreds", + "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds", + "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.", + "request": { + "$ref": "CheckValidCredsRequest" + }, + "response": { + "$ref": "CheckValidCredsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "name": { + "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/dataSources/[^/]+$", + "location": "path" + } + } + } + } + }, + "transferConfigs": { + "methods": { + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", + "location": "path", + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.transferConfigs.delete", + "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs." + }, + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListTransferConfigsResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageToken": { + "location": "query", + "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string" + }, + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "dataSourceIds": { + "description": "When specified, only configurations of requested data sources are returned.", + "type": "string", + "repeated": true, + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/transferConfigs", + "id": "bigquerydatatransfer.projects.transferConfigs.list", + "path": "v1/{+parent}/transferConfigs", + "description": "Returns information about all data transfers in the project." + }, + "create": { + "response": { + "$ref": "TransferConfig" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "authorizationCode": { + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "type": "string", + "location": "query" + }, + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nIf specified location and location of the destination bigquery dataset\ndo not match - the request will fail.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/transferConfigs", + "path": "v1/{+parent}/transferConfigs", + "id": "bigquerydatatransfer.projects.transferConfigs.create", + "description": "Creates a new data transfer configuration.", + "request": { + "$ref": "TransferConfig" + } + }, + "scheduleRuns": { + "response": { + "$ref": "ScheduleTransferRunsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns", + "path": "v1/{+parent}:scheduleRuns", + "id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns", + "request": { + "$ref": "ScheduleTransferRunsRequest" + }, + "description": "Creates transfer runs for a time range [start_time, end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range." + }, + "patch": { + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.transferConfigs.patch", + "request": { + "$ref": "TransferConfig" + }, + "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.", + "response": { + "$ref": "TransferConfig" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "updateMask": { + "description": "Required list of fields to be updated in this request.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "name": { + "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", + "location": "path", + "description": "The resource name of the transfer config.\nTransfer config names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer\nconfig.", + "required": true, + "type": "string" + }, + "authorizationCode": { + "location": "query", + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\nauthorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.transferConfigs.get", + "description": "Returns information about a data transfer config.", + "response": { + "$ref": "TransferConfig" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "name": { + "location": "path", + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/transferConfigs/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}" + } + }, + "resources": { + "runs": { + "resources": { + "transferLogs": { + "methods": { + "list": { + "path": "v1/{+parent}/transferLogs", + "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list", + "description": "Returns user facing log messages for the data transfer run.", + "response": { + "$ref": "ListTransferLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "parent": { + "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string" + }, + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "messageTypes": { + "enum": [ + "MESSAGE_SEVERITY_UNSPECIFIED", + "INFO", + "WARNING", + "ERROR" + ], + "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.", + "type": "string", + "repeated": true, + "location": "query" + } + }, + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs" + } + } + } + }, + "methods": { + "delete": { + "description": "Deletes the specified transfer run.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", + "location": "path", + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", + "path": "v1/{+name}", + "id": "bigquerydatatransfer.projects.transferConfigs.runs.delete" + }, + "get": { + "description": "Returns information about the particular transfer run.", + "httpMethod": "GET", + "response": { + "$ref": "TransferRun" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$", + "location": "path", + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}", + "id": "bigquerydatatransfer.projects.transferConfigs.runs.get", + "path": "v1/{+name}" + }, + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListTransferRunsResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageToken": { + "location": "query", + "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.", + "type": "string" + }, + "states": { + "location": "query", + "enum": [ + "TRANSFER_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "SUCCEEDED", + "FAILED", + "CANCELLED" + ], + "description": "When specified, only transfer runs with requested states are returned.", + "type": "string", + "repeated": true + }, + "pageSize": { + "description": "Page size. The default page size is the maximum value of 1000 results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "runAttempt": { + "description": "Indicates how run attempts are to be pulled.", + "type": "string", + "location": "query", + "enum": [ + "RUN_ATTEMPT_UNSPECIFIED", + "LATEST" + ] + }, + "parent": { + "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/transferConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/bigquery", + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs", + "id": "bigquerydatatransfer.projects.transferConfigs.runs.list", + "path": "v1/{+parent}/runs", + "description": "Returns information about running and completed jobs." + } + } + } + } + } + } + } + }, + "parameters": { + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://bigquerydatatransfer.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.", + "servicePath": "", + "basePath": "" }
diff --git a/classroom/v1/classroom-api.json b/classroom/v1/classroom-api.json index 2a96e5e..a363f2a 100644 --- a/classroom/v1/classroom-api.json +++ b/classroom/v1/classroom-api.json
@@ -1,290 +1,192 @@ { - "protocol": "rest", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "version": "v1", - "baseUrl": "https://classroom.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/classroom.profile.photos": { - "description": "View the profile photos of people in your classes" - }, - "https://www.googleapis.com/auth/classroom.rosters.readonly": { - "description": "View your Google Classroom class rosters" - }, - "https://www.googleapis.com/auth/classroom.guardianlinks.students": { - "description": "View and manage guardians for students in your Google Classroom classes" - }, - "https://www.googleapis.com/auth/classroom.announcements.readonly": { - "description": "View announcements in Google Classroom" - }, - "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": { - "description": "View your course work and grades in Google Classroom" - }, - "https://www.googleapis.com/auth/classroom.coursework.students": { - "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer" - }, - "https://www.googleapis.com/auth/classroom.coursework.students.readonly": { - "description": "View course work and grades for students in the Google Classroom classes you teach or administer" - }, - "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": { - "description": "View your Google Classroom guardians" - }, - "https://www.googleapis.com/auth/classroom.coursework.me.readonly": { - "description": "View your course work and grades in Google Classroom" - }, - "https://www.googleapis.com/auth/classroom.profile.emails": { - "description": "View the email addresses of people in your classes" - }, - "https://www.googleapis.com/auth/classroom.coursework.me": { - "description": "Manage your course work and view your grades in Google Classroom" - }, - "https://www.googleapis.com/auth/classroom.push-notifications": { - "description": "Receive notifications about your Google Classroom data" - }, - "https://www.googleapis.com/auth/classroom.rosters": { - "description": "Manage your Google Classroom class rosters" - }, - "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": { - "description": "View course work and grades for students in the Google Classroom classes you teach or administer" - }, - "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": { - "description": "View guardians for students in your Google Classroom classes" - }, - "https://www.googleapis.com/auth/classroom.courses": { - "description": "Manage your Google Classroom classes" - }, - "https://www.googleapis.com/auth/classroom.courses.readonly": { - "description": "View your Google Classroom classes" - }, - "https://www.googleapis.com/auth/classroom.announcements": { - "description": "View and manage announcements in Google Classroom" - } - } - } - }, - "kind": "discovery#restDescription", - "description": "Manages classes, rosters, and invitations in Google Classroom.", - "servicePath": "", - "rootUrl": "https://classroom.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "classroom", - "batchPath": "batch", - "revision": "20180103", - "documentationLink": "https://developers.google.com/classroom/", - "id": "classroom:v1", - "title": "Google Classroom API", "discoveryVersion": "v1", "ownerName": "Google", "resources": { - "invitations": { + "courses": { "methods": { - "create": { - "id": "classroom.invitations.create", - "path": "v1/invitations", - "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.", - "request": { - "$ref": "Invitation" - }, - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "Invitation" - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters" - ], - "parameters": {}, - "flatPath": "v1/invitations" - }, - "accept": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "id" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters" - ], - "parameters": { - "id": { - "description": "Identifier of the invitation to accept.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/invitations/{id}:accept", - "path": "v1/invitations/{id}:accept", - "id": "classroom.invitations.accept", - "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID." - }, "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "id" - ], "response": { "$ref": "Empty" }, + "parameterOrder": [ + "id" + ], + "httpMethod": "DELETE", "parameters": { "id": { "location": "path", - "description": "Identifier of the invitation to delete.", + "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, "type": "string" } }, "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters" + "https://www.googleapis.com/auth/classroom.courses" ], - "flatPath": "v1/invitations/{id}", - "id": "classroom.invitations.delete", - "path": "v1/invitations/{id}", - "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID." + "flatPath": "v1/courses/{id}", + "path": "v1/courses/{id}", + "id": "classroom.courses.delete", + "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID." + }, + "list": { + "response": { + "$ref": "ListCoursesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses", + "https://www.googleapis.com/auth/classroom.courses.readonly" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "teacherId": { + "location": "query", + "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "type": "string" + }, + "courseStates": { + "location": "query", + "enum": [ + "COURSE_STATE_UNSPECIFIED", + "ACTIVE", + "ARCHIVED", + "PROVISIONED", + "DECLINED", + "SUSPENDED" + ], + "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.", + "type": "string", + "repeated": true + }, + "studentId": { + "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "type": "string" + } + }, + "flatPath": "v1/courses", + "path": "v1/courses", + "id": "classroom.courses.list", + "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist." + }, + "create": { + "path": "v1/courses", + "id": "classroom.courses.create", + "request": { + "$ref": "Course" + }, + "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.", + "response": { + "$ref": "Course" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses" + ], + "flatPath": "v1/courses" }, "get": { "response": { - "$ref": "Invitation" + "$ref": "Course" }, "parameterOrder": [ "id" ], "httpMethod": "GET", "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters", - "https://www.googleapis.com/auth/classroom.rosters.readonly" + "https://www.googleapis.com/auth/classroom.courses", + "https://www.googleapis.com/auth/classroom.courses.readonly" ], "parameters": { "id": { - "description": "Identifier of the invitation to return.", + "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, "type": "string", "location": "path" } }, - "flatPath": "v1/invitations/{id}", - "path": "v1/invitations/{id}", - "id": "classroom.invitations.get", - "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID." + "flatPath": "v1/courses/{id}", + "path": "v1/courses/{id}", + "id": "classroom.courses.get", + "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID." }, - "list": { - "flatPath": "v1/invitations", - "path": "v1/invitations", - "id": "classroom.invitations.list", - "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.", + "patch": { "response": { - "$ref": "ListInvitationsResponse" + "$ref": "Course" }, - "parameterOrder": [], - "httpMethod": "GET", + "parameterOrder": [ + "id" + ], + "httpMethod": "PATCH", "parameters": { - "userId": { - "type": "string", + "updateMask": { "location": "query", - "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user" - }, - "pageToken": { - "location": "query", - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`", + "format": "google-fieldmask", "type": "string" }, - "pageSize": { - "location": "query", - "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32", - "type": "integer" - }, - "courseId": { - "location": "query", - "description": "Restricts returned invitations to those for a course with the specified\nidentifier.", + "id": { + "location": "path", + "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, "type": "string" } }, "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters", - "https://www.googleapis.com/auth/classroom.rosters.readonly" - ] + "https://www.googleapis.com/auth/classroom.courses" + ], + "flatPath": "v1/courses/{id}", + "path": "v1/courses/{id}", + "id": "classroom.courses.patch", + "request": { + "$ref": "Course" + }, + "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable" + }, + "update": { + "path": "v1/courses/{id}", + "id": "classroom.courses.update", + "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable", + "request": { + "$ref": "Course" + }, + "response": { + "$ref": "Course" + }, + "parameterOrder": [ + "id" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses" + ], + "parameters": { + "id": { + "location": "path", + "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/courses/{id}" } - } - }, - "courses": { + }, "resources": { "aliases": { "methods": { - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "courseId", - "alias" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses" - ], - "parameters": { - "courseId": { - "location": "path", - "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - }, - "alias": { - "location": "path", - "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/courses/{courseId}/aliases/{alias}", - "path": "v1/courses/{courseId}/aliases/{alias}", - "id": "classroom.courses.aliases.delete", - "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias)." - }, - "list": { - "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.", - "response": { - "$ref": "ListCourseAliasesResponse" - }, - "parameterOrder": [ - "courseId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses", - "https://www.googleapis.com/auth/classroom.courses.readonly" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", - "type": "string" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32" - }, - "courseId": { - "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/courses/{courseId}/aliases", - "path": "v1/courses/{courseId}/aliases", - "id": "classroom.courses.aliases.list" - }, "create": { "response": { "$ref": "CourseAlias" @@ -311,6 +213,73 @@ "request": { "$ref": "CourseAlias" } + }, + "delete": { + "flatPath": "v1/courses/{courseId}/aliases/{alias}", + "path": "v1/courses/{courseId}/aliases/{alias}", + "id": "classroom.courses.aliases.delete", + "description": "Deletes an alias of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to remove the\nalias or for access errors.\n* `NOT_FOUND` if the alias does not exist.\n* `FAILED_PRECONDITION` if the alias requested does not make sense for the\n requesting user or course (for example, if a user not in a domain\n attempts to delete a domain-scoped alias).", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "courseId", + "alias" + ], + "httpMethod": "DELETE", + "parameters": { + "courseId": { + "location": "path", + "description": "Identifier of the course whose alias should be deleted.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "alias": { + "description": "Alias to delete.\nThis may not be the Classroom-assigned identifier.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses" + ] + }, + "list": { + "path": "v1/courses/{courseId}/aliases", + "id": "classroom.courses.aliases.list", + "description": "Returns a list of aliases for a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\ncourse or for access errors.\n* `NOT_FOUND` if the course does not exist.", + "response": { + "$ref": "ListCourseAliasesResponse" + }, + "parameterOrder": [ + "courseId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.courses", + "https://www.googleapis.com/auth/classroom.courses.readonly" + ], + "parameters": { + "pageToken": { + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "courseId": { + "location": "path", + "description": "The identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/courses/{courseId}/aliases" } } }, @@ -318,25 +287,113 @@ "resources": { "studentSubmissions": { "methods": { - "turnIn": { - "httpMethod": "POST", + "patch": { + "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "request": { + "$ref": "StudentSubmission" + }, + "response": { + "$ref": "StudentSubmission" + }, "parameterOrder": [ "courseId", "courseWorkId", "id" ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.me", + "https://www.googleapis.com/auth/classroom.coursework.students" + ], + "parameters": { + "updateMask": { + "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "courseWorkId": { + "location": "path", + "description": "Identifier of the course work.", + "required": true, + "type": "string" + }, + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "id": { + "location": "path", + "description": "Identifier of the student submission.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", + "id": "classroom.courses.courseWork.studentSubmissions.patch" + }, + "get": { + "response": { + "$ref": "StudentSubmission" + }, + "parameterOrder": [ + "courseId", + "courseWorkId", + "id" + ], + "httpMethod": "GET", + "parameters": { + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "id": { + "description": "Identifier of the student submission.", + "required": true, + "type": "string", + "location": "path" + }, + "courseWorkId": { + "location": "path", + "description": "Identifier of the course work.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.me", + "https://www.googleapis.com/auth/classroom.coursework.me.readonly", + "https://www.googleapis.com/auth/classroom.coursework.students", + "https://www.googleapis.com/auth/classroom.coursework.students.readonly", + "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly", + "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" + ], + "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", + "id": "classroom.courses.courseWork.studentSubmissions.get", + "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist." + }, + "return": { "response": { "$ref": "Empty" }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.me" + "parameterOrder": [ + "courseId", + "courseWorkId", + "id" ], + "httpMethod": "POST", "parameters": { "courseWorkId": { - "required": true, - "type": "string", "location": "path", - "description": "Identifier of the course work." + "description": "Identifier of the course work.", + "required": true, + "type": "string" }, "courseId": { "location": "path", @@ -351,89 +408,98 @@ "location": "path" } }, - "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn", - "id": "classroom.courses.courseWork.studentSubmissions.turnIn", - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn", - "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.students" + ], + "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", + "id": "classroom.courses.courseWork.studentSubmissions.return", "request": { - "$ref": "TurnInStudentSubmissionRequest" - } + "$ref": "ReturnStudentSubmissionRequest" + }, + "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist." }, - "list": { + "reclaim": { "response": { - "$ref": "ListStudentSubmissionsResponse" + "$ref": "Empty" }, "parameterOrder": [ "courseId", - "courseWorkId" + "courseWorkId", + "id" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.me", - "https://www.googleapis.com/auth/classroom.coursework.me.readonly", - "https://www.googleapis.com/auth/classroom.coursework.students", - "https://www.googleapis.com/auth/classroom.coursework.students.readonly", - "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly", - "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" - ], + "httpMethod": "POST", "parameters": { - "late": { - "location": "query", - "enum": [ - "LATE_VALUES_UNSPECIFIED", - "LATE_ONLY", - "NOT_LATE_ONLY" - ], - "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", - "type": "string" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32" - }, - "states": { - "location": "query", - "enum": [ - "SUBMISSION_STATE_UNSPECIFIED", - "NEW", - "CREATED", - "TURNED_IN", - "RETURNED", - "RECLAIMED_BY_STUDENT" - ], - "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.", - "type": "string", - "repeated": true - }, - "userId": { - "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", - "type": "string", - "location": "query" - }, "courseWorkId": { - "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.", + "description": "Identifier of the course work.", "required": true, "type": "string", "location": "path" }, "courseId": { - "required": true, - "type": "string", "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias." + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "id": { + "location": "path", + "description": "Identifier of the student submission.", + "required": true, + "type": "string" } }, - "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", - "id": "classroom.courses.courseWork.studentSubmissions.list", - "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist." + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.me" + ], + "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", + "id": "classroom.courses.courseWork.studentSubmissions.reclaim", + "request": { + "$ref": "ReclaimStudentSubmissionRequest" + }, + "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist." + }, + "turnIn": { + "request": { + "$ref": "TurnInStudentSubmissionRequest" + }, + "description": "Turns in a student submission.\n\nTurning in a student submission transfers ownership of attached Drive\nfiles to the teacher and may also update the submission state.\n\nThis may only be called by the student that owns the specified student\nsubmission.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, turn in the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", + "httpMethod": "POST", + "parameterOrder": [ + "courseId", + "courseWorkId", + "id" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "courseId": { + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string", + "location": "path" + }, + "id": { + "location": "path", + "description": "Identifier of the student submission.", + "required": true, + "type": "string" + }, + "courseWorkId": { + "location": "path", + "description": "Identifier of the course work.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.me" + ], + "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn", + "id": "classroom.courses.courseWork.studentSubmissions.turnIn", + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:turnIn" }, "modifyAttachments": { "request": { @@ -457,16 +523,16 @@ "location": "path" }, "courseId": { + "location": "path", "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, + "type": "string" + }, + "id": { + "description": "Identifier of the student submission.", + "required": true, "type": "string", "location": "path" - }, - "id": { - "location": "path", - "description": "Identifier of the student submission.", - "required": true, - "type": "string" } }, "scopes": [ @@ -477,14 +543,14 @@ "id": "classroom.courses.courseWork.studentSubmissions.modifyAttachments", "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:modifyAttachments" }, - "get": { + "list": { + "description": "Returns a list of student submissions that the requester is permitted to\nview, factoring in the OAuth scopes of the request.\n`-` may be specified as the `course_work_id` to include student\nsubmissions for multiple course work items.\n\nCourse students may only view their own work. Course teachers\nand domain administrators may view all student submissions.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", "response": { - "$ref": "StudentSubmission" + "$ref": "ListStudentSubmissionsResponse" }, "parameterOrder": [ "courseId", - "courseWorkId", - "id" + "courseWorkId" ], "httpMethod": "GET", "scopes": [ @@ -496,273 +562,69 @@ "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly" ], "parameters": { - "courseWorkId": { - "location": "path", - "description": "Identifier of the course work.", - "required": true, - "type": "string" - }, - "courseId": { - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - }, - "id": { - "required": true, - "type": "string", - "location": "path", - "description": "Identifier of the student submission." - } - }, - "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", - "id": "classroom.courses.courseWork.studentSubmissions.get", - "description": "Returns a student submission.\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, course work, or student submission or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist." - }, - "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "courseId", - "courseWorkId", - "id" - ], - "response": { - "$ref": "StudentSubmission" - }, - "parameters": { - "id": { - "location": "path", - "description": "Identifier of the student submission.", - "required": true, - "type": "string" - }, - "updateMask": { + "userId": { "location": "query", - "description": "Mask that identifies which fields on the student submission to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified.\n\nThe following fields may be specified by teachers:\n\n* `draft_grade`\n* `assigned_grade`", - "format": "google-fieldmask", + "description": "Optional argument to restrict returned student work to those owned by the\nstudent with the specified identifier. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", "type": "string" }, "courseWorkId": { - "location": "path", - "description": "Identifier of the course work.", - "required": true, - "type": "string" - }, - "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the student work to request.\nThis may be set to the string literal `\"-\"` to request student work for\nall course work in the specified course.", "required": true, "type": "string", "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.me", - "https://www.googleapis.com/auth/classroom.coursework.students" - ], - "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", - "id": "classroom.courses.courseWork.studentSubmissions.patch", - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}", - "request": { - "$ref": "StudentSubmission" - }, - "description": "Updates one or more fields of a student submission.\n\nSee google.classroom.v1.StudentSubmission for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist." - }, - "return": { - "description": "Returns a student submission.\n\nReturning a student submission transfers ownership of attached Drive\nfiles to the student and may also update the submission state.\nUnlike the Classroom application, returning a student submission does not\nset assignedGrade to the draftGrade value.\n\nOnly a teacher of the course that contains the requested student submission\nmay call this method.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, return the requested student submission,\nor for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", - "request": { - "$ref": "ReturnStudentSubmissionRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "courseId", - "courseWorkId", - "id" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.students" - ], - "parameters": { + }, "courseId": { "location": "path", "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, "type": "string" }, - "id": { - "description": "Identifier of the student submission.", - "required": true, + "late": { + "enum": [ + "LATE_VALUES_UNSPECIFIED", + "LATE_ONLY", + "NOT_LATE_ONLY" + ], + "description": "Requested lateness value. If specified, returned student submissions are\nrestricted by the requested value.\nIf unspecified, submissions are returned regardless of `late` value.", "type": "string", - "location": "path" + "location": "query" }, - "courseWorkId": { - "description": "Identifier of the course work.", - "required": true, + "pageToken": { + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", "type": "string", - "location": "path" + "location": "query" + }, + "states": { + "enum": [ + "SUBMISSION_STATE_UNSPECIFIED", + "NEW", + "CREATED", + "TURNED_IN", + "RETURNED", + "RECLAIMED_BY_STUDENT" + ], + "description": "Requested submission states. If specified, returned student submissions\nmatch one of the specified submission states.", + "type": "string", + "repeated": true, + "location": "query" + }, + "pageSize": { + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer", + "location": "query" } }, - "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:return", - "id": "classroom.courses.courseWork.studentSubmissions.return" - }, - "reclaim": { - "httpMethod": "POST", - "parameterOrder": [ - "courseId", - "courseWorkId", - "id" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "courseId": { - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - }, - "id": { - "required": true, - "type": "string", - "location": "path", - "description": "Identifier of the student submission." - }, - "courseWorkId": { - "location": "path", - "description": "Identifier of the course work.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.me" - ], - "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", - "id": "classroom.courses.courseWork.studentSubmissions.reclaim", - "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions/{id}:reclaim", - "request": { - "$ref": "ReclaimStudentSubmissionRequest" - }, - "description": "Reclaims a student submission on behalf of the student that owns it.\n\nReclaiming a student submission transfers ownership of attached Drive\nfiles to the student and update the submission state.\n\nOnly the student that owns the requested student submission may call this\nmethod, and only for a student submission that has been turned in.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, unsubmit the requested student submission,\nor for access errors.\n* `FAILED_PRECONDITION` if the student submission has not been turned in.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist." + "flatPath": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", + "path": "v1/courses/{courseId}/courseWork/{courseWorkId}/studentSubmissions", + "id": "classroom.courses.courseWork.studentSubmissions.list" } } } }, "methods": { - "modifyAssignees": { - "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", - "request": { - "$ref": "ModifyCourseWorkAssigneesRequest" - }, - "response": { - "$ref": "CourseWork" - }, - "parameterOrder": [ - "courseId", - "id" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.students" - ], - "parameters": { - "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string", - "location": "path" - }, - "id": { - "description": "Identifier of the coursework.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", - "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", - "id": "classroom.courses.courseWork.modifyAssignees" - }, - "patch": { - "request": { - "$ref": "CourseWork" - }, - "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", - "response": { - "$ref": "CourseWork" - }, - "parameterOrder": [ - "courseId", - "id" - ], - "httpMethod": "PATCH", - "parameters": { - "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string", - "location": "path" - }, - "id": { - "required": true, - "type": "string", - "location": "path", - "description": "Identifier of the course work." - }, - "updateMask": { - "location": "query", - "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`", - "format": "google-fieldmask", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.students" - ], - "flatPath": "v1/courses/{courseId}/courseWork/{id}", - "path": "v1/courses/{courseId}/courseWork/{id}", - "id": "classroom.courses.courseWork.patch" - }, - "get": { - "httpMethod": "GET", - "parameterOrder": [ - "courseId", - "id" - ], - "response": { - "$ref": "CourseWork" - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.me", - "https://www.googleapis.com/auth/classroom.coursework.me.readonly", - "https://www.googleapis.com/auth/classroom.coursework.students", - "https://www.googleapis.com/auth/classroom.coursework.students.readonly" - ], - "parameters": { - "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string", - "location": "path" - }, - "id": { - "location": "path", - "description": "Identifier of the course work.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/courses/{courseId}/courseWork/{id}", - "id": "classroom.courses.courseWork.get", - "path": "v1/courses/{courseId}/courseWork/{id}", - "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist." - }, "delete": { + "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.", "response": { "$ref": "Empty" }, @@ -790,10 +652,10 @@ }, "flatPath": "v1/courses/{courseId}/courseWork/{id}", "path": "v1/courses/{courseId}/courseWork/{id}", - "id": "classroom.courses.courseWork.delete", - "description": "Deletes a course work.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID." + "id": "classroom.courses.courseWork.delete" }, "list": { + "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", "response": { "$ref": "ListCourseWorkResponse" }, @@ -808,6 +670,30 @@ "https://www.googleapis.com/auth/classroom.coursework.students.readonly" ], "parameters": { + "pageSize": { + "location": "query", + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer" + }, + "courseWorkStates": { + "enum": [ + "COURSE_WORK_STATE_UNSPECIFIED", + "PUBLISHED", + "DRAFT", + "DELETED" + ], + "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.", + "type": "string", + "repeated": true, + "location": "query" + }, + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, "orderBy": { "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported fields are `updateTime`\nand `dueDate`. Supported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `dueDate asc,updateTime desc`, `updateTime,dueDate desc`", "type": "string", @@ -817,42 +703,13 @@ "location": "query", "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", "type": "string" - }, - "pageSize": { - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "courseWorkStates": { - "repeated": true, - "location": "query", - "enum": [ - "COURSE_WORK_STATE_UNSPECIFIED", - "PUBLISHED", - "DRAFT", - "DELETED" - ], - "description": "Restriction on the work status to return. Only courseWork that matches\nis returned. If unspecified, items with a work status of `PUBLISHED`\nis returned.", - "type": "string" - }, - "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string", - "location": "path" } }, "flatPath": "v1/courses/{courseId}/courseWork", "path": "v1/courses/{courseId}/courseWork", - "id": "classroom.courses.courseWork.list", - "description": "Returns a list of course work that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` course work. Course teachers\nand domain administrators may view all course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist." + "id": "classroom.courses.courseWork.list" }, "create": { - "request": { - "$ref": "CourseWork" - }, - "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible", "response": { "$ref": "CourseWork" }, @@ -862,10 +719,10 @@ "httpMethod": "POST", "parameters": { "courseId": { - "location": "path", "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ @@ -873,164 +730,21 @@ ], "flatPath": "v1/courses/{courseId}/courseWork", "path": "v1/courses/{courseId}/courseWork", - "id": "classroom.courses.courseWork.create" - } - } - }, - "teachers": { - "methods": { - "delete": { - "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "courseId", - "userId" - ], - "httpMethod": "DELETE", - "parameters": { - "courseId": { - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - }, - "userId": { - "location": "path", - "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters" - ], - "flatPath": "v1/courses/{courseId}/teachers/{userId}", - "path": "v1/courses/{courseId}/teachers/{userId}", - "id": "classroom.courses.teachers.delete" - }, - "get": { - "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.", - "httpMethod": "GET", - "parameterOrder": [ - "courseId", - "userId" - ], - "response": { - "$ref": "Teacher" - }, - "parameters": { - "userId": { - "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", - "required": true, - "type": "string", - "location": "path" - }, - "courseId": { - "required": true, - "type": "string", - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.profile.emails", - "https://www.googleapis.com/auth/classroom.profile.photos", - "https://www.googleapis.com/auth/classroom.rosters", - "https://www.googleapis.com/auth/classroom.rosters.readonly" - ], - "flatPath": "v1/courses/{courseId}/teachers/{userId}", - "id": "classroom.courses.teachers.get", - "path": "v1/courses/{courseId}/teachers/{userId}" - }, - "list": { - "httpMethod": "GET", - "response": { - "$ref": "ListTeachersResponse" - }, - "parameterOrder": [ - "courseId" - ], - "parameters": { - "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32" - }, - "courseId": { - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.profile.emails", - "https://www.googleapis.com/auth/classroom.profile.photos", - "https://www.googleapis.com/auth/classroom.rosters", - "https://www.googleapis.com/auth/classroom.rosters.readonly" - ], - "flatPath": "v1/courses/{courseId}/teachers", - "id": "classroom.courses.teachers.list", - "path": "v1/courses/{courseId}/teachers", - "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors." - }, - "create": { - "response": { - "$ref": "Teacher" - }, - "parameterOrder": [ - "courseId" - ], - "httpMethod": "POST", - "parameters": { - "courseId": { - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.profile.emails", - "https://www.googleapis.com/auth/classroom.profile.photos", - "https://www.googleapis.com/auth/classroom.rosters" - ], - "flatPath": "v1/courses/{courseId}/teachers", - "path": "v1/courses/{courseId}/teachers", - "id": "classroom.courses.teachers.create", + "id": "classroom.courses.courseWork.create", "request": { - "$ref": "Teacher" + "$ref": "CourseWork" }, - "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse." - } - } - }, - "announcements": { - "methods": { + "description": "Creates course work.\n\nThe resulting course work (and corresponding student submissions) are\nassociated with the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\nmake the request. Classroom API requests to modify course work and student\nsubmissions must be made with an OAuth client ID from the associated\nDeveloper Console project.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create course work in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible" + }, "modifyAssignees": { - "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", - "request": { - "$ref": "ModifyAnnouncementAssigneesRequest" - }, "response": { - "$ref": "Announcement" + "$ref": "CourseWork" }, "parameterOrder": [ "courseId", "id" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/classroom.announcements" - ], "parameters": { "courseId": { "location": "path", @@ -1039,57 +753,64 @@ "type": "string" }, "id": { - "location": "path", - "description": "Identifier of the announcement.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", - "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", - "id": "classroom.courses.announcements.modifyAssignees" - }, - "get": { - "parameters": { - "courseId": { - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the coursework.", "required": true, "type": "string", "location": "path" - }, - "id": { - "location": "path", - "description": "Identifier of the announcement.", - "required": true, - "type": "string" } }, "scopes": [ - "https://www.googleapis.com/auth/classroom.announcements", - "https://www.googleapis.com/auth/classroom.announcements.readonly" + "https://www.googleapis.com/auth/classroom.coursework.students" ], - "flatPath": "v1/courses/{courseId}/announcements/{id}", - "id": "classroom.courses.announcements.get", - "path": "v1/courses/{courseId}/announcements/{id}", - "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist.", - "httpMethod": "GET", + "flatPath": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", + "path": "v1/courses/{courseId}/courseWork/{id}:modifyAssignees", + "id": "classroom.courses.courseWork.modifyAssignees", + "request": { + "$ref": "ModifyCourseWorkAssigneesRequest" + }, + "description": "Modifies assignee mode and options of a coursework.\n\nOnly a teacher of the course that contains the coursework may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist." + }, + "get": { + "description": "Returns course work.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist.", "response": { - "$ref": "Announcement" + "$ref": "CourseWork" }, "parameterOrder": [ "courseId", "id" - ] + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.me", + "https://www.googleapis.com/auth/classroom.coursework.me.readonly", + "https://www.googleapis.com/auth/classroom.coursework.students", + "https://www.googleapis.com/auth/classroom.coursework.students.readonly" + ], + "parameters": { + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "id": { + "location": "path", + "description": "Identifier of the course work.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/courses/{courseId}/courseWork/{id}", + "path": "v1/courses/{courseId}/courseWork/{id}", + "id": "classroom.courses.courseWork.get" }, "patch": { - "path": "v1/courses/{courseId}/announcements/{id}", - "id": "classroom.courses.announcements.patch", - "description": "Updates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if the requested course or announcement does not exist", + "description": "Updates one or more fields of a course work.\n\nSee google.classroom.v1.CourseWork for details\nof which fields may be updated and who may change them.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding course work item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding course work, if the user is not permitted to make the\nrequested modification to the student submission, or for\naccess errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested course work has already been\ndeleted.\n* `NOT_FOUND` if the requested course, course work, or student submission\ndoes not exist.", "request": { - "$ref": "Announcement" + "$ref": "CourseWork" }, "response": { - "$ref": "Announcement" + "$ref": "CourseWork" }, "parameterOrder": [ "courseId", @@ -1097,20 +818,152 @@ ], "httpMethod": "PATCH", "scopes": [ - "https://www.googleapis.com/auth/classroom.announcements" + "https://www.googleapis.com/auth/classroom.coursework.students" ], "parameters": { + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, "id": { - "description": "Identifier of the announcement.", + "description": "Identifier of the course work.", "required": true, "type": "string", "location": "path" }, "updateMask": { - "description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`", + "location": "query", + "description": "Mask that identifies which fields on the course work to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the CourseWork object. If a\nfield that does not support empty values is included in the update mask and\nnot set in the CourseWork object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `title`\n* `description`\n* `state`\n* `due_date`\n* `due_time`\n* `max_points`\n* `scheduled_time`\n* `submission_modification_mode`", "format": "google-fieldmask", + "type": "string" + } + }, + "flatPath": "v1/courses/{courseId}/courseWork/{id}", + "path": "v1/courses/{courseId}/courseWork/{id}", + "id": "classroom.courses.courseWork.patch" + } + } + }, + "teachers": { + "methods": { + "get": { + "response": { + "$ref": "Teacher" + }, + "parameterOrder": [ + "courseId", + "userId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.profile.emails", + "https://www.googleapis.com/auth/classroom.profile.photos", + "https://www.googleapis.com/auth/classroom.rosters", + "https://www.googleapis.com/auth/classroom.rosters.readonly" + ], + "parameters": { + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "userId": { + "description": "Identifier of the teacher to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/courses/{courseId}/teachers/{userId}", + "path": "v1/courses/{courseId}/teachers/{userId}", + "id": "classroom.courses.teachers.get", + "description": "Returns a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist." + }, + "list": { + "response": { + "$ref": "ListTeachersResponse" + }, + "parameterOrder": [ + "courseId" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "location": "query", + "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer" + }, + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", "type": "string", "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.profile.emails", + "https://www.googleapis.com/auth/classroom.profile.photos", + "https://www.googleapis.com/auth/classroom.rosters", + "https://www.googleapis.com/auth/classroom.rosters.readonly" + ], + "flatPath": "v1/courses/{courseId}/teachers", + "path": "v1/courses/{courseId}/teachers", + "id": "classroom.courses.teachers.list", + "description": "Returns a list of teachers of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors." + }, + "create": { + "request": { + "$ref": "Teacher" + }, + "description": "Creates a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nteachers in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a teacher or student in the\ncourse.", + "response": { + "$ref": "Teacher" + }, + "parameterOrder": [ + "courseId" + ], + "httpMethod": "POST", + "parameters": { + "courseId": { + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.profile.emails", + "https://www.googleapis.com/auth/classroom.profile.photos", + "https://www.googleapis.com/auth/classroom.rosters" + ], + "flatPath": "v1/courses/{courseId}/teachers", + "path": "v1/courses/{courseId}/teachers", + "id": "classroom.courses.teachers.create" + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "courseId", + "userId" + ], + "httpMethod": "DELETE", + "parameters": { + "userId": { + "description": "Identifier of the teacher to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "required": true, + "type": "string", + "location": "path" }, "courseId": { "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", @@ -1119,10 +972,19 @@ "location": "path" } }, - "flatPath": "v1/courses/{courseId}/announcements/{id}" - }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters" + ], + "flatPath": "v1/courses/{courseId}/teachers/{userId}", + "path": "v1/courses/{courseId}/teachers/{userId}", + "id": "classroom.courses.teachers.delete", + "description": "Deletes a teacher of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nteachers of this course or for access errors.\n* `NOT_FOUND` if no teacher of this course has the requested ID or if the\ncourse does not exist.\n* `FAILED_PRECONDITION` if the requested ID belongs to the primary teacher\nof this course." + } + } + }, + "announcements": { + "methods": { "delete": { - "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID.", "response": { "$ref": "Empty" }, @@ -1133,16 +995,16 @@ "httpMethod": "DELETE", "parameters": { "courseId": { - "location": "path", "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "id": { - "location": "path", "description": "Identifier of the announcement to delete.\nThis identifier is a Classroom-assigned identifier.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ @@ -1150,16 +1012,18 @@ ], "flatPath": "v1/courses/{courseId}/announcements/{id}", "path": "v1/courses/{courseId}/announcements/{id}", - "id": "classroom.courses.announcements.delete" + "id": "classroom.courses.announcements.delete", + "description": "Deletes an announcement.\n\nThis request must be made by the Developer Console project of the\n[OAuth client ID](https://support.google.com/cloud/answer/6158849) used to\ncreate the corresponding announcement item.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement, if the requesting user is not permitted\nto delete the requested course or for access errors.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if no course exists with the requested ID." }, "list": { - "httpMethod": "GET", - "parameterOrder": [ - "courseId" - ], + "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", "response": { "$ref": "ListAnnouncementsResponse" }, + "parameterOrder": [ + "courseId" + ], + "httpMethod": "GET", "parameters": { "announcementStates": { "location": "query", @@ -1174,9 +1038,9 @@ "repeated": true }, "orderBy": { + "location": "query", "description": "Optional sort ordering for results. A comma-separated list of fields with\nan optional sort direction keyword. Supported field is `updateTime`.\nSupported direction keywords are `asc` and `desc`.\nIf not specified, `updateTime desc` is the default behavior.\nExamples: `updateTime asc`, `updateTime`", - "type": "string", - "location": "query" + "type": "string" }, "pageToken": { "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", @@ -1184,10 +1048,10 @@ "location": "query" }, "pageSize": { - "location": "query", "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "courseId": { "location": "path", @@ -1201,9 +1065,8 @@ "https://www.googleapis.com/auth/classroom.announcements.readonly" ], "flatPath": "v1/courses/{courseId}/announcements", - "id": "classroom.courses.announcements.list", "path": "v1/courses/{courseId}/announcements", - "description": "Returns a list of announcements that the requester is permitted to view.\n\nCourse students may only view `PUBLISHED` announcements. Course teachers\nand domain administrators may view all announcements.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist." + "id": "classroom.courses.announcements.list" }, "create": { "description": "Creates an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course, create announcements in the requested course, share a\nDrive attachment, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.\n* `FAILED_PRECONDITION` for the following request error:\n * AttachmentNotVisible", @@ -1231,54 +1094,97 @@ "flatPath": "v1/courses/{courseId}/announcements", "path": "v1/courses/{courseId}/announcements", "id": "classroom.courses.announcements.create" - } - } - }, - "students": { - "methods": { - "create": { - "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.", - "request": { - "$ref": "Student" - }, + }, + "modifyAssignees": { "response": { - "$ref": "Student" + "$ref": "Announcement" }, "parameterOrder": [ - "courseId" + "courseId", + "id" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/classroom.profile.emails", - "https://www.googleapis.com/auth/classroom.profile.photos", - "https://www.googleapis.com/auth/classroom.rosters" - ], "parameters": { - "enrollmentCode": { - "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.", - "type": "string", - "location": "query" - }, "courseId": { "location": "path", - "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "id": { + "location": "path", + "description": "Identifier of the announcement.", "required": true, "type": "string" } }, - "flatPath": "v1/courses/{courseId}/students", - "path": "v1/courses/{courseId}/students", - "id": "classroom.courses.students.create" - }, - "delete": { "scopes": [ - "https://www.googleapis.com/auth/classroom.rosters" + "https://www.googleapis.com/auth/classroom.announcements" + ], + "flatPath": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", + "path": "v1/courses/{courseId}/announcements/{id}:modifyAssignees", + "id": "classroom.courses.announcements.modifyAssignees", + "request": { + "$ref": "ModifyAnnouncementAssigneesRequest" + }, + "description": "Modifies assignee mode and options of an announcement.\n\nOnly a teacher of the course that contains the announcement may\ncall this method.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or course work or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or course work does not exist." + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "courseId", + "id" + ], + "response": { + "$ref": "Announcement" + }, + "parameters": { + "courseId": { + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string", + "location": "path" + }, + "id": { + "description": "Identifier of the announcement.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.announcements", + "https://www.googleapis.com/auth/classroom.announcements.readonly" + ], + "flatPath": "v1/courses/{courseId}/announcements/{id}", + "id": "classroom.courses.announcements.get", + "path": "v1/courses/{courseId}/announcements/{id}", + "description": "Returns an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or announcement, or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course or announcement does not exist." + }, + "patch": { + "flatPath": "v1/courses/{courseId}/announcements/{id}", + "path": "v1/courses/{courseId}/announcements/{id}", + "id": "classroom.courses.announcements.patch", + "description": "Updates one or more fields of an announcement.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting developer project did not create\nthe corresponding announcement or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `FAILED_PRECONDITION` if the requested announcement has already been\ndeleted.\n* `NOT_FOUND` if the requested course or announcement does not exist", + "request": { + "$ref": "Announcement" + }, + "response": { + "$ref": "Announcement" + }, + "parameterOrder": [ + "courseId", + "id" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/classroom.announcements" ], "parameters": { - "userId": { - "location": "path", - "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", - "required": true, + "updateMask": { + "location": "query", + "description": "Mask that identifies which fields on the announcement to update.\nThis field is required to do an update. The update fails if invalid\nfields are specified. If a field supports empty values, it can be cleared\nby specifying it in the update mask and not in the Announcement object. If\na field that does not support empty values is included in the update mask\nand not set in the Announcement object, an `INVALID_ARGUMENT` error will be\nreturned.\n\nThe following fields may be specified by teachers:\n\n* `text`\n* `state`\n* `scheduled_time`", + "format": "google-fieldmask", "type": "string" }, "courseId": { @@ -1286,22 +1192,22 @@ "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, "type": "string" + }, + "id": { + "location": "path", + "description": "Identifier of the announcement.", + "required": true, + "type": "string" } - }, - "flatPath": "v1/courses/{courseId}/students/{userId}", - "path": "v1/courses/{courseId}/students/{userId}", - "id": "classroom.courses.students.delete", - "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "courseId", - "userId" - ], - "httpMethod": "DELETE" - }, + } + } + } + }, + "students": { + "methods": { "get": { + "path": "v1/courses/{courseId}/students/{userId}", + "id": "classroom.courses.students.get", "description": "Returns a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist.", "response": { "$ref": "Student" @@ -1311,56 +1217,57 @@ "userId" ], "httpMethod": "GET", + "parameters": { + "courseId": { + "location": "path", + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string" + }, + "userId": { + "location": "path", + "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/classroom.profile.emails", "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" ], - "parameters": { - "userId": { - "description": "Identifier of the student to return. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", - "required": true, - "type": "string", - "location": "path" - }, - "courseId": { - "location": "path", - "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/courses/{courseId}/students/{userId}", - "path": "v1/courses/{courseId}/students/{userId}", - "id": "classroom.courses.students.get" + "flatPath": "v1/courses/{courseId}/students/{userId}" }, "list": { + "flatPath": "v1/courses/{courseId}/students", + "path": "v1/courses/{courseId}/students", + "id": "classroom.courses.students.list", "description": "Returns a list of students of this course that the requester\nis permitted to view.\n\nThis method returns the following error codes:\n\n* `NOT_FOUND` if the course does not exist.\n* `PERMISSION_DENIED` for access errors.", - "httpMethod": "GET", "response": { "$ref": "ListStudentsResponse" }, "parameterOrder": [ "courseId" ], + "httpMethod": "GET", "parameters": { - "pageToken": { - "location": "query", - "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", - "type": "string" - }, "pageSize": { - "type": "integer", "location": "query", "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32" + "format": "int32", + "type": "integer" }, "courseId": { + "location": "path", "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, + "type": "string" + }, + "pageToken": { + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating that\nthe subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", "type": "string", - "location": "path" + "location": "query" } }, "scopes": [ @@ -1368,10 +1275,72 @@ "https://www.googleapis.com/auth/classroom.profile.photos", "https://www.googleapis.com/auth/classroom.rosters", "https://www.googleapis.com/auth/classroom.rosters.readonly" - ], + ] + }, + "create": { "flatPath": "v1/courses/{courseId}/students", - "id": "classroom.courses.students.list", - "path": "v1/courses/{courseId}/students" + "path": "v1/courses/{courseId}/students", + "id": "classroom.courses.students.create", + "request": { + "$ref": "Student" + }, + "description": "Adds a user as a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\nstudents in this course or for access errors.\n* `NOT_FOUND` if the requested course ID does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled,\nfor the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if the user is already a student or teacher in the\ncourse.", + "response": { + "$ref": "Student" + }, + "parameterOrder": [ + "courseId" + ], + "httpMethod": "POST", + "parameters": { + "courseId": { + "description": "Identifier of the course to create the student in.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string", + "location": "path" + }, + "enrollmentCode": { + "location": "query", + "description": "Enrollment code of the course to create the student in.\nThis code is required if userId\ncorresponds to the requesting user; it may be omitted if the requesting\nuser has administrative permissions to create students for any user.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.profile.emails", + "https://www.googleapis.com/auth/classroom.profile.photos", + "https://www.googleapis.com/auth/classroom.rosters" + ] + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "courseId", + "userId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters" + ], + "parameters": { + "courseId": { + "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", + "required": true, + "type": "string", + "location": "path" + }, + "userId": { + "location": "path", + "description": "Identifier of the student to delete. The identifier can be one of the\nfollowing:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/courses/{courseId}/students/{userId}", + "path": "v1/courses/{courseId}/students/{userId}", + "id": "classroom.courses.students.delete", + "description": "Deletes a student of a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete\nstudents of this course or for access errors.\n* `NOT_FOUND` if no student of this course has the requested ID or if the\ncourse does not exist." } } }, @@ -1387,6 +1356,12 @@ "id" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.coursework.me", + "https://www.googleapis.com/auth/classroom.coursework.me.readonly", + "https://www.googleapis.com/auth/classroom.coursework.students", + "https://www.googleapis.com/auth/classroom.coursework.students.readonly" + ], "parameters": { "courseId": { "location": "path", @@ -1401,41 +1376,39 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.coursework.me", - "https://www.googleapis.com/auth/classroom.coursework.me.readonly", - "https://www.googleapis.com/auth/classroom.coursework.students", - "https://www.googleapis.com/auth/classroom.coursework.students.readonly" - ], "flatPath": "v1/courses/{courseId}/topics/{id}", "path": "v1/courses/{courseId}/topics/{id}", "id": "classroom.courses.topics.get" }, "list": { - "response": { - "$ref": "ListTopicResponse" - }, + "flatPath": "v1/courses/{courseId}/topics", + "id": "classroom.courses.topics.list", + "path": "v1/courses/{courseId}/topics", + "description": "Returns the list of topics that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist.", + "httpMethod": "GET", "parameterOrder": [ "courseId" ], - "httpMethod": "GET", + "response": { + "$ref": "ListTopicResponse" + }, "parameters": { - "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32", - "type": "integer" - }, "courseId": { - "location": "path", "description": "Identifier of the course.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", "type": "string" + }, + "pageSize": { + "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer", + "location": "query" } }, "scopes": [ @@ -1443,200 +1416,16 @@ "https://www.googleapis.com/auth/classroom.coursework.me.readonly", "https://www.googleapis.com/auth/classroom.coursework.students", "https://www.googleapis.com/auth/classroom.coursework.students.readonly" - ], - "flatPath": "v1/courses/{courseId}/topics", - "path": "v1/courses/{courseId}/topics", - "id": "classroom.courses.topics.list", - "description": "Returns the list of topics that the requester is permitted to view.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthe requested course or for access errors.\n* `INVALID_ARGUMENT` if the request is malformed.\n* `NOT_FOUND` if the requested course does not exist." + ] } } } - }, - "methods": { - "delete": { - "description": "Deletes a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.", - "httpMethod": "DELETE", - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses" - ], - "parameters": { - "id": { - "location": "path", - "description": "Identifier of the course to delete.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/courses/{id}", - "id": "classroom.courses.delete", - "path": "v1/courses/{id}" - }, - "list": { - "description": "Returns a list of courses that the requesting user is permitted to view,\nrestricted to those that match the request. Returned courses are ordered by\ncreation time, with the most recently created coming first.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors.\n* `INVALID_ARGUMENT` if the query argument is malformed.\n* `NOT_FOUND` if any users specified in the query arguments do not exist.", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListCoursesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses", - "https://www.googleapis.com/auth/classroom.courses.readonly" - ], - "parameters": { - "studentId": { - "description": "Restricts returned courses to those having a student with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32", - "type": "integer" - }, - "teacherId": { - "type": "string", - "location": "query", - "description": "Restricts returned courses to those having a teacher with the specified\nidentifier. The identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user" - }, - "courseStates": { - "enum": [ - "COURSE_STATE_UNSPECIFIED", - "ACTIVE", - "ARCHIVED", - "PROVISIONED", - "DECLINED", - "SUSPENDED" - ], - "description": "Restricts returned courses to those in one of the specified states\nThe default value is ACTIVE, ARCHIVED, PROVISIONED, DECLINED.", - "type": "string", - "repeated": true, - "location": "query" - } - }, - "flatPath": "v1/courses", - "id": "classroom.courses.list", - "path": "v1/courses" - }, - "create": { - "path": "v1/courses", - "id": "classroom.courses.create", - "description": "Creates a course.\n\nThe user specified in `ownerId` is the owner of the created course\nand added as a teacher.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ncourses or for access errors.\n* `NOT_FOUND` if the primary teacher is not a valid user.\n* `FAILED_PRECONDITION` if the course owner's account is disabled or for\nthe following request errors:\n * UserGroupsMembershipLimitReached\n* `ALREADY_EXISTS` if an alias was specified in the `id` and\nalready exists.", - "request": { - "$ref": "Course" - }, - "response": { - "$ref": "Course" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses" - ], - "parameters": {}, - "flatPath": "v1/courses" - }, - "get": { - "response": { - "$ref": "Course" - }, - "parameterOrder": [ - "id" - ], - "httpMethod": "GET", - "parameters": { - "id": { - "location": "path", - "description": "Identifier of the course to return.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses", - "https://www.googleapis.com/auth/classroom.courses.readonly" - ], - "flatPath": "v1/courses/{id}", - "path": "v1/courses/{id}", - "id": "classroom.courses.get", - "description": "Returns a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID." - }, - "patch": { - "response": { - "$ref": "Course" - }, - "parameterOrder": [ - "id" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses" - ], - "parameters": { - "id": { - "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string", - "location": "path" - }, - "updateMask": { - "location": "query", - "description": "Mask that identifies which fields on the course to update.\nThis field is required to do an update. The update will fail if invalid\nfields are specified. The following fields are valid:\n\n* `name`\n* `section`\n* `descriptionHeading`\n* `description`\n* `room`\n* `courseState`\n* `ownerId`\n\nNote: patches to ownerId are treated as being effective immediately, but in\npractice it may take some time for the ownership transfer of all affected\nresources to complete.\n\nWhen set in a query parameter, this field should be specified as\n\n`updateMask=\u003cfield1\u003e,\u003cfield2\u003e,...`", - "format": "google-fieldmask", - "type": "string" - } - }, - "flatPath": "v1/courses/{id}", - "path": "v1/courses/{id}", - "id": "classroom.courses.patch", - "description": "Updates one or more fields in a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `INVALID_ARGUMENT` if invalid fields are specified in the update mask or\nif no update mask is supplied.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable", - "request": { - "$ref": "Course" - } - }, - "update": { - "httpMethod": "PUT", - "parameterOrder": [ - "id" - ], - "response": { - "$ref": "Course" - }, - "parameters": { - "id": { - "location": "path", - "description": "Identifier of the course to update.\nThis identifier can be either the Classroom-assigned identifier or an\nalias.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.courses" - ], - "flatPath": "v1/courses/{id}", - "id": "classroom.courses.update", - "path": "v1/courses/{id}", - "request": { - "$ref": "Course" - }, - "description": "Updates a course.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to modify the\nrequested course or for access errors.\n* `NOT_FOUND` if no course exists with the requested ID.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseNotModifiable" - } } }, "userProfiles": { "methods": { "get": { + "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors.", "response": { "$ref": "UserProfile" }, @@ -1644,6 +1433,12 @@ "userId" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.profile.emails", + "https://www.googleapis.com/auth/classroom.profile.photos", + "https://www.googleapis.com/auth/classroom.rosters", + "https://www.googleapis.com/auth/classroom.rosters.readonly" + ], "parameters": { "userId": { "location": "path", @@ -1652,92 +1447,81 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.profile.emails", - "https://www.googleapis.com/auth/classroom.profile.photos", - "https://www.googleapis.com/auth/classroom.rosters", - "https://www.googleapis.com/auth/classroom.rosters.readonly" - ], "flatPath": "v1/userProfiles/{userId}", "path": "v1/userProfiles/{userId}", - "id": "classroom.userProfiles.get", - "description": "Returns a user profile.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to access\nthis user profile, if no profile exists with the requested ID, or for\naccess errors." + "id": "classroom.userProfiles.get" } }, "resources": { "guardianInvitations": { "methods": { "list": { + "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", + "id": "classroom.userProfiles.guardianInvitations.list", + "path": "v1/userProfiles/{studentId}/guardianInvitations", "description": "Returns a list of guardian invitations that the requesting user is\npermitted to view, filtered by the parameters provided.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian invitations for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` or `state` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.", + "httpMethod": "GET", "response": { "$ref": "ListGuardianInvitationsResponse" }, "parameterOrder": [ "studentId" ], - "httpMethod": "GET", "parameters": { - "invitedEmailAddress": { - "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.", + "studentId": { + "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", "type": "string", "location": "query" }, + "invitedEmailAddress": { + "location": "query", + "description": "If specified, only results with the specified `invited_email_address`\nwill be returned.", + "type": "string" + }, "states": { - "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.", - "type": "string", "repeated": true, "location": "query", "enum": [ "GUARDIAN_INVITATION_STATE_UNSPECIFIED", "PENDING", "COMPLETE" - ] + ], + "description": "If specified, only results with the specified `state` values will be\nreturned. Otherwise, results with a `state` of `PENDING` will be returned.", + "type": "string" }, "pageSize": { - "type": "integer", - "location": "query", "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", - "format": "int32" - }, - "studentId": { - "location": "path", - "description": "The ID of the student whose guardian invitations are to be returned.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user is permitted to view guardian\n invitations.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", - "type": "string" + "format": "int32", + "type": "integer", + "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" - ], - "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", - "path": "v1/userProfiles/{studentId}/guardianInvitations", - "id": "classroom.userProfiles.guardianInvitations.list" + ] }, "get": { - "httpMethod": "GET", + "response": { + "$ref": "GuardianInvitation" + }, "parameterOrder": [ "studentId", "invitationId" ], - "response": { - "$ref": "GuardianInvitation" - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.guardianlinks.students", - "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" - ], + "httpMethod": "GET", "parameters": { "invitationId": { - "required": true, - "type": "string", "location": "path", - "description": "The `id` field of the `GuardianInvitation` being requested." + "description": "The `id` field of the `GuardianInvitation` being requested.", + "required": true, + "type": "string" }, "studentId": { "location": "path", @@ -1746,18 +1530,20 @@ "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.guardianlinks.students", + "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" + ], "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", - "id": "classroom.userProfiles.guardianInvitations.get", "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", + "id": "classroom.userProfiles.guardianInvitations.get", "description": "Returns a specific guardian invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view\n guardian invitations for the student identified by the `student_id`, if\n guardians are not enabled for the domain in question, or for other\n access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if Classroom cannot find any record of the given student or\n `invitation_id`. May also be returned if the student exists, but the\n requesting user does not have access to see that student." }, "patch": { - "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", - "id": "classroom.userProfiles.guardianInvitations.patch", - "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.", "request": { "$ref": "GuardianInvitation" }, + "description": "Modifies a guardian invitation.\n\nCurrently, the only valid modification is to change the `state` from\n`PENDING` to `COMPLETE`. This has the effect of withdrawing the invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if guardians are not enabled for the domain in question\n or for other access errors.\n* `FAILED_PRECONDITION` if the guardian link is not in the `PENDING` state.\n* `INVALID_ARGUMENT` if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API), or if the passed `GuardianInvitation` has a `state` other than\n `COMPLETE`, or if it modifies fields other than `state`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student, or if the `id` field does not\n refer to a guardian invitation known to Classroom.", "response": { "$ref": "GuardianInvitation" }, @@ -1766,9 +1552,6 @@ "invitationId" ], "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/classroom.guardianlinks.students" - ], "parameters": { "invitationId": { "description": "The `id` field of the `GuardianInvitation` to be modified.", @@ -1789,40 +1572,46 @@ "type": "string" } }, - "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}" + "scopes": [ + "https://www.googleapis.com/auth/classroom.guardianlinks.students" + ], + "flatPath": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", + "path": "v1/userProfiles/{studentId}/guardianInvitations/{invitationId}", + "id": "classroom.userProfiles.guardianInvitations.patch" }, "create": { - "request": { - "$ref": "GuardianInvitation" - }, - "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user.", - "response": { - "$ref": "GuardianInvitation" - }, + "httpMethod": "POST", "parameterOrder": [ "studentId" ], - "httpMethod": "POST", + "response": { + "$ref": "GuardianInvitation" + }, "parameters": { "studentId": { + "location": "path", "description": "ID of the student (in standard format)", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/classroom.guardianlinks.students" ], "flatPath": "v1/userProfiles/{studentId}/guardianInvitations", + "id": "classroom.userProfiles.guardianInvitations.create", "path": "v1/userProfiles/{studentId}/guardianInvitations", - "id": "classroom.userProfiles.guardianInvitations.create" + "request": { + "$ref": "GuardianInvitation" + }, + "description": "Creates a guardian invitation, and sends an email to the guardian asking\nthem to confirm that they are the student's guardian.\n\nOnce the guardian accepts the invitation, their `state` will change to\n`COMPLETED` and they will start receiving guardian notifications. A\n`Guardian` resource will also be created to represent the active guardian.\n\nThe request object must have the `student_id` and\n`invited_email_address` fields set. Failing to set these fields, or\nsetting any other fields in the request, will result in an error.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the current user does not have permission to\n manage guardians, if the guardian in question has already rejected\n too many requests for that student, if guardians are not enabled for the\n domain in question, or for other access errors.\n* `RESOURCE_EXHAUSTED` if the student or guardian has exceeded the guardian\n link limit.\n* `INVALID_ARGUMENT` if the guardian email address is not valid (for\n example, if it is too long), or if the format of the student ID provided\n cannot be recognized (it is not an email address, nor a `user_id` from\n this API). This error will also be returned if read-only fields are set,\n or if the `state` field is set to to a value other than `PENDING`.\n* `NOT_FOUND` if the student ID provided is a valid student ID, but\n Classroom has no record of that student.\n* `ALREADY_EXISTS` if there is already a pending guardian invitation for\n the student and `invited_email_address` provided, or if the provided\n `invited_email_address` matches the Google account of an existing\n `Guardian` for this user." } } }, "guardians": { "methods": { "delete": { + "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`.", "response": { "$ref": "Empty" }, @@ -1831,9 +1620,6 @@ "guardianId" ], "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/classroom.guardianlinks.students" - ], "parameters": { "studentId": { "location": "path", @@ -1848,12 +1634,17 @@ "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.guardianlinks.students" + ], "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}", "path": "v1/userProfiles/{studentId}/guardians/{guardianId}", - "id": "classroom.userProfiles.guardians.delete", - "description": "Deletes a guardian.\n\nThe guardian will no longer receive guardian notifications and the guardian\nwill no longer be accessible via the API.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to manage guardians for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API).\n* `NOT_FOUND` if the requesting user is permitted to modify guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student with the provided `guardian_id`." + "id": "classroom.userProfiles.guardians.delete" }, "list": { + "path": "v1/userProfiles/{studentId}/guardians", + "id": "classroom.userProfiles.guardians.list", + "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student.", "response": { "$ref": "ListGuardiansResponse" }, @@ -1863,10 +1654,10 @@ "httpMethod": "GET", "parameters": { "studentId": { + "location": "path", "description": "Filter results by the student who the guardian is linked to.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n* the string literal `\"-\"`, indicating that results should be returned for\n all students that the requesting user has access to view.", "required": true, - "type": "string", - "location": "path" + "type": "string" }, "pageToken": { "description": "nextPageToken\nvalue returned from a previous\nlist call,\nindicating that the subsequent page of results should be returned.\n\nThe list request\nmust be otherwise identical to the one that resulted in this token.", @@ -1874,9 +1665,9 @@ "location": "query" }, "invitedEmailAddress": { - "location": "query", "description": "Filter results by the email address that the original invitation was sent\nto, resulting in this guardian link.\nThis filter can only be used by domain administrators.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "description": "Maximum number of items to return. Zero or unspecified indicates that the\nserver may assign a maximum.\n\nThe server may return fewer than the specified number of results.", @@ -1890,30 +1681,32 @@ "https://www.googleapis.com/auth/classroom.guardianlinks.students", "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" ], - "flatPath": "v1/userProfiles/{studentId}/guardians", - "path": "v1/userProfiles/{studentId}/guardians", - "id": "classroom.userProfiles.guardians.list", - "description": "Returns a list of guardians that the requesting user is permitted to\nview, restricted to those that match the request.\n\nTo list guardians for any student that the requesting user may view\nguardians for, use the literal character `-` for the student ID.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if a `student_id` is specified, and the requesting\n user is not permitted to view guardian information for that student, if\n `\"-\"` is specified as the `student_id` and the user is not a domain\n administrator, if guardians are not enabled for the domain in question,\n if the `invited_email_address` filter is set by a user who is not a\n domain administrator, or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`). May also be returned if an invalid\n `page_token` is provided.\n* `NOT_FOUND` if a `student_id` is specified, and its format can be\n recognized, but Classroom has no record of that student." + "flatPath": "v1/userProfiles/{studentId}/guardians" }, "get": { "flatPath": "v1/userProfiles/{studentId}/guardians/{guardianId}", - "id": "classroom.userProfiles.guardians.get", "path": "v1/userProfiles/{studentId}/guardians/{guardianId}", + "id": "classroom.userProfiles.guardians.get", "description": "Returns a specific guardian.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if no user that matches the provided `student_id`\n is visible to the requesting user, if the requesting user is not\n permitted to view guardian information for the student identified by the\n `student_id`, if guardians are not enabled for the domain in question,\n or for other access errors.\n* `INVALID_ARGUMENT` if a `student_id` is specified, but its format cannot\n be recognized (it is not an email address, nor a `student_id` from the\n API, nor the literal string `me`).\n* `NOT_FOUND` if the requesting user is permitted to view guardians for\n the requested `student_id`, but no `Guardian` record exists for that\n student that matches the provided `guardian_id`.", - "httpMethod": "GET", + "response": { + "$ref": "Guardian" + }, "parameterOrder": [ "studentId", "guardianId" ], - "response": { - "$ref": "Guardian" - }, + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly", + "https://www.googleapis.com/auth/classroom.guardianlinks.students", + "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" + ], "parameters": { "studentId": { - "required": true, - "type": "string", "location": "path", - "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user" + "description": "The student whose guardian is being requested. One of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "required": true, + "type": "string" }, "guardianId": { "description": "The `id` field from a `Guardian`.", @@ -1921,12 +1714,7 @@ "type": "string", "location": "path" } - }, - "scopes": [ - "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly", - "https://www.googleapis.com/auth/classroom.guardianlinks.students", - "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly" - ] + } } } } @@ -1934,37 +1722,7 @@ }, "registrations": { "methods": { - "delete": { - "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "registrationId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/classroom.push-notifications", - "https://www.googleapis.com/auth/classroom.rosters", - "https://www.googleapis.com/auth/classroom.rosters.readonly" - ], - "parameters": { - "registrationId": { - "description": "The `registration_id` of the `Registration` to be deleted.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/registrations/{registrationId}", - "path": "v1/registrations/{registrationId}", - "id": "classroom.registrations.delete" - }, "create": { - "request": { - "$ref": "Registration" - }, - "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it.", "httpMethod": "POST", "parameterOrder": [], "response": { @@ -1978,33 +1736,185 @@ ], "flatPath": "v1/registrations", "id": "classroom.registrations.create", - "path": "v1/registrations" + "path": "v1/registrations", + "request": { + "$ref": "Registration" + }, + "description": "Creates a `Registration`, causing Classroom to start sending notifications\nfrom the provided `feed` to the provided `destination`.\n\nReturns the created `Registration`. Currently, this will be the same as\nthe argument, but with server-assigned fields such as `expiry_time` and\n`id` filled in.\n\nNote that any value specified for the `expiry_time` or `id` fields will be\nignored.\n\nWhile Classroom may validate the `destination` and return errors on a best\neffort basis, it is the caller's responsibility to ensure that it exists\nand that Classroom has permission to publish to it.\n\nThis method may return the following error codes:\n\n* `PERMISSION_DENIED` if:\n * the authenticated user does not have permission to receive\n notifications from the requested field; or\n * the credential provided does not include the appropriate scope for the\n requested feed.\n * another access error is encountered.\n* `INVALID_ARGUMENT` if:\n * no `destination` is specified, or the specified `destination` is not\n valid; or\n * no `feed` is specified, or the specified `feed` is not valid.\n* `NOT_FOUND` if:\n * the specified `feed` cannot be located, or the requesting user does not\n have permission to determine whether or not it exists; or\n * the specified `destination` cannot be located, or Classroom has not\n been granted permission to publish to it." + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "registrationId" + ], + "httpMethod": "DELETE", + "parameters": { + "registrationId": { + "location": "path", + "description": "The `registration_id` of the `Registration` to be deleted.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.push-notifications", + "https://www.googleapis.com/auth/classroom.rosters", + "https://www.googleapis.com/auth/classroom.rosters.readonly" + ], + "flatPath": "v1/registrations/{registrationId}", + "path": "v1/registrations/{registrationId}", + "id": "classroom.registrations.delete", + "description": "Deletes a `Registration`, causing Classroom to stop sending notifications\nfor that `Registration`." + } + } + }, + "invitations": { + "methods": { + "delete": { + "description": "Deletes an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to delete the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "id" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters" + ], + "parameters": { + "id": { + "location": "path", + "description": "Identifier of the invitation to delete.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/invitations/{id}", + "path": "v1/invitations/{id}", + "id": "classroom.invitations.delete" + }, + "get": { + "description": "Returns an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to view the\nrequested invitation or for access errors.\n* `NOT_FOUND` if no invitation exists with the requested ID.", + "response": { + "$ref": "Invitation" + }, + "parameterOrder": [ + "id" + ], + "httpMethod": "GET", + "parameters": { + "id": { + "location": "path", + "description": "Identifier of the invitation to return.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters", + "https://www.googleapis.com/auth/classroom.rosters.readonly" + ], + "flatPath": "v1/invitations/{id}", + "path": "v1/invitations/{id}", + "id": "classroom.invitations.get" + }, + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListInvitationsResponse" + }, + "parameterOrder": [], + "parameters": { + "userId": { + "location": "query", + "description": "Restricts returned invitations to those for a specific user. The identifier\ncan be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "nextPageToken\nvalue returned from a previous\nlist call, indicating\nthat the subsequent page of results should be returned.\n\nThe list request must be\notherwise identical to the one that resulted in this token.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Maximum number of items to return. Zero means no maximum.\n\nThe server may return fewer than the specified number of results.", + "format": "int32", + "type": "integer" + }, + "courseId": { + "location": "query", + "description": "Restricts returned invitations to those for a course with the specified\nidentifier.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters", + "https://www.googleapis.com/auth/classroom.rosters.readonly" + ], + "flatPath": "v1/invitations", + "id": "classroom.invitations.list", + "path": "v1/invitations", + "description": "Returns a list of invitations that the requesting user is permitted to\nview, restricted to those that match the list request.\n\n*Note:* At least one of `user_id` or `course_id` must be supplied. Both\nfields can be supplied.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` for access errors." + }, + "create": { + "request": { + "$ref": "Invitation" + }, + "description": "Creates an invitation. Only one invitation for a user and course may exist\nat a time. Delete and re-create an invitation to make changes.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to create\ninvitations for this course or for access errors.\n* `NOT_FOUND` if the course or the user does not exist.\n* `FAILED_PRECONDITION` if the requested user's account is disabled or if\nthe user already has this role or a role with greater permissions.\n* `ALREADY_EXISTS` if an invitation for the specified user and course\nalready exists.", + "response": { + "$ref": "Invitation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters" + ], + "flatPath": "v1/invitations", + "path": "v1/invitations", + "id": "classroom.invitations.create" + }, + "accept": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "id" + ], + "httpMethod": "POST", + "parameters": { + "id": { + "description": "Identifier of the invitation to accept.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/classroom.rosters" + ], + "flatPath": "v1/invitations/{id}:accept", + "path": "v1/invitations/{id}:accept", + "id": "classroom.invitations.accept", + "description": "Accepts an invitation, removing it and adding the invited user to the\nteachers or students (as appropriate) of the specified course. Only the\ninvited user may accept an invitation.\n\nThis method returns the following error codes:\n\n* `PERMISSION_DENIED` if the requesting user is not permitted to accept the\nrequested invitation or for access errors.\n* `FAILED_PRECONDITION` for the following request errors:\n * CourseMemberLimitReached\n * CourseNotModifiable\n * CourseTeacherLimitReached\n * UserGroupsMembershipLimitReached\n* `NOT_FOUND` if no invitation exists with the requested ID." } } } }, "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, "callback": { "location": "query", "description": "JSONP", @@ -2024,7 +1934,6 @@ "type": "string" }, "alt": { - "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -2037,7 +1946,8 @@ "json", "media", "proto" - ] + ], + "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.", @@ -2050,15 +1960,15 @@ "location": "query" }, "quotaUser": { - "type": "string", "location": "query", - "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." + "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.", + "type": "string" }, "pp": { - "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" }, "bearer_token": { "location": "query", @@ -2066,12 +1976,461 @@ "type": "string" }, "oauth_token": { - "location": "query", "description": "OAuth 2.0 token for the current user.", - "type": "string" + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" } }, "schemas": { + "Attachment": { + "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.", + "type": "object", + "properties": { + "form": { + "description": "Google Forms attachment.", + "$ref": "Form" + }, + "link": { + "description": "Link attachment.", + "$ref": "Link" + }, + "driveFile": { + "description": "Google Drive file attachment.", + "$ref": "DriveFile" + }, + "youTubeVideo": { + "description": "Youtube video attachment.", + "$ref": "YouTubeVideo" + } + }, + "id": "Attachment" + }, + "ListTopicResponse": { + "description": "Response when listing topics.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + }, + "topic": { + "description": "Topic items that match the request.", + "type": "array", + "items": { + "$ref": "Topic" + } + } + }, + "id": "ListTopicResponse" + }, + "ListAnnouncementsResponse": { + "properties": { + "announcements": { + "description": "Announcement items that match the request.", + "type": "array", + "items": { + "$ref": "Announcement" + } + }, + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + } + }, + "id": "ListAnnouncementsResponse", + "description": "Response when listing course work.", + "type": "object" + }, + "TimeOfDay": { + "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`.", + "type": "object", + "properties": { + "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\nallow the value 60 if it allows leap-seconds.", + "format": "int32", + "type": "integer" + }, + "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", + "type": "integer" + } + }, + "id": "TimeOfDay" + }, + "ListCoursesResponse": { + "description": "Response when listing courses.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + }, + "courses": { + "description": "Courses that match the list request.", + "type": "array", + "items": { + "$ref": "Course" + } + } + }, + "id": "ListCoursesResponse" + }, + "Form": { + "description": "Google Forms item.", + "type": "object", + "properties": { + "thumbnailUrl": { + "description": "URL of a thumbnail image of the Form.\n\nRead-only.", + "type": "string" + }, + "responseUrl": { + "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.", + "type": "string" + }, + "formUrl": { + "description": "URL of the form.", + "type": "string" + }, + "title": { + "description": "Title of the Form.\n\nRead-only.", + "type": "string" + } + }, + "id": "Form" + }, + "ModifyCourseWorkAssigneesRequest": { + "description": "Request to modify assignee mode and options of a coursework.", + "type": "object", + "properties": { + "assigneeMode": { + "enumDescriptions": [ + "No mode specified. This is never returned.", + "All students can see the item.\nThis is the default state.", + "A subset of the students can see the item." + ], + "enum": [ + "ASSIGNEE_MODE_UNSPECIFIED", + "ALL_STUDENTS", + "INDIVIDUAL_STUDENTS" + ], + "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.", + "type": "string" + }, + "modifyIndividualStudentsOptions": { + "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.", + "$ref": "ModifyIndividualStudentsOptions" + } + }, + "id": "ModifyCourseWorkAssigneesRequest" + }, + "ListGuardiansResponse": { + "description": "Response when listing guardians.", + "type": "object", + "properties": { + "guardians": { + "description": "Guardians on this page of results that met the criteria specified in\nthe request.", + "type": "array", + "items": { + "$ref": "Guardian" + } + }, + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + } + }, + "id": "ListGuardiansResponse" + }, + "CourseAlias": { + "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.", + "type": "object", + "properties": { + "alias": { + "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.", + "type": "string" + } + }, + "id": "CourseAlias" + }, + "ListGuardianInvitationsResponse": { + "description": "Response when listing guardian invitations.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + }, + "guardianInvitations": { + "description": "Guardian invitations that matched the list request.", + "type": "array", + "items": { + "$ref": "GuardianInvitation" + } + } + }, + "id": "ListGuardianInvitationsResponse" + }, + "ListCourseAliasesResponse": { + "description": "Response when listing course aliases.", + "type": "object", + "properties": { + "aliases": { + "description": "The course aliases.", + "type": "array", + "items": { + "$ref": "CourseAlias" + } + }, + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + } + }, + "id": "ListCourseAliasesResponse" + }, + "IndividualStudentsOptions": { + "properties": { + "studentIds": { + "description": "Identifiers for the students that have access to the\ncoursework/announcement.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "IndividualStudentsOptions", + "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", + "type": "object" + }, + "MultipleChoiceSubmission": { + "description": "Student work for a multiple-choice question.", + "type": "object", + "properties": { + "answer": { + "description": "Student's select choice.", + "type": "string" + } + }, + "id": "MultipleChoiceSubmission" + }, + "Registration": { + "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.", + "type": "object", + "properties": { + "registrationId": { + "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.", + "type": "string" + }, + "cloudPubsubTopic": { + "$ref": "CloudPubsubTopic", + "description": "The Cloud Pub/Sub topic that notifications are to be sent to." + }, + "expiryTime": { + "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.", + "format": "google-datetime", + "type": "string" + }, + "feed": { + "$ref": "Feed", + "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`." + } + }, + "id": "Registration" + }, + "CourseMaterial": { + "description": "A material attached to a course as part of a material set.", + "type": "object", + "properties": { + "driveFile": { + "$ref": "DriveFile", + "description": "Google Drive file attachment." + }, + "youTubeVideo": { + "$ref": "YouTubeVideo", + "description": "Youtube video attachment." + }, + "form": { + "$ref": "Form", + "description": "Google Forms attachment." + }, + "link": { + "description": "Link atatchment.", + "$ref": "Link" + } + }, + "id": "CourseMaterial" + }, + "MultipleChoiceQuestion": { + "description": "Additional details for multiple-choice questions.", + "type": "object", + "properties": { + "choices": { + "description": "Possible choices.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "MultipleChoiceQuestion" + }, + "Course": { + "description": "A Course in Classroom.", + "type": "object", + "properties": { + "descriptionHeading": { + "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.", + "type": "string" + }, + "updateTime": { + "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", + "format": "google-datetime", + "type": "string" + }, + "calendarId": { + "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.", + "type": "string" + }, + "alternateLink": { + "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.", + "type": "string" + }, + "guardiansEnabled": { + "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.", + "type": "boolean" + }, + "ownerId": { + "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.", + "type": "string" + }, + "courseState": { + "enum": [ + "COURSE_STATE_UNSPECIFIED", + "ACTIVE", + "ARCHIVED", + "PROVISIONED", + "DECLINED", + "SUSPENDED" + ], + "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.", + "type": "string", + "enumDescriptions": [ + "No course state. No returned Course message will use this value.", + "The course is active.", + "The course has been archived. You cannot modify it except to change it\nto a different state.", + "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.", + "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.", + "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service." + ] + }, + "description": { + "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.", + "type": "string" + }, + "teacherGroupEmail": { + "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.", + "type": "string" + }, + "creationTime": { + "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.", + "type": "string" + }, + "teacherFolder": { + "$ref": "DriveFolder", + "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only." + }, + "section": { + "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters.", + "type": "string" + }, + "id": { + "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.", + "type": "string" + }, + "room": { + "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.", + "type": "string" + }, + "courseGroupEmail": { + "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.", + "type": "string" + }, + "enrollmentCode": { + "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", + "type": "string" + }, + "courseMaterialSets": { + "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.", + "type": "array", + "items": { + "$ref": "CourseMaterialSet" + } + } + }, + "id": "Course" + }, + "DriveFile": { + "description": "Representation of a Google Drive file.", + "type": "object", + "properties": { + "alternateLink": { + "description": "URL that can be used to access the Drive item.\n\nRead-only.", + "type": "string" + }, + "thumbnailUrl": { + "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.", + "type": "string" + }, + "id": { + "description": "Drive API resource ID.", + "type": "string" + }, + "title": { + "description": "Title of the Drive item.\n\nRead-only.", + "type": "string" + } + }, + "id": "DriveFile" + }, + "ReturnStudentSubmissionRequest": { + "description": "Request to return a student submission.", + "type": "object", + "properties": {}, + "id": "ReturnStudentSubmissionRequest" + }, + "ReclaimStudentSubmissionRequest": { + "properties": {}, + "id": "ReclaimStudentSubmissionRequest", + "description": "Request to reclaim a student submission.", + "type": "object" + }, "CourseRosterChangesInfo": { "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.", "type": "object", @@ -2084,14 +2443,9 @@ "id": "CourseRosterChangesInfo" }, "Topic": { - "id": "Topic", "description": "Topic created by a teacher for the course", "type": "object", "properties": { - "courseId": { - "type": "string", - "description": "Identifier of the course.\n\nRead-only." - }, "updateTime": { "description": "The time the topic was last updated by the system.\n\nRead-only.", "format": "google-datetime", @@ -2102,20 +2456,54 @@ "type": "string" }, "topicId": { - "type": "string", - "description": "Unique identifier for the topic.\n\nRead-only." + "description": "Unique identifier for the topic.\n\nRead-only.", + "type": "string" + }, + "courseId": { + "description": "Identifier of the course.\n\nRead-only.", + "type": "string" } - } + }, + "id": "Topic" }, "CourseWork": { - "description": "Course work created by a teacher for students of the course.", - "type": "object", "properties": { + "courseId": { + "description": "Identifier of the course.\n\nRead-only.", + "type": "string" + }, + "id": { + "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.", + "type": "string" + }, + "dueTime": { + "$ref": "TimeOfDay", + "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified." + }, + "title": { + "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.", + "type": "string" + }, + "materials": { + "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.", + "type": "array", + "items": { + "$ref": "Material" + } + }, + "associatedWithDeveloper": { + "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", + "type": "boolean" + }, "updateTime": { "description": "Timestamp of the most recent change to this course work.\n\nRead-only.", "format": "google-datetime", "type": "string" }, + "alternateLink": { + "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.", + "type": "string" + }, "assigneeMode": { "enum": [ "ASSIGNEE_MODE_UNSPECIFIED", @@ -2130,24 +2518,14 @@ "A subset of the students can see the item." ] }, - "alternateLink": { - "description": "Absolute link to this course work in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.", - "type": "string" - }, "maxPoints": { - "type": "number", "description": "Maximum grade for this course work.\nIf zero or unspecified, this assignment is considered ungraded.\nThis must be a non-negative integer value.", - "format": "double" - }, - "multipleChoiceQuestion": { - "$ref": "MultipleChoiceQuestion", - "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise." - }, - "assignment": { - "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.", - "$ref": "Assignment" + "format": "double", + "type": "number" }, "workType": { + "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.", + "type": "string", "enumDescriptions": [ "No work type specified. This is never returned.", "An assignment.", @@ -2159,13 +2537,19 @@ "ASSIGNMENT", "SHORT_ANSWER_QUESTION", "MULTIPLE_CHOICE_QUESTION" - ], - "description": "Type of this course work.\n\nThe type is set when the course work is created and cannot be changed.", - "type": "string" + ] + }, + "assignment": { + "description": "Assignment details.\nThis is populated only when `work_type` is `ASSIGNMENT`.\n\nRead-only.", + "$ref": "Assignment" + }, + "multipleChoiceQuestion": { + "description": "Multiple choice question details.\nFor read operations, this field is populated only when `work_type` is\n`MULTIPLE_CHOICE_QUESTION`.\nFor write operations, this field must be specified when creating course\nwork with a `work_type` of `MULTIPLE_CHOICE_QUESTION`, and it must not be\nset otherwise.", + "$ref": "MultipleChoiceQuestion" }, "description": { - "type": "string", - "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters." + "description": "Optional description of this course work.\nIf set, the description must be a valid UTF-8 string containing no more\nthan 30,000 characters.", + "type": "string" }, "scheduledTime": { "description": "Optional timestamp when this course work is scheduled to be published.", @@ -2177,21 +2561,34 @@ "format": "google-datetime", "type": "string" }, - "dueDate": { - "$ref": "Date", - "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified." - }, "individualStudentsOptions": { - "$ref": "IndividualStudentsOptions", - "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework." + "description": "Identifiers of students with access to the coursework.\nThis field is set only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.\nIf the `assigneeMode` is `INDIVIDUAL_STUDENTS`, then only students\nspecified in this field will be assigned the coursework.", + "$ref": "IndividualStudentsOptions" }, "creatorUserId": { "description": "Identifier for the user that created the coursework.\n\nRead-only.", "type": "string" }, - "state": { + "dueDate": { + "$ref": "Date", + "description": "Optional date, in UTC, that submissions for this this course work are due.\nThis must be specified if `due_time` is specified." + }, + "submissionModificationMode": { + "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.", "type": "string", "enumDescriptions": [ + "No modification mode specified. This is never returned.", + "Submisisons can be modified before being turned in.", + "Submisisons can be modified at any time." + ], + "enum": [ + "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", + "MODIFIABLE_UNTIL_TURNED_IN", + "MODIFIABLE" + ] + }, + "state": { + "enumDescriptions": [ "No state specified. This is never returned.", "Status for work that has been published.\nThis is the default state.", "Status for work that is not yet published.\nWork in this state is visible only to course teachers and domain\nadministrators.", @@ -2203,53 +2600,17 @@ "DRAFT", "DELETED" ], - "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`." - }, - "submissionModificationMode": { - "enumDescriptions": [ - "No modification mode specified. This is never returned.", - "Submisisons can be modified before being turned in.", - "Submisisons can be modified at any time." - ], - "enum": [ - "SUBMISSION_MODIFICATION_MODE_UNSPECIFIED", - "MODIFIABLE_UNTIL_TURNED_IN", - "MODIFIABLE" - ], - "description": "Setting to determine when students are allowed to modify submissions.\nIf unspecified, the default value is `MODIFIABLE_UNTIL_TURNED_IN`.", + "description": "Status of this course work.\nIf unspecified, the default state is `DRAFT`.", "type": "string" - }, - "courseId": { - "description": "Identifier of the course.\n\nRead-only.", - "type": "string" - }, - "id": { - "description": "Classroom-assigned identifier of this course work, unique per course.\n\nRead-only.", - "type": "string" - }, - "dueTime": { - "description": "Optional time of day, in UTC, that submissions for this this course work\nare due.\nThis must be specified if `due_date` is specified.", - "$ref": "TimeOfDay" - }, - "title": { - "description": "Title of this course work.\nThe title must be a valid UTF-8 string containing between 1 and 3000\ncharacters.", - "type": "string" - }, - "materials": { - "description": "Additional materials.\n\nCourseWork must have no more than 20 material items.", - "type": "array", - "items": { - "$ref": "Material" - } - }, - "associatedWithDeveloper": { - "description": "Whether this course work item is associated with the Developer Console\nproject making the request.\n\nSee google.classroom.Work.CreateCourseWork for more\ndetails.\n\nRead-only.", - "type": "boolean" } }, - "id": "CourseWork" + "id": "CourseWork", + "description": "Course work created by a teacher for students of the course.", + "type": "object" }, "Guardian": { + "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.", + "type": "object", "properties": { "studentId": { "description": "Identifier for the student to whom the guardian relationship applies.", @@ -2264,36 +2625,20 @@ "type": "string" }, "guardianProfile": { - "$ref": "UserProfile", - "description": "User profile for the guardian." + "description": "User profile for the guardian.", + "$ref": "UserProfile" } }, - "id": "Guardian", - "description": "Association between a student and a guardian of that student. The guardian\nmay receive information about the student's course work.", - "type": "object" - }, - "ListStudentsResponse": { - "description": "Response when listing students.", - "type": "object", - "properties": { - "students": { - "description": "Students who match the list request.", - "type": "array", - "items": { - "$ref": "Student" - } - }, - "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", - "type": "string" - } - }, - "id": "ListStudentsResponse" + "id": "Guardian" }, "UserProfile": { "description": "Global information for a user.", "type": "object", "properties": { + "verifiedTeacher": { + "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only", + "type": "boolean" + }, "emailAddress": { "description": "Email address of the user.\n\nRead-only.", "type": "string" @@ -2314,20 +2659,62 @@ "description": "Name of the user.\n\nRead-only." }, "id": { - "type": "string", - "description": "Identifier of the user.\n\nRead-only." - }, - "verifiedTeacher": { - "type": "boolean", - "description": "Represents whether a G Suite for Education user's domain administrator has\nexplicitly verified them as being a teacher. If the user is not a member of\na G Suite for Education domain, than this field will always be false.\n\nRead-only" + "description": "Identifier of the user.\n\nRead-only.", + "type": "string" } }, "id": "UserProfile" }, - "Announcement": { - "description": "Announcement created by a teacher for students of the course", + "ListStudentsResponse": { + "description": "Response when listing students.", "type": "object", "properties": { + "students": { + "description": "Students who match the list request.", + "type": "array", + "items": { + "$ref": "Student" + } + }, + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + } + }, + "id": "ListStudentsResponse" + }, + "Announcement": { + "properties": { + "materials": { + "description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.", + "type": "array", + "items": { + "$ref": "Material" + } + }, + "updateTime": { + "description": "Timestamp of the most recent change to this announcement.\n\nRead-only.", + "format": "google-datetime", + "type": "string" + }, + "assigneeMode": { + "enumDescriptions": [ + "No mode specified. This is never returned.", + "All students can see the item.\nThis is the default state.", + "A subset of the students can see the item." + ], + "enum": [ + "ASSIGNEE_MODE_UNSPECIFIED", + "ALL_STUDENTS", + "INDIVIDUAL_STUDENTS" + ], + "description": "Assignee mode of the announcement.\nIf unspecified, the default value is `ALL_STUDENTS`.", + "type": "string" + }, + "alternateLink": { + "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.", + "type": "string" + }, "scheduledTime": { "description": "Optional timestamp when this announcement is scheduled to be published.", "format": "google-datetime", @@ -2347,12 +2734,6 @@ "type": "string" }, "state": { - "enum": [ - "ANNOUNCEMENT_STATE_UNSPECIFIED", - "PUBLISHED", - "DRAFT", - "DELETED" - ], "description": "Status of this announcement.\nIf unspecified, the default state is `DRAFT`.", "type": "string", "enumDescriptions": [ @@ -2360,6 +2741,12 @@ "Status for announcement that has been published.\nThis is the default state.", "Status for an announcement that is not yet published.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.", "Status for announcement that was published but is now deleted.\nAnnouncement in this state is visible only to course teachers and domain\nadministrators.\nAnnouncement in this state is deleted after some time." + ], + "enum": [ + "ANNOUNCEMENT_STATE_UNSPECIFIED", + "PUBLISHED", + "DRAFT", + "DELETED" ] }, "text": { @@ -2373,39 +2760,11 @@ "id": { "description": "Classroom-assigned identifier of this announcement, unique per course.\n\nRead-only.", "type": "string" - }, - "materials": { - "description": "Additional materials.\n\nAnnouncements must have no more than 20 material items.", - "type": "array", - "items": { - "$ref": "Material" - } - }, - "updateTime": { - "description": "Timestamp of the most recent change to this announcement.\n\nRead-only.", - "format": "google-datetime", - "type": "string" - }, - "alternateLink": { - "description": "Absolute link to this announcement in the Classroom web UI.\nThis is only populated if `state` is `PUBLISHED`.\n\nRead-only.", - "type": "string" - }, - "assigneeMode": { - "enum": [ - "ASSIGNEE_MODE_UNSPECIFIED", - "ALL_STUDENTS", - "INDIVIDUAL_STUDENTS" - ], - "description": "Assignee mode of the announcement.\nIf unspecified, the default value is `ALL_STUDENTS`.", - "type": "string", - "enumDescriptions": [ - "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", - "A subset of the students can see the item." - ] } }, - "id": "Announcement" + "id": "Announcement", + "description": "Announcement created by a teacher for students of the course", + "type": "object" }, "ModifyIndividualStudentsOptions": { "description": "Contains fields to add or remove students from a course work or announcement\nwhere the `assigneeMode` is set to `INDIVIDUAL_STUDENTS`.", @@ -2432,6 +2791,10 @@ "description": "Representation of a Google Drive folder.", "type": "object", "properties": { + "alternateLink": { + "description": "URL that can be used to access the Drive folder.\n\nRead-only.", + "type": "string" + }, "id": { "description": "Drive API resource ID.", "type": "string" @@ -2439,10 +2802,6 @@ "title": { "description": "Title of the Drive folder.\n\nRead-only.", "type": "string" - }, - "alternateLink": { - "description": "URL that can be used to access the Drive folder.\n\nRead-only.", - "type": "string" } }, "id": "DriveFolder" @@ -2452,12 +2811,12 @@ "type": "object", "properties": { "stateHistory": { - "$ref": "StateHistory", - "description": "The state history information of the submission, if present." + "description": "The state history information of the submission, if present.", + "$ref": "StateHistory" }, "gradeHistory": { - "$ref": "GradeHistory", - "description": "The grade history information of the submission, if present." + "description": "The grade history information of the submission, if present.", + "$ref": "GradeHistory" } }, "id": "SubmissionHistory" @@ -2473,18 +2832,57 @@ }, "id": "ShortAnswerSubmission" }, - "StudentSubmission": { - "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.", + "ListStudentSubmissionsResponse": { + "description": "Response when listing student submissions.", "type": "object", "properties": { + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + }, + "studentSubmissions": { + "description": "Student work that matches the request.", + "type": "array", + "items": { + "$ref": "StudentSubmission" + } + } + }, + "id": "ListStudentSubmissionsResponse" + }, + "StudentSubmission": { + "properties": { + "late": { + "description": "Whether this submission is late.\n\nRead-only.", + "type": "boolean" + }, + "draftGrade": { + "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.", + "format": "double", + "type": "number" + }, + "courseWorkType": { + "description": "Type of course work this submission is for.\n\nRead-only.", + "type": "string", + "enumDescriptions": [ + "No work type specified. This is never returned.", + "An assignment.", + "A short answer question.", + "A multiple-choice question." + ], + "enum": [ + "COURSE_WORK_TYPE_UNSPECIFIED", + "ASSIGNMENT", + "SHORT_ANSWER_QUESTION", + "MULTIPLE_CHOICE_QUESTION" + ] + }, "creationTime": { "description": "Creation time of this submission.\nThis may be unset if the student has not accessed this item.\n\nRead-only.", "format": "google-datetime", "type": "string" }, "state": { - "description": "State of this submission.\n\nRead-only.", - "type": "string", "enumDescriptions": [ "No state specified. This should never be returned.", "The student has never accessed this submission. Attachments are not\nreturned and timestamps is not set.", @@ -2500,7 +2898,9 @@ "TURNED_IN", "RETURNED", "RECLAIMED_BY_STUDENT" - ] + ], + "description": "State of this submission.\n\nRead-only.", + "type": "string" }, "userId": { "description": "Identifier for the student that owns this submission.\n\nRead-only.", @@ -2552,54 +2952,13 @@ "type": "string" }, "alternateLink": { - "type": "string", - "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only." - }, - "late": { - "description": "Whether this submission is late.\n\nRead-only.", - "type": "boolean" - }, - "draftGrade": { - "description": "Optional pending grade. If unset, no grade was set.\nThis value must be non-negative. Decimal (i.e. non-integer) values are\nallowed, but will be rounded to two decimal places.\n\nThis is only visible to and modifiable by course teachers.", - "format": "double", - "type": "number" - }, - "courseWorkType": { - "description": "Type of course work this submission is for.\n\nRead-only.", - "type": "string", - "enumDescriptions": [ - "No work type specified. This is never returned.", - "An assignment.", - "A short answer question.", - "A multiple-choice question." - ], - "enum": [ - "COURSE_WORK_TYPE_UNSPECIFIED", - "ASSIGNMENT", - "SHORT_ANSWER_QUESTION", - "MULTIPLE_CHOICE_QUESTION" - ] + "description": "Absolute link to the submission in the Classroom web UI.\n\nRead-only.", + "type": "string" } }, - "id": "StudentSubmission" - }, - "ListStudentSubmissionsResponse": { - "description": "Response when listing student submissions.", - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available." - }, - "studentSubmissions": { - "description": "Student work that matches the request.", - "type": "array", - "items": { - "$ref": "StudentSubmission" - } - } - }, - "id": "ListStudentSubmissionsResponse" + "id": "StudentSubmission", + "description": "Student submission for course work.\n\nStudentSubmission items are generated when a CourseWork item is created.\n\nStudentSubmissions that have never been accessed (i.e. with `state` = NEW)\nmay not have a creation time or update time.", + "type": "object" }, "ModifyAttachmentsRequest": { "description": "Request to modify the attachments of a student submission.", @@ -2616,10 +2975,13 @@ "id": "ModifyAttachmentsRequest" }, "YouTubeVideo": { - "id": "YouTubeVideo", "description": "YouTube video item.", "type": "object", "properties": { + "title": { + "description": "Title of the YouTube video.\n\nRead-only.", + "type": "string" + }, "alternateLink": { "description": "URL that can be used to view the YouTube video.\n\nRead-only.", "type": "string" @@ -2631,12 +2993,9 @@ "id": { "description": "YouTube API resource ID.", "type": "string" - }, - "title": { - "description": "Title of the YouTube video.\n\nRead-only.", - "type": "string" } - } + }, + "id": "YouTubeVideo" }, "ListInvitationsResponse": { "description": "Response when listing invitations.", @@ -2671,23 +3030,27 @@ "description": "An invitation to become the guardian of a specified user, sent to a specified\nemail address.", "type": "object", "properties": { + "invitationId": { + "description": "Unique identifier for this invitation.\n\nRead-only.", + "type": "string" + }, "studentId": { "description": "ID of the student (in standard format)", "type": "string" }, "state": { + "enumDescriptions": [ + "Should never be returned.", + "The invitation is active and awaiting a response.", + "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired." + ], "enum": [ "GUARDIAN_INVITATION_STATE_UNSPECIFIED", "PENDING", "COMPLETE" ], "description": "The state that this invitation is in.", - "type": "string", - "enumDescriptions": [ - "Should never be returned.", - "The invitation is active and awaiting a response.", - "The invitation is no longer active. It may have been accepted, declined,\nwithdrawn or it may have expired." - ] + "type": "string" }, "invitedEmailAddress": { "description": "Email address that the invitation was sent to.\nThis field is only visible to domain administrators.", @@ -2697,10 +3060,6 @@ "description": "The time that this invitation was created.\n\nRead-only.", "format": "google-datetime", "type": "string" - }, - "invitationId": { - "type": "string", - "description": "Unique identifier for this invitation.\n\nRead-only." } }, "id": "GuardianInvitation" @@ -2709,7 +3068,24 @@ "description": "The history of each state this submission has been in.", "type": "object", "properties": { + "stateTimestamp": { + "description": "When the submission entered this state.", + "format": "google-datetime", + "type": "string" + }, + "actorUserId": { + "description": "The teacher or student who made the change", + "type": "string" + }, "state": { + "enum": [ + "STATE_UNSPECIFIED", + "CREATED", + "TURNED_IN", + "RETURNED", + "RECLAIMED_BY_STUDENT", + "STUDENT_EDITED_AFTER_TURN_IN" + ], "description": "The workflow pipeline stage.", "type": "string", "enumDescriptions": [ @@ -2719,24 +3095,7 @@ "The teacher has returned the assigned document to the student.", "The student turned in the assigned document, and then chose to\n\"unsubmit\" the assignment, giving the student control again as the\nowner.", "The student edited their submission after turning it in. Currently,\nonly used by Questions, when the student edits their answer." - ], - "enum": [ - "STATE_UNSPECIFIED", - "CREATED", - "TURNED_IN", - "RETURNED", - "RECLAIMED_BY_STUDENT", - "STUDENT_EDITED_AFTER_TURN_IN" ] - }, - "stateTimestamp": { - "type": "string", - "description": "When the submission entered this state.", - "format": "google-datetime" - }, - "actorUserId": { - "description": "The teacher or student who made the change", - "type": "string" } }, "id": "StateHistory" @@ -2760,32 +3119,27 @@ "id": "CourseMaterialSet" }, "ListTeachersResponse": { - "id": "ListTeachersResponse", "description": "Response when listing teachers.", "type": "object", "properties": { + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + }, "teachers": { "description": "Teachers who match the list request.", "type": "array", "items": { "$ref": "Teacher" } - }, - "nextPageToken": { - "type": "string", - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available." } - } + }, + "id": "ListTeachersResponse" }, "Link": { - "id": "Link", "description": "URL item.", "type": "object", "properties": { - "thumbnailUrl": { - "description": "URL of a thumbnail image of the target URL.\n\nRead-only.", - "type": "string" - }, "url": { "description": "URL to link to.\nThis must be a valid UTF-8 string containing between 1 and 2024 characters.", "type": "string" @@ -2793,13 +3147,15 @@ "title": { "description": "Title of the target of the URL.\n\nRead-only.", "type": "string" + }, + "thumbnailUrl": { + "description": "URL of a thumbnail image of the target URL.\n\nRead-only.", + "type": "string" } - } + }, + "id": "Link" }, "Date": { - "id": "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`.", - "type": "object", "properties": { "year": { "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", @@ -2816,16 +3172,15 @@ "format": "int32", "type": "integer" } - } + }, + "id": "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`.", + "type": "object" }, "Name": { "description": "Details of the user's name.", "type": "object", "properties": { - "fullName": { - "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.", - "type": "string" - }, "givenName": { "description": "The user's first name.\n\nRead-only.", "type": "string" @@ -2833,12 +3188,15 @@ "familyName": { "description": "The user's last name.\n\nRead-only.", "type": "string" + }, + "fullName": { + "description": "The user's full name formed by concatenating the first and last name\nvalues.\n\nRead-only.", + "type": "string" } }, "id": "Name" }, "Assignment": { - "type": "object", "properties": { "studentWorkFolder": { "$ref": "DriveFolder", @@ -2846,11 +3204,10 @@ } }, "id": "Assignment", - "description": "Additional details for assignments." + "description": "Additional details for assignments.", + "type": "object" }, "SharedDriveFile": { - "description": "Drive file that is used as material for course work.", - "type": "object", "properties": { "driveFile": { "description": "Drive file details.", @@ -2873,7 +3230,9 @@ "type": "string" } }, - "id": "SharedDriveFile" + "id": "SharedDriveFile", + "description": "Drive file that is used as material for course work.", + "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 `{}`.", @@ -2881,6 +3240,31 @@ "properties": {}, "id": "Empty" }, + "ModifyAnnouncementAssigneesRequest": { + "properties": { + "modifyIndividualStudentsOptions": { + "$ref": "ModifyIndividualStudentsOptions", + "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`." + }, + "assigneeMode": { + "enumDescriptions": [ + "No mode specified. This is never returned.", + "All students can see the item.\nThis is the default state.", + "A subset of the students can see the item." + ], + "enum": [ + "ASSIGNEE_MODE_UNSPECIFIED", + "ALL_STUDENTS", + "INDIVIDUAL_STUDENTS" + ], + "description": "Mode of the announcement describing whether it will be accessible by all\nstudents or specified individual students.", + "type": "string" + } + }, + "id": "ModifyAnnouncementAssigneesRequest", + "description": "Request to modify assignee mode and options of an announcement.", + "type": "object" + }, "GlobalPermission": { "description": "Global user permission description.", "type": "object", @@ -2900,33 +3284,14 @@ }, "id": "GlobalPermission" }, - "ModifyAnnouncementAssigneesRequest": { - "description": "Request to modify assignee mode and options of an announcement.", + "Teacher": { + "description": "Teacher of a course.", "type": "object", "properties": { - "modifyIndividualStudentsOptions": { - "$ref": "ModifyIndividualStudentsOptions", - "description": "Set which students can view or cannot view the announcement.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`." + "courseId": { + "description": "Identifier of the course.\n\nRead-only.", + "type": "string" }, - "assigneeMode": { - "type": "string", - "enumDescriptions": [ - "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", - "A subset of the students can see the item." - ], - "enum": [ - "ASSIGNEE_MODE_UNSPECIFIED", - "ALL_STUDENTS", - "INDIVIDUAL_STUDENTS" - ], - "description": "Mode of the announcement describing whether it will be accessible by all\nstudents or specified individual students." - } - }, - "id": "ModifyAnnouncementAssigneesRequest" - }, - "Teacher": { - "properties": { "profile": { "$ref": "UserProfile", "description": "Global user information for the teacher.\n\nRead-only." @@ -2934,15 +3299,9 @@ "userId": { "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", "type": "string" - }, - "courseId": { - "type": "string", - "description": "Identifier of the course.\n\nRead-only." } }, - "id": "Teacher", - "description": "Teacher of a course.", - "type": "object" + "id": "Teacher" }, "GradeHistory": { "description": "The history of each grade on this submission.", @@ -2958,12 +3317,6 @@ "type": "string" }, "gradeChangeType": { - "enumDescriptions": [ - "No grade change type specified. This should never be returned.", - "A change in the numerator of the draft grade.", - "A change in the numerator of the assigned grade.", - "A change in the denominator of the grade." - ], "enum": [ "UNKNOWN_GRADE_CHANGE_TYPE", "DRAFT_GRADE_POINTS_EARNED_CHANGE", @@ -2971,7 +3324,13 @@ "MAX_POINTS_CHANGE" ], "description": "The type of grade change at this time in the submission grade history.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "No grade change type specified. This should never be returned.", + "A change in the numerator of the draft grade.", + "A change in the numerator of the assigned grade.", + "A change in the denominator of the grade." + ] }, "maxPoints": { "description": "The denominator of the grade at this time in the submission grade\nhistory.", @@ -3005,16 +3364,16 @@ "type": "object", "properties": { "youtubeVideo": { - "description": "YouTube video material.", - "$ref": "YouTubeVideo" + "$ref": "YouTubeVideo", + "description": "YouTube video material." }, "driveFile": { "description": "Google Drive file material.", "$ref": "SharedDriveFile" }, "form": { - "description": "Google Forms material.", - "$ref": "Form" + "$ref": "Form", + "description": "Google Forms material." }, "link": { "$ref": "Link", @@ -3024,29 +3383,29 @@ "id": "Material" }, "Feed": { + "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".", + "type": "object", "properties": { + "courseRosterChangesInfo": { + "$ref": "CourseRosterChangesInfo", + "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`." + }, "feedType": { - "enum": [ - "FEED_TYPE_UNSPECIFIED", - "DOMAIN_ROSTER_CHANGES", - "COURSE_ROSTER_CHANGES" - ], "description": "The type of feed.", "type": "string", "enumDescriptions": [ "Should never be returned or provided.", "All roster changes for a particular domain.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation.", "All roster changes for a particular course.\n\nNotifications will be generated whenever a user joins or leaves a course.\n\nNo notifications will be generated when an invitation is created or\ndeleted, but notifications will be generated when a user joins a course\nby accepting an invitation." + ], + "enum": [ + "FEED_TYPE_UNSPECIFIED", + "DOMAIN_ROSTER_CHANGES", + "COURSE_ROSTER_CHANGES" ] - }, - "courseRosterChangesInfo": { - "$ref": "CourseRosterChangesInfo", - "description": "Information about a `Feed` with a `feed_type` of `COURSE_ROSTER_CHANGES`.\nThis field must be specified if `feed_type` is `COURSE_ROSTER_CHANGES`." } }, - "id": "Feed", - "description": "A class of notifications that an application can register to receive.\nFor example: \"all roster changes for a domain\".", - "type": "object" + "id": "Feed" }, "Student": { "description": "Student in a course.", @@ -3057,12 +3416,12 @@ "type": "string" }, "profile": { - "$ref": "UserProfile", - "description": "Global user information for the student.\n\nRead-only." + "description": "Global user information for the student.\n\nRead-only.", + "$ref": "UserProfile" }, "studentWorkFolder": { - "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only.", - "$ref": "DriveFolder" + "$ref": "DriveFolder", + "description": "Information about a Drive Folder for this student's work in this course.\nOnly visible to the student and domain administrators.\n\nRead-only." }, "userId": { "description": "Identifier of the user.\n\nWhen specified as a parameter of a request, this identifier can be one of\nthe following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", @@ -3076,6 +3435,12 @@ "type": "object", "properties": { "role": { + "enumDescriptions": [ + "No course role.", + "Student in the course.", + "Teacher of the course.", + "Owner of the course." + ], "enum": [ "COURSE_ROLE_UNSPECIFIED", "STUDENT", @@ -3083,490 +3448,125 @@ "OWNER" ], "description": "Role to invite the user to have.\nMust not be `COURSE_ROLE_UNSPECIFIED`.", - "type": "string", - "enumDescriptions": [ - "No course role.", - "Student in the course.", - "Teacher of the course.", - "Owner of the course." - ] + "type": "string" }, "userId": { "description": "Identifier of the invited user.\n\nWhen specified as a parameter of a request, this identifier can be set to\none of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user", "type": "string" }, "courseId": { - "type": "string", - "description": "Identifier of the course to invite the user to." + "description": "Identifier of the course to invite the user to.", + "type": "string" }, "id": { - "type": "string", - "description": "Identifier assigned by Classroom.\n\nRead-only." + "description": "Identifier assigned by Classroom.\n\nRead-only.", + "type": "string" } }, "id": "Invitation" }, "TurnInStudentSubmissionRequest": { - "properties": {}, - "id": "TurnInStudentSubmissionRequest", "description": "Request to turn in a student submission.", - "type": "object" + "type": "object", + "properties": {}, + "id": "TurnInStudentSubmissionRequest" }, "ListCourseWorkResponse": { - "description": "Response when listing course work.", - "type": "object", "properties": { + "nextPageToken": { + "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", + "type": "string" + }, "courseWork": { "description": "Course work items that match the request.", "type": "array", "items": { "$ref": "CourseWork" } - }, - "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", - "type": "string" } }, - "id": "ListCourseWorkResponse" - }, - "Attachment": { - "description": "Attachment added to student assignment work.\n\nWhen creating attachments, setting the `form` field is not supported.", - "type": "object", - "properties": { - "driveFile": { - "$ref": "DriveFile", - "description": "Google Drive file attachment." - }, - "youTubeVideo": { - "description": "Youtube video attachment.", - "$ref": "YouTubeVideo" - }, - "form": { - "description": "Google Forms attachment.", - "$ref": "Form" - }, - "link": { - "description": "Link attachment.", - "$ref": "Link" - } - }, - "id": "Attachment" - }, - "ListTopicResponse": { - "description": "Response when listing topics.", - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available." - }, - "topic": { - "description": "Topic items that match the request.", - "type": "array", - "items": { - "$ref": "Topic" - } - } - }, - "id": "ListTopicResponse" - }, - "ListAnnouncementsResponse": { + "id": "ListCourseWorkResponse", "description": "Response when listing course work.", - "type": "object", - "properties": { - "announcements": { - "description": "Announcement items that match the request.", - "type": "array", - "items": { - "$ref": "Announcement" - } + "type": "object" + } + }, + "protocol": "rest", + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" + }, + "version": "v1", + "baseUrl": "https://classroom.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/classroom.rosters": { + "description": "Manage your Google Classroom class rosters" }, - "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", - "type": "string" - } - }, - "id": "ListAnnouncementsResponse" - }, - "TimeOfDay": { - "id": "TimeOfDay", - "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`.", - "type": "object", - "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" + "https://www.googleapis.com/auth/classroom.push-notifications": { + "description": "Receive notifications about your Google Classroom data" }, - "nanos": { - "description": "Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.", - "format": "int32", - "type": "integer" + "https://www.googleapis.com/auth/classroom.student-submissions.students.readonly": { + "description": "View course work and grades for students in the Google Classroom classes you teach or administer" }, - "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" + "https://www.googleapis.com/auth/classroom.guardianlinks.students.readonly": { + "description": "View guardians for students in your Google Classroom classes" }, - "minutes": { - "type": "integer", - "description": "Minutes of hour of day. Must be from 0 to 59.", - "format": "int32" + "https://www.googleapis.com/auth/classroom.courses": { + "description": "Manage your Google Classroom classes" + }, + "https://www.googleapis.com/auth/classroom.courses.readonly": { + "description": "View your Google Classroom classes" + }, + "https://www.googleapis.com/auth/classroom.announcements": { + "description": "View and manage announcements in Google Classroom" + }, + "https://www.googleapis.com/auth/classroom.profile.photos": { + "description": "View the profile photos of people in your classes" + }, + "https://www.googleapis.com/auth/classroom.rosters.readonly": { + "description": "View your Google Classroom class rosters" + }, + "https://www.googleapis.com/auth/classroom.guardianlinks.students": { + "description": "View and manage guardians for students in your Google Classroom classes" + }, + "https://www.googleapis.com/auth/classroom.announcements.readonly": { + "description": "View announcements in Google Classroom" + }, + "https://www.googleapis.com/auth/classroom.student-submissions.me.readonly": { + "description": "View your course work and grades in Google Classroom" + }, + "https://www.googleapis.com/auth/classroom.coursework.students.readonly": { + "description": "View course work and grades for students in the Google Classroom classes you teach or administer" + }, + "https://www.googleapis.com/auth/classroom.coursework.students": { + "description": "Manage course work and grades for students in the Google Classroom classes you teach and view the course work and grades for classes you administer" + }, + "https://www.googleapis.com/auth/classroom.guardianlinks.me.readonly": { + "description": "View your Google Classroom guardians" + }, + "https://www.googleapis.com/auth/classroom.coursework.me.readonly": { + "description": "View your course work and grades in Google Classroom" + }, + "https://www.googleapis.com/auth/classroom.profile.emails": { + "description": "View the email addresses of people in your classes" + }, + "https://www.googleapis.com/auth/classroom.coursework.me": { + "description": "Manage your course work and view your grades in Google Classroom" } } - }, - "ListCoursesResponse": { - "description": "Response when listing courses.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", - "type": "string" - }, - "courses": { - "description": "Courses that match the list request.", - "type": "array", - "items": { - "$ref": "Course" - } - } - }, - "id": "ListCoursesResponse" - }, - "Form": { - "description": "Google Forms item.", - "type": "object", - "properties": { - "thumbnailUrl": { - "description": "URL of a thumbnail image of the Form.\n\nRead-only.", - "type": "string" - }, - "responseUrl": { - "description": "URL of the form responses document.\nOnly set if respsonses have been recorded and only when the\nrequesting user is an editor of the form.\n\nRead-only.", - "type": "string" - }, - "formUrl": { - "description": "URL of the form.", - "type": "string" - }, - "title": { - "description": "Title of the Form.\n\nRead-only.", - "type": "string" - } - }, - "id": "Form" - }, - "ModifyCourseWorkAssigneesRequest": { - "properties": { - "assigneeMode": { - "description": "Mode of the coursework describing whether it will be assigned to all\nstudents or specified individual students.", - "type": "string", - "enumDescriptions": [ - "No mode specified. This is never returned.", - "All students can see the item.\nThis is the default state.", - "A subset of the students can see the item." - ], - "enum": [ - "ASSIGNEE_MODE_UNSPECIFIED", - "ALL_STUDENTS", - "INDIVIDUAL_STUDENTS" - ] - }, - "modifyIndividualStudentsOptions": { - "description": "Set which students are assigned or not assigned to the coursework.\nMust be specified only when `assigneeMode` is `INDIVIDUAL_STUDENTS`.", - "$ref": "ModifyIndividualStudentsOptions" - } - }, - "id": "ModifyCourseWorkAssigneesRequest", - "description": "Request to modify assignee mode and options of a coursework.", - "type": "object" - }, - "ListGuardiansResponse": { - "description": "Response when listing guardians.", - "type": "object", - "properties": { - "guardians": { - "description": "Guardians on this page of results that met the criteria specified in\nthe request.", - "type": "array", - "items": { - "$ref": "Guardian" - } - }, - "nextPageToken": { - "type": "string", - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available." - } - }, - "id": "ListGuardiansResponse" - }, - "CourseAlias": { - "properties": { - "alias": { - "description": "Alias string. The format of the string indicates the desired alias scoping.\n\n* `d:\u003cname\u003e` indicates a domain-scoped alias.\n Example: `d:math_101`\n* `p:\u003cname\u003e` indicates a project-scoped alias.\n Example: `p:abc123`\n\nThis field has a maximum length of 256 characters.", - "type": "string" - } - }, - "id": "CourseAlias", - "description": "Alternative identifier for a course.\n\nAn alias uniquely identifies a course. It must be unique within one of the\nfollowing scopes:\n\n* domain: A domain-scoped alias is visible to all users within the alias\ncreator's domain and can be created only by a domain admin. A domain-scoped\nalias is often used when a course has an identifier external to Classroom.\n\n* project: A project-scoped alias is visible to any request from an\napplication using the Developer Console project ID that created the alias\nand can be created by any project. A project-scoped alias is often used when\nan application has alternative identifiers. A random value can also be used\nto avoid duplicate courses in the event of transmission failures, as retrying\na request will return `ALREADY_EXISTS` if a previous one has succeeded.", - "type": "object" - }, - "ListCourseAliasesResponse": { - "description": "Response when listing course aliases.", - "type": "object", - "properties": { - "aliases": { - "description": "The course aliases.", - "type": "array", - "items": { - "$ref": "CourseAlias" - } - }, - "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", - "type": "string" - } - }, - "id": "ListCourseAliasesResponse" - }, - "ListGuardianInvitationsResponse": { - "type": "object", - "properties": { - "guardianInvitations": { - "type": "array", - "items": { - "$ref": "GuardianInvitation" - }, - "description": "Guardian invitations that matched the list request." - }, - "nextPageToken": { - "description": "Token identifying the next page of results to return. If empty, no further\nresults are available.", - "type": "string" - } - }, - "id": "ListGuardianInvitationsResponse", - "description": "Response when listing guardian invitations." - }, - "IndividualStudentsOptions": { - "properties": { - "studentIds": { - "description": "Identifiers for the students that have access to the\ncoursework/announcement.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "IndividualStudentsOptions", - "description": "Assignee details about a coursework/announcement.\nThis field is set if and only if `assigneeMode` is `INDIVIDUAL_STUDENTS`.", - "type": "object" - }, - "Registration": { - "description": "An instruction to Classroom to send notifications from the `feed` to the\nprovided `destination`.", - "type": "object", - "properties": { - "registrationId": { - "description": "A server-generated unique identifier for this `Registration`.\n\nRead-only.", - "type": "string" - }, - "cloudPubsubTopic": { - "$ref": "CloudPubsubTopic", - "description": "The Cloud Pub/Sub topic that notifications are to be sent to." - }, - "expiryTime": { - "description": "The time until which the `Registration` is effective.\n\nThis is a read-only field assigned by the server.", - "format": "google-datetime", - "type": "string" - }, - "feed": { - "$ref": "Feed", - "description": "Specification for the class of notifications that Classroom should deliver\nto the `destination`." - } - }, - "id": "Registration" - }, - "MultipleChoiceSubmission": { - "description": "Student work for a multiple-choice question.", - "type": "object", - "properties": { - "answer": { - "description": "Student's select choice.", - "type": "string" - } - }, - "id": "MultipleChoiceSubmission" - }, - "CourseMaterial": { - "type": "object", - "properties": { - "driveFile": { - "$ref": "DriveFile", - "description": "Google Drive file attachment." - }, - "youTubeVideo": { - "description": "Youtube video attachment.", - "$ref": "YouTubeVideo" - }, - "form": { - "$ref": "Form", - "description": "Google Forms attachment." - }, - "link": { - "description": "Link atatchment.", - "$ref": "Link" - } - }, - "id": "CourseMaterial", - "description": "A material attached to a course as part of a material set." - }, - "MultipleChoiceQuestion": { - "description": "Additional details for multiple-choice questions.", - "type": "object", - "properties": { - "choices": { - "description": "Possible choices.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "MultipleChoiceQuestion" - }, - "Course": { - "description": "A Course in Classroom.", - "type": "object", - "properties": { - "updateTime": { - "description": "Time of the most recent update to this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", - "format": "google-datetime", - "type": "string" - }, - "calendarId": { - "description": "The Calendar ID for a calendar that all course members can see, to which\nClassroom adds events for course work and announcements in the course.\n\nRead-only.", - "type": "string" - }, - "alternateLink": { - "description": "Absolute link to this course in the Classroom web UI.\n\nRead-only.", - "type": "string" - }, - "guardiansEnabled": { - "description": "Whether or not guardian notifications are enabled for this course.\n\nRead-only.", - "type": "boolean" - }, - "courseState": { - "enumDescriptions": [ - "No course state. No returned Course message will use this value.", - "The course is active.", - "The course has been archived. You cannot modify it except to change it\nto a different state.", - "The course has been created, but not yet activated. It is accessible by\nthe primary teacher and domain administrators, who may modify it or\nchange it to the `ACTIVE` or `DECLINED` states.\nA course may only be changed to `PROVISIONED` if it is in the `DECLINED`\nstate.", - "The course has been created, but declined. It is accessible by the\ncourse owner and domain administrators, though it will not be\ndisplayed in the web UI. You cannot modify the course except to change it\nto the `PROVISIONED` state.\nA course may only be changed to `DECLINED` if it is in the `PROVISIONED`\nstate.", - "The course has been suspended. You cannot modify the course, and only the\nuser identified by the `owner_id` can view the course.\nA course may be placed in this state if it potentially violates the\nTerms of Service." - ], - "enum": [ - "COURSE_STATE_UNSPECIFIED", - "ACTIVE", - "ARCHIVED", - "PROVISIONED", - "DECLINED", - "SUSPENDED" - ], - "description": "State of the course.\nIf unspecified, the default state is `PROVISIONED`.", - "type": "string" - }, - "ownerId": { - "description": "The identifier of the owner of a course.\n\nWhen specified as a parameter of a\ncreate course request, this\nfield is required.\nThe identifier can be one of the following:\n\n* the numeric identifier for the user\n* the email address of the user\n* the string literal `\"me\"`, indicating the requesting user\n\nThis must be set in a create request. Admins can also specify this field\nin a patch course request to\ntransfer ownership. In other contexts, it is read-only.", - "type": "string" - }, - "description": { - "description": "Optional description.\nFor example, \"We'll be learning about the structure of living\ncreatures from a combination of textbooks, guest lectures, and lab work.\nExpect to be excited!\"\nIf set, this field must be a valid UTF-8 string and no longer than 30,000\ncharacters.", - "type": "string" - }, - "teacherGroupEmail": { - "description": "The email address of a Google group containing all teachers of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.", - "type": "string" - }, - "creationTime": { - "description": "Creation time of the course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "Name of the course.\nFor example, \"10th Grade Biology\".\nThe name is required. It must be between 1 and 750 characters and a valid\nUTF-8 string.", - "type": "string" - }, - "teacherFolder": { - "description": "Information about a Drive Folder that is shared with all teachers of the\ncourse.\n\nThis field will only be set for teachers of the course and domain administrators.\n\nRead-only.", - "$ref": "DriveFolder" - }, - "section": { - "type": "string", - "description": "Section of the course.\nFor example, \"Period 2\".\nIf set, this field must be a valid UTF-8 string and no longer than 2800\ncharacters." - }, - "id": { - "description": "Identifier for this course assigned by Classroom.\n\nWhen\ncreating a course,\nyou may optionally set this identifier to an\nalias string in the\nrequest to create a corresponding alias. The `id` is still assigned by\nClassroom and cannot be updated after the course is created.\n\nSpecifying this field in a course update mask results in an error.", - "type": "string" - }, - "room": { - "description": "Optional room location.\nFor example, \"301\".\nIf set, this field must be a valid UTF-8 string and no longer than 650\ncharacters.", - "type": "string" - }, - "courseGroupEmail": { - "description": "The email address of a Google group containing all members of the course.\nThis group does not accept email and can only be used for permissions.\n\nRead-only.", - "type": "string" - }, - "courseMaterialSets": { - "description": "Sets of materials that appear on the \"about\" page of this course.\n\nRead-only.", - "type": "array", - "items": { - "$ref": "CourseMaterialSet" - } - }, - "enrollmentCode": { - "description": "Enrollment code to use when joining this course.\nSpecifying this field in a course update mask results in an error.\n\nRead-only.", - "type": "string" - }, - "descriptionHeading": { - "description": "Optional heading for the description.\nFor example, \"Welcome to 10th Grade Biology.\"\nIf set, this field must be a valid UTF-8 string and no longer than 3600\ncharacters.", - "type": "string" - } - }, - "id": "Course" - }, - "DriveFile": { - "type": "object", - "properties": { - "alternateLink": { - "description": "URL that can be used to access the Drive item.\n\nRead-only.", - "type": "string" - }, - "thumbnailUrl": { - "description": "URL of a thumbnail image of the Drive item.\n\nRead-only.", - "type": "string" - }, - "id": { - "description": "Drive API resource ID.", - "type": "string" - }, - "title": { - "description": "Title of the Drive item.\n\nRead-only.", - "type": "string" - } - }, - "id": "DriveFile", - "description": "Representation of a Google Drive file." - }, - "ReturnStudentSubmissionRequest": { - "properties": {}, - "id": "ReturnStudentSubmissionRequest", - "description": "Request to return a student submission.", - "type": "object" - }, - "ReclaimStudentSubmissionRequest": { - "description": "Request to reclaim a student submission.", - "type": "object", - "properties": {}, - "id": "ReclaimStudentSubmissionRequest" } - } + }, + "kind": "discovery#restDescription", + "description": "Manages classes, rosters, and invitations in Google Classroom.", + "servicePath": "", + "rootUrl": "https://classroom.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "classroom", + "batchPath": "batch", + "revision": "20180103", + "documentationLink": "https://developers.google.com/classroom/", + "id": "classroom:v1", + "title": "Google Classroom API" }
diff --git a/cloudbilling/v1/cloudbilling-api.json b/cloudbilling/v1/cloudbilling-api.json index 16f22bc..b59eca2 100644 --- a/cloudbilling/v1/cloudbilling-api.json +++ b/cloudbilling/v1/cloudbilling-api.json
@@ -82,7 +82,7 @@ "parameterOrder": [ "name" ], - "description": "Lists the projects associated with a billing account. The current\nauthenticated user must be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).", + "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the \"billing.resourceAssociations.list\" IAM\npermission, which is often given to billing account\n[viewers](https://support.google.com/cloud/answer/4430947).", "flatPath": "v1/billingAccounts/{billingAccountsId}/projects", "httpMethod": "GET", "parameters": { @@ -197,7 +197,7 @@ "type": "string" }, "endTime": { - "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nMaximum allowable time range is 1 month (31 days). Time range as a whole\nis optional. If not specified, the latest pricing will be returned (up to\n12 hours old at most).", + "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).", "location": "query", "type": "string", "format": "google-datetime" @@ -209,7 +209,7 @@ "format": "int32" }, "startTime": { - "description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nMaximum allowable time range is 1 month (31 days). Time range as a whole\nis optional. If not specified, the latest pricing will be returned (up to\n12 hours old at most).", + "description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).", "location": "query", "type": "string", "format": "google-datetime" @@ -596,7 +596,7 @@ "id": "Category" } }, - "revision": "20170813", + "revision": "20180108", "basePath": "", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif",
diff --git a/cloudbilling/v1/cloudbilling-gen.go b/cloudbilling/v1/cloudbilling-gen.go index e8a5017..af32b06 100644 --- a/cloudbilling/v1/cloudbilling-gen.go +++ b/cloudbilling/v1/cloudbilling-gen.go
@@ -1191,9 +1191,11 @@ // List: Lists the projects associated with a billing account. The // current -// authenticated user must be an [owner of the -// billing -// account](https://support.google.com/cloud/answer/4430947). +// authenticated user must have the "billing.resourceAssociations.list" +// IAM +// permission, which is often given to billing +// account +// [viewers](https://support.google.com/cloud/answer/4430947). func (r *BillingAccountsProjectsService) List(name string) *BillingAccountsProjectsListCall { c := &BillingAccountsProjectsListCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.name = name @@ -1313,7 +1315,7 @@ } return ret, nil // { - // "description": "Lists the projects associated with a billing account. The current\nauthenticated user must be an [owner of the billing\naccount](https://support.google.com/cloud/answer/4430947).", + // "description": "Lists the projects associated with a billing account. The current\nauthenticated user must have the \"billing.resourceAssociations.list\" IAM\npermission, which is often given to billing account\n[viewers](https://support.google.com/cloud/answer/4430947).", // "flatPath": "v1/billingAccounts/{billingAccountsId}/projects", // "httpMethod": "GET", // "id": "cloudbilling.billingAccounts.projects.list", @@ -1909,11 +1911,13 @@ // time of the time range for which the pricing // versions will be returned. Timestamps in the future are not // allowed. -// Maximum allowable time range is 1 month (31 days). Time range as a -// whole -// is optional. If not specified, the latest pricing will be returned -// (up to -// 12 hours old at most). +// The time range has to be within a single calendar month +// in +// America/Los_Angeles timezone. Time range as a whole is optional. If +// not +// specified, the latest pricing will be returned (up to 12 hours old +// at +// most). func (c *ServicesSkusListCall) EndTime(endTime string) *ServicesSkusListCall { c.urlParams_.Set("endTime", endTime) return c @@ -1940,11 +1944,13 @@ // start time of the time range for which the pricing // versions will be returned. Timestamps in the future are not // allowed. -// Maximum allowable time range is 1 month (31 days). Time range as a -// whole -// is optional. If not specified, the latest pricing will be returned -// (up to -// 12 hours old at most). +// The time range has to be within a single calendar month +// in +// America/Los_Angeles timezone. Time range as a whole is optional. If +// not +// specified, the latest pricing will be returned (up to 12 hours old +// at +// most). func (c *ServicesSkusListCall) StartTime(startTime string) *ServicesSkusListCall { c.urlParams_.Set("startTime", startTime) return c @@ -2058,7 +2064,7 @@ // "type": "string" // }, // "endTime": { - // "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nMaximum allowable time range is 1 month (31 days). Time range as a whole\nis optional. If not specified, the latest pricing will be returned (up to\n12 hours old at most).", + // "description": "Optional exclusive end time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).", // "format": "google-datetime", // "location": "query", // "type": "string" @@ -2082,7 +2088,7 @@ // "type": "string" // }, // "startTime": { - // "description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nMaximum allowable time range is 1 month (31 days). Time range as a whole\nis optional. If not specified, the latest pricing will be returned (up to\n12 hours old at most).", + // "description": "Optional inclusive start time of the time range for which the pricing\nversions will be returned. Timestamps in the future are not allowed.\nThe time range has to be within a single calendar month in\nAmerica/Los_Angeles timezone. Time range as a whole is optional. If not\nspecified, the latest pricing will be returned (up to 12 hours old at\nmost).", // "format": "google-datetime", // "location": "query", // "type": "string"
diff --git a/cloudbuild/v1/cloudbuild-api.json b/cloudbuild/v1/cloudbuild-api.json index aebedc2..4dacdc8 100644 --- a/cloudbuild/v1/cloudbuild-api.json +++ b/cloudbuild/v1/cloudbuild-api.json
@@ -1,38 +1,17 @@ { + "batchPath": "batch", + "title": "Google Cloud Container Builder API", "ownerName": "Google", "resources": { "projects": { "resources": { "builds": { "methods": { - "create": { - "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).", - "request": { - "$ref": "Build" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "ID of the project.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}/builds", - "path": "v1/projects/{projectId}/builds", - "id": "cloudbuild.projects.builds.create" - }, "cancel": { + "request": { + "$ref": "CancelBuildRequest" + }, + "description": "Cancels a requested build in progress.", "httpMethod": "POST", "parameterOrder": [ "projectId", @@ -60,62 +39,98 @@ ], "flatPath": "v1/projects/{projectId}/builds/{id}:cancel", "id": "cloudbuild.projects.builds.cancel", - "path": "v1/projects/{projectId}/builds/{id}:cancel", - "request": { - "$ref": "CancelBuildRequest" - }, - "description": "Cancels a requested build in progress." + "path": "v1/projects/{projectId}/builds/{id}:cancel" }, "retry": { - "httpMethod": "POST", + "path": "v1/projects/{projectId}/builds/{id}:retry", + "id": "cloudbuild.projects.builds.retry", + "request": { + "$ref": "RetryBuildRequest" + }, + "description": "Creates a new build based on the given build.\n\nThis API creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision, so a retry of a triggered\nbuild will result in a build that uses the same revision.\n\nFor non-triggered builds that specify RepoSource:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify StorageSource:\n\n* If the original build pulled source from Cloud Storage without specifying\nthe generation of the object, the new build will use the current object,\nwhich may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings.", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "projectId", "id" ], - "response": { - "$ref": "Operation" - }, + "httpMethod": "POST", "parameters": { "id": { - "location": "path", "description": "Build ID of the original build.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "projectId": { - "location": "path", "description": "ID of the project.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectId}/builds/{id}:retry", - "id": "cloudbuild.projects.builds.retry", - "path": "v1/projects/{projectId}/builds/{id}:retry", - "request": { - "$ref": "RetryBuildRequest" - }, - "description": "Creates a new build based on the given build.\n\nThis API creates a new build using the original build request, which may\nor may not result in an identical build.\n\nFor triggered builds:\n\n* Triggered builds resolve to a precise revision, so a retry of a triggered\nbuild will result in a build that uses the same revision.\n\nFor non-triggered builds that specify RepoSource:\n\n* If the original build built from the tip of a branch, the retried build\nwill build from the tip of that branch, which may not be the same revision\nas the original build.\n* If the original build specified a commit sha or revision ID, the retried\nbuild will use the identical source.\n\nFor builds that specify StorageSource:\n\n* If the original build pulled source from Cloud Storage without specifying\nthe generation of the object, the new build will use the current object,\nwhich may be different from the original build source.\n* If the original build pulled source from Cloud Storage and specified the\ngeneration of the object, the new build will attempt to use the same\nobject, which may or may not be available depending on the bucket's\nlifecycle management settings." + "flatPath": "v1/projects/{projectId}/builds/{id}:retry" }, "get": { + "path": "v1/projects/{projectId}/builds/{id}", + "id": "cloudbuild.projects.builds.get", "description": "Returns information about a previously requested build.\n\nThe Build that is returned includes its status (e.g., success or failure,\nor in-progress), and timing information.", - "httpMethod": "GET", + "response": { + "$ref": "Build" + }, "parameterOrder": [ "projectId", "id" ], - "response": { - "$ref": "Build" - }, + "httpMethod": "GET", "parameters": { + "projectId": { + "location": "path", + "description": "ID of the project.", + "required": true, + "type": "string" + }, "id": { "location": "path", "description": "ID of the build.", "required": true, "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/builds/{id}" + }, + "list": { + "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.", + "response": { + "$ref": "ListBuildsResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "GET", + "parameters": { + "filter": { + "description": "The raw filter text to constrain the results.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "Token to provide to skip to a particular spot in the list.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Number of results to return in the list.", + "format": "int32", + "type": "integer" }, "projectId": { "description": "ID of the project.", @@ -127,119 +142,41 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectId}/builds/{id}", - "id": "cloudbuild.projects.builds.get", - "path": "v1/projects/{projectId}/builds/{id}" - }, - "list": { - "id": "cloudbuild.projects.builds.list", + "flatPath": "v1/projects/{projectId}/builds", "path": "v1/projects/{projectId}/builds", - "description": "Lists previously requested builds.\n\nPreviously requested builds may still be in-progress, or may have finished\nsuccessfully or unsuccessfully.", - "httpMethod": "GET", + "id": "cloudbuild.projects.builds.list" + }, + "create": { + "request": { + "$ref": "Build" + }, + "description": "Starts a build with the specified configuration.\n\nThe long-running Operation returned by this method will include the ID of\nthe build, which can be passed to GetBuild to determine its status (e.g.,\nsuccess or failure).", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "projectId" ], - "response": { - "$ref": "ListBuildsResponse" - }, + "httpMethod": "POST", "parameters": { - "filter": { - "location": "query", - "description": "The raw filter text to constrain the results.", - "type": "string" - }, - "pageToken": { - "description": "Token to provide to skip to a particular spot in the list.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Number of results to return in the list.", - "format": "int32", - "type": "integer", - "location": "query" - }, "projectId": { - "location": "path", "description": "ID of the project.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectId}/builds" + "flatPath": "v1/projects/{projectId}/builds", + "path": "v1/projects/{projectId}/builds", + "id": "cloudbuild.projects.builds.create" } } }, "triggers": { "methods": { - "patch": { - "response": { - "$ref": "BuildTrigger" - }, - "parameterOrder": [ - "projectId", - "triggerId" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "triggerId": { - "location": "path", - "description": "ID of the BuildTrigger to update.", - "required": true, - "type": "string" - }, - "projectId": { - "description": "ID of the project that owns the trigger.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", - "path": "v1/projects/{projectId}/triggers/{triggerId}", - "id": "cloudbuild.projects.triggers.patch", - "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.", - "request": { - "$ref": "BuildTrigger" - } - }, - "get": { - "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.", - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "triggerId" - ], - "response": { - "$ref": "BuildTrigger" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "triggerId": { - "description": "ID of the BuildTrigger to get.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "location": "path", - "description": "ID of the project that owns the trigger.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", - "id": "cloudbuild.projects.triggers.get", - "path": "v1/projects/{projectId}/triggers/{triggerId}" - }, "delete": { "response": { "$ref": "Empty" @@ -249,9 +186,6 @@ "triggerId" ], "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "triggerId": { "location": "path", @@ -260,12 +194,15 @@ "type": "string" }, "projectId": { + "location": "path", "description": "ID of the project that owns the trigger.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", "path": "v1/projects/{projectId}/triggers/{triggerId}", "id": "cloudbuild.projects.triggers.delete", @@ -296,6 +233,10 @@ "description": "Lists existing BuildTrigger.\n\nThis API is experimental." }, "create": { + "description": "Creates a new BuildTrigger.\n\nThis API is experimental.", + "request": { + "$ref": "BuildTrigger" + }, "response": { "$ref": "BuildTrigger" }, @@ -308,44 +249,72 @@ ], "parameters": { "projectId": { + "location": "path", "description": "ID of the project for which to configure automatic builds.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "flatPath": "v1/projects/{projectId}/triggers", "path": "v1/projects/{projectId}/triggers", - "id": "cloudbuild.projects.triggers.create", - "description": "Creates a new BuildTrigger.\n\nThis API is experimental.", - "request": { - "$ref": "BuildTrigger" - } + "id": "cloudbuild.projects.triggers.create" }, "run": { - "id": "cloudbuild.projects.triggers.run", - "path": "v1/projects/{projectId}/triggers/{triggerId}:run", "request": { "$ref": "RepoSource" }, "description": "Runs a BuildTrigger at a particular source revision.", - "httpMethod": "POST", + "response": { + "$ref": "Operation" + }, "parameterOrder": [ "projectId", "triggerId" ], - "response": { - "$ref": "Operation" + "httpMethod": "POST", + "parameters": { + "triggerId": { + "description": "ID of the trigger.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "ID of the project.", + "required": true, + "type": "string" + } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run", + "path": "v1/projects/{projectId}/triggers/{triggerId}:run", + "id": "cloudbuild.projects.triggers.run" + }, + "get": { + "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", + "path": "v1/projects/{projectId}/triggers/{triggerId}", + "id": "cloudbuild.projects.triggers.get", + "description": "Gets information about a BuildTrigger.\n\nThis API is experimental.", + "response": { + "$ref": "BuildTrigger" + }, + "parameterOrder": [ + "projectId", + "triggerId" + ], + "httpMethod": "GET", "parameters": { "triggerId": { "location": "path", - "description": "ID of the trigger.", + "description": "ID of the BuildTrigger to get.", "required": true, "type": "string" }, "projectId": { - "description": "ID of the project.", + "description": "ID of the project that owns the trigger.", "required": true, "type": "string", "location": "path" @@ -353,8 +322,41 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "flatPath": "v1/projects/{projectId}/triggers/{triggerId}", + "path": "v1/projects/{projectId}/triggers/{triggerId}", + "id": "cloudbuild.projects.triggers.patch", + "description": "Updates an BuildTrigger by its project ID and trigger ID.\n\nThis API is experimental.", + "request": { + "$ref": "BuildTrigger" + }, + "response": { + "$ref": "BuildTrigger" + }, + "parameterOrder": [ + "projectId", + "triggerId" ], - "flatPath": "v1/projects/{projectId}/triggers/{triggerId}:run" + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "triggerId": { + "description": "ID of the BuildTrigger to update.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "description": "ID of the project that owns the trigger.", + "required": true, + "type": "string", + "location": "path" + } + } } } } @@ -363,13 +365,13 @@ "operations": { "methods": { "cancel": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], "response": { "$ref": "Empty" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", "parameters": { "name": { "pattern": "^operations/.+$", @@ -383,17 +385,14 @@ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/operations/{operationsId}:cancel", - "id": "cloudbuild.operations.cancel", "path": "v1/{+name}:cancel", + "id": "cloudbuild.operations.cancel", "request": { "$ref": "CancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." }, "list": { - "path": "v1/{+name}", - "id": "cloudbuild.operations.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.", "response": { "$ref": "ListOperationsResponse" }, @@ -401,48 +400,52 @@ "name" ], "httpMethod": "GET", + "parameters": { + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^operations$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations", + "path": "v1/{+name}", + "id": "cloudbuild.operations.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." + }, + "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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, - "name": { - "pattern": "^operations$", - "location": "path", - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v1/operations" - }, - "get": { - "id": "cloudbuild.operations.get", - "path": "v1/{+name}", - "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", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { "name": { "description": "The name of the operation resource.", "required": true, @@ -451,19 +454,18 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations/{operationsId}" + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "cloudbuild.operations.get" } } } }, "parameters": { "upload_protocol": { + "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", @@ -477,9 +479,9 @@ "type": "string" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "$.xgafv": { "enumDescriptions": [ @@ -500,12 +502,6 @@ "type": "string" }, "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -513,22 +509,28 @@ ], "location": "query", "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], "type": "string" }, "key": { + "location": "query", "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.", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", "type": "string", "location": "query" }, "quotaUser": { - "location": "query", "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.", - "type": "string" + "type": "string", + "location": "query" }, "pp": { "location": "query", @@ -537,9 +539,9 @@ "default": "true" }, "oauth_token": { + "location": "query", "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" + "type": "string" }, "bearer_token": { "location": "query", @@ -549,18 +551,232 @@ }, "version": "v1", "baseUrl": "https://cloudbuild.googleapis.com/", - "kind": "discovery#restDescription", "description": "Builds container images in the cloud.", + "kind": "discovery#restDescription", "servicePath": "", "basePath": "", - "id": "cloudbuild:v1", + "revision": "20180107", "documentationLink": "https://cloud.google.com/container-builder/docs/", - "revision": "20180104", + "id": "cloudbuild:v1", "discoveryVersion": "v1", "version_module": true, "schemas": { - "Status": { + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "Source": { + "description": "Source describes the location of the source in a supported storage\nservice.", + "type": "object", "properties": { + "storageSource": { + "$ref": "StorageSource", + "description": "If provided, get the source from this location in Google Cloud Storage." + }, + "repoSource": { + "$ref": "RepoSource", + "description": "If provided, get source from this location in a Cloud Repo." + } + }, + "id": "Source" + }, + "RetryBuildRequest": { + "description": "RetryBuildRequest specifies a build to retry.", + "type": "object", + "properties": {}, + "id": "RetryBuildRequest" + }, + "BuildOperationMetadata": { + "description": "Metadata for build operations.", + "type": "object", + "properties": { + "build": { + "$ref": "Build", + "description": "The build that the operation is tracking." + } + }, + "id": "BuildOperationMetadata" + }, + "SourceProvenance": { + "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.", + "type": "object", + "properties": { + "fileHashes": { + "additionalProperties": { + "$ref": "FileHashes" + }, + "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly", + "type": "object" + }, + "resolvedRepoSource": { + "$ref": "RepoSource", + "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved." + }, + "resolvedStorageSource": { + "$ref": "StorageSource", + "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved." + } + }, + "id": "SourceProvenance" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "type": "object", + "properties": {}, + "id": "CancelOperationRequest" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "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.", + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "id": "Operation" + }, + "BuildStep": { + "description": "BuildStep describes a step to perform in the build pipeline.", + "type": "object", + "properties": { + "entrypoint": { + "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.", + "type": "string" + }, + "secretEnv": { + "description": "A list of environment variables which are encrypted using a Cloud KMS\ncrypto key. These values must be specified in the build's secrets.", + "type": "array", + "items": { + "type": "string" + } + }, + "id": { + "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.", + "type": "string" + }, + "volumes": { + "description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request.", + "type": "array", + "items": { + "$ref": "Volume" + } + }, + "dir": { + "description": "Working directory (relative to project source root) to use when running\nthis operation's container.", + "type": "string" + }, + "env": { + "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", + "type": "array", + "items": { + "type": "string" + } + }, + "waitFor": { + "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.", + "type": "array", + "items": { + "type": "string" + } + }, + "timing": { + "$ref": "TimeSpan", + "description": "Stores timing information for executing this build step." + }, + "args": { + "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.", + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.", + "type": "string" + } + }, + "id": "BuildStep" + }, + "RepoSource": { + "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.", + "type": "object", + "properties": { + "commitSha": { + "description": "Explicit commit SHA to build.", + "type": "string" + }, + "dir": { + "description": "Directory, relative to the source root, in which to run the build.", + "type": "string" + }, + "branchName": { + "description": "Name of the branch to build.", + "type": "string" + }, + "tagName": { + "description": "Name of the tag to build.", + "type": "string" + }, + "repoName": { + "description": "Name of the repo. If omitted, the name \"default\" is assumed.", + "type": "string" + }, + "projectId": { + "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.", + "type": "string" + } + }, + "id": "RepoSource" + }, + "FileHashes": { + "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.", + "type": "object", + "properties": { + "fileHash": { + "description": "Collection of file hashes.", + "type": "array", + "items": { + "$ref": "Hash" + } + } + }, + "id": "FileHashes" + }, + "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.", + "type": "object", + "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 is a common set of\nmessage types for APIs to use.", "type": "array", @@ -576,33 +792,14 @@ "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" } }, - "id": "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.", - "type": "object" + "id": "Status" }, "BuildTrigger": { + "description": "Configuration for an automated build in response to source repository\nchanges.", + "type": "object", "properties": { - "id": { - "description": "Unique identifier of the trigger.\n\n@OutputOnly", - "type": "string" - }, - "build": { - "description": "Contents of the build template.", - "$ref": "Build" - }, - "substitutions": { - "additionalProperties": { - "type": "string" - }, - "description": "Substitutions data for Build resource.", - "type": "object" - }, "description": { "description": "Human-readable description of this trigger.", "type": "string" @@ -623,50 +820,27 @@ "triggerTemplate": { "description": "Template describing the types of source changes to trigger a build.\n\nBranch and tag names in trigger templates are interpreted as regular\nexpressions. Any branch or tag change that matches that regular expression\nwill trigger a build.", "$ref": "RepoSource" + }, + "id": { + "description": "Unique identifier of the trigger.\n\n@OutputOnly", + "type": "string" + }, + "build": { + "description": "Contents of the build template.", + "$ref": "Build" + }, + "substitutions": { + "additionalProperties": { + "type": "string" + }, + "description": "Substitutions data for Build resource.", + "type": "object" } }, - "id": "BuildTrigger", - "description": "Configuration for an automated build in response to source repository\nchanges.", - "type": "object" + "id": "BuildTrigger" }, "Build": { "properties": { - "timing": { - "additionalProperties": { - "$ref": "TimeSpan" - }, - "description": "Stores timing information for phases of the build. Valid keys are:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source, or does not specify images,\nthese keys will not be included.", - "type": "object" - }, - "createTime": { - "description": "Time at which the request to create the build was received.\n@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "sourceProvenance": { - "description": "A permanent fixed identifier for source.\n@OutputOnly", - "$ref": "SourceProvenance" - }, - "images": { - "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.", - "type": "array", - "items": { - "type": "string" - } - }, - "projectId": { - "description": "ID of the project.\n@OutputOnly.", - "type": "string" - }, - "finishTime": { - "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "logUrl": { - "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly", - "type": "string" - }, "source": { "description": "Describes where to find the source files to build.", "$ref": "Source" @@ -675,9 +849,8 @@ "description": "Special options for this build.", "$ref": "BuildOptions" }, - "timeout": { - "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes.", - "format": "google-duration", + "statusDetail": { + "description": "Customer-readable message about the current status.\n@OutputOnly", "type": "string" }, "status": { @@ -704,8 +877,9 @@ "description": "Status of the build.\n@OutputOnly", "type": "string" }, - "statusDetail": { - "description": "Customer-readable message about the current status.\n@OutputOnly", + "timeout": { + "description": "Amount of time that this build should be allowed to run, to second\ngranularity. If this amount of time elapses, work on the build will cease\nand the build status will be TIMEOUT.\n\nDefault time is ten minutes.", + "format": "google-duration", "type": "string" }, "secrets": { @@ -720,8 +894,8 @@ "type": "string" }, "results": { - "description": "Results of the build.\n@OutputOnly", - "$ref": "Results" + "$ref": "Results", + "description": "Results of the build.\n@OutputOnly" }, "steps": { "description": "Describes the operations to be performed on the workspace.", @@ -734,6 +908,10 @@ "description": "The ID of the BuildTrigger that triggered this build, if it was\ntriggered automatically.\n@OutputOnly", "type": "string" }, + "id": { + "description": "Unique identifier of the build.\n@OutputOnly", + "type": "string" + }, "tags": { "description": "Tags for annotation of a Build. These are not docker tags.", "type": "array", @@ -741,10 +919,6 @@ "type": "string" } }, - "id": { - "description": "Unique identifier of the build.\n@OutputOnly", - "type": "string" - }, "startTime": { "description": "Time at which execution of the build was started.\n@OutputOnly", "format": "google-datetime", @@ -756,6 +930,42 @@ }, "description": "Substitutions data for Build resource.", "type": "object" + }, + "timing": { + "additionalProperties": { + "$ref": "TimeSpan" + }, + "description": "Stores timing information for phases of the build. Valid keys are:\n\n* BUILD: time to execute all build steps\n* PUSH: time to push all specified images.\n* FETCHSOURCE: time to fetch source.\n\nIf the build does not specify source, or does not specify images,\nthese keys will not be included.", + "type": "object" + }, + "createTime": { + "description": "Time at which the request to create the build was received.\n@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "sourceProvenance": { + "$ref": "SourceProvenance", + "description": "A permanent fixed identifier for source.\n@OutputOnly" + }, + "images": { + "description": "A list of images to be pushed upon the successful completion of all build\nsteps.\n\nThe images will be pushed using the builder service account's credentials.\n\nThe digests of the pushed images will be stored in the Build resource's\nresults field.\n\nIf any of the images fail to be pushed, the build is marked FAILURE.", + "type": "array", + "items": { + "type": "string" + } + }, + "projectId": { + "description": "ID of the project.\n@OutputOnly.", + "type": "string" + }, + "finishTime": { + "description": "Time at which execution of the build was finished.\n\nThe difference between finish_time and start_time is the duration of the\nbuild's execution.\n@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "logUrl": { + "description": "URL to logs for this build in Google Cloud Logging.\n@OutputOnly", + "type": "string" } }, "id": "Build", @@ -769,19 +979,19 @@ "type": "object" }, "Volume": { + "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.", + "type": "object", "properties": { - "path": { - "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.", - "type": "string" - }, "name": { "description": "Name of the volume to mount.\n\nVolume names must be unique per build step and must be valid names for\nDocker volumes. Each named volume must be used by at least two build steps.", "type": "string" + }, + "path": { + "description": "Path at which to mount the volume.\n\nPaths must be absolute and cannot conflict with other volume paths on the\nsame build step or with certain reserved volume paths.", + "type": "string" } }, - "id": "Volume", - "description": "Volume describes a Docker container volume which is mounted into build steps\nin order to persist files across build step execution.", - "type": "object" + "id": "Volume" }, "ListBuildsResponse": { "properties": { @@ -802,6 +1012,8 @@ "type": "object" }, "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", @@ -815,11 +1027,11 @@ } } }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations.", - "type": "object" + "id": "ListOperationsResponse" }, "TimeSpan": { + "description": "Stores start and end times for a build execution phase.", + "type": "object", "properties": { "endTime": { "description": "End of time span.", @@ -832,27 +1044,25 @@ "type": "string" } }, - "id": "TimeSpan", - "description": "Stores start and end times for a build execution phase.", - "type": "object" + "id": "TimeSpan" }, "BuildOptions": { "description": "Optional arguments to enable specific features of builds.", "type": "object", "properties": { "machineType": { + "enumDescriptions": [ + "Standard machine type.", + "Highcpu machine with 8 CPUs.", + "Highcpu machine with 32 CPUs." + ], "enum": [ "UNSPECIFIED", "N1_HIGHCPU_8", "N1_HIGHCPU_32" ], "description": "Compute Engine machine type on which to run the build.", - "type": "string", - "enumDescriptions": [ - "Standard machine type.", - "Highcpu machine with 8 CPUs.", - "Highcpu machine with 32 CPUs." - ] + "type": "string" }, "logStreamingOption": { "enumDescriptions": [ @@ -869,15 +1079,15 @@ "type": "string" }, "requestedVerifyOption": { - "enum": [ - "NOT_VERIFIED", - "VERIFIED" - ], "description": "Requested verifiability options.", "type": "string", "enumDescriptions": [ "Not a verifiable build. (default)", "Verified build." + ], + "enum": [ + "NOT_VERIFIED", + "VERIFIED" ] }, "substitutionOption": { @@ -936,25 +1146,25 @@ "type": "object" }, "Results": { - "description": "Results describes the artifacts created by the build pipeline.", - "type": "object", "properties": { - "images": { - "description": "Images that were built as a part of the build.", - "type": "array", - "items": { - "$ref": "BuiltImage" - } - }, "buildStepImages": { "description": "List of build step digests, in order corresponding to build step indices.", "type": "array", "items": { "type": "string" } + }, + "images": { + "description": "Images that were built as a part of the build.", + "type": "array", + "items": { + "$ref": "BuiltImage" + } } }, - "id": "Results" + "id": "Results", + "description": "Results describes the artifacts created by the build pipeline.", + "type": "object" }, "ListBuildTriggersResponse": { "description": "Response containing existing BuildTriggers.", @@ -971,6 +1181,8 @@ "id": "ListBuildTriggersResponse" }, "BuiltImage": { + "description": "BuiltImage describes an image built by the pipeline.", + "type": "object", "properties": { "pushTiming": { "$ref": "TimeSpan", @@ -985,260 +1197,50 @@ "type": "string" } }, - "id": "BuiltImage", - "description": "BuiltImage describes an image built by the pipeline.", - "type": "object" + "id": "BuiltImage" }, "Hash": { + "description": "Container message for hash values.", + "type": "object", "properties": { + "value": { + "description": "The hash value.", + "format": "byte", + "type": "string" + }, "type": { - "enum": [ - "NONE", - "SHA256" - ], "description": "The type of hash that was performed.", "type": "string", "enumDescriptions": [ "No hash requested.", "Use a sha256 hash." + ], + "enum": [ + "NONE", + "SHA256" ] - }, - "value": { - "description": "The hash value.", - "format": "byte", - "type": "string" } }, - "id": "Hash", - "description": "Container message for hash values.", - "type": "object" + "id": "Hash" }, "Secret": { + "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.", + "type": "object", "properties": { "kmsKeyName": { "description": "Cloud KMS key name to use to decrypt these envs.", "type": "string" }, "secretEnv": { + "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n1 KB in size. There can be at most ten secret values across all of a\nbuild's secrets.", + "type": "object", "additionalProperties": { "format": "byte", "type": "string" - }, - "description": "Map of environment variable name to its encrypted value.\n\nSecret environment variables must be unique across all of a build's\nsecrets, and must be used by at least one build step. Values can be at most\n1 KB in size. There can be at most ten secret values across all of a\nbuild's secrets.", - "type": "object" - } - }, - "id": "Secret", - "description": "Secret pairs a set of secret environment variables containing encrypted\nvalues with the Cloud KMS key to use to decrypt the value.", - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "Source": { - "properties": { - "storageSource": { - "description": "If provided, get the source from this location in Google Cloud Storage.", - "$ref": "StorageSource" - }, - "repoSource": { - "$ref": "RepoSource", - "description": "If provided, get source from this location in a Cloud Repo." - } - }, - "id": "Source", - "description": "Source describes the location of the source in a supported storage\nservice.", - "type": "object" - }, - "RetryBuildRequest": { - "description": "RetryBuildRequest specifies a build to retry.", - "type": "object", - "properties": {}, - "id": "RetryBuildRequest" - }, - "BuildOperationMetadata": { - "description": "Metadata for build operations.", - "type": "object", - "properties": { - "build": { - "description": "The build that the operation is tracking.", - "$ref": "Build" - } - }, - "id": "BuildOperationMetadata" - }, - "SourceProvenance": { - "description": "Provenance of the source. Ways to find the original source, or verify that\nsome source was used for this build.", - "type": "object", - "properties": { - "fileHashes": { - "additionalProperties": { - "$ref": "FileHashes" - }, - "description": "Hash(es) of the build source, which can be used to verify that the original\nsource integrity was maintained in the build. Note that FileHashes will\nonly be populated if BuildOptions has requested a SourceProvenanceHash.\n\nThe keys to this map are file paths used as build source and the values\ncontain the hash values for those files.\n\nIf the build source came in a single package such as a gzipped tarfile\n(.tar.gz), the FileHash will be for the single path to that file.\n@OutputOnly", - "type": "object" - }, - "resolvedRepoSource": { - "$ref": "RepoSource", - "description": "A copy of the build's source.repo_source, if exists, with any\nrevisions resolved." - }, - "resolvedStorageSource": { - "description": "A copy of the build's source.storage_source, if exists, with any\ngenerations resolved.", - "$ref": "StorageSource" - } - }, - "id": "SourceProvenance" - }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "type": "object", - "properties": {}, - "id": "CancelOperationRequest" - }, - "Operation": { - "properties": { - "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "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" - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object" - }, - "RepoSource": { - "description": "RepoSource describes the location of the source in a Google Cloud Source\nRepository.", - "type": "object", - "properties": { - "commitSha": { - "description": "Explicit commit SHA to build.", - "type": "string" - }, - "dir": { - "description": "Directory, relative to the source root, in which to run the build.", - "type": "string" - }, - "branchName": { - "description": "Name of the branch to build.", - "type": "string" - }, - "tagName": { - "description": "Name of the tag to build.", - "type": "string" - }, - "repoName": { - "description": "Name of the repo. If omitted, the name \"default\" is assumed.", - "type": "string" - }, - "projectId": { - "description": "ID of the project that owns the repo. If omitted, the project ID requesting\nthe build is assumed.", - "type": "string" - } - }, - "id": "RepoSource" - }, - "BuildStep": { - "properties": { - "volumes": { - "description": "List of volumes to mount into the build step.\n\nEach volume will be created as an empty volume prior to execution of the\nbuild step. Upon completion of the build, volumes and their contents will\nbe discarded.\n\nUsing a named volume in only one step is not valid as it is indicative\nof a mis-configured build request.", - "type": "array", - "items": { - "$ref": "Volume" - } - }, - "dir": { - "description": "Working directory (relative to project source root) to use when running\nthis operation's container.", - "type": "string" - }, - "env": { - "description": "A list of environment variable definitions to be used when running a step.\n\nThe elements are of the form \"KEY=VALUE\" for the environment variable \"KEY\"\nbeing given the value \"VALUE\".", - "type": "array", - "items": { - "type": "string" - } - }, - "waitFor": { - "description": "The ID(s) of the step(s) that this build step depends on.\nThis build step will not start until all the build steps in wait_for\nhave completed successfully. If wait_for is empty, this build step will\nstart when all previous build steps in the Build.Steps list have completed\nsuccessfully.", - "type": "array", - "items": { - "type": "string" - } - }, - "timing": { - "description": "Stores timing information for executing this build step.", - "$ref": "TimeSpan" - }, - "args": { - "description": "A list of arguments that will be presented to the step when it is started.\n\nIf the image used to run the step's container has an entrypoint, these args\nwill be used as arguments to that entrypoint. If the image does not define\nan entrypoint, the first element in args will be used as the entrypoint,\nand the remainder will be used as arguments.", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "The name of the container image that will run this particular build step.\n\nIf the image is already available in the host's Docker daemon's cache, it\nwill be run directly. If not, the host will attempt to pull the image\nfirst, using the builder service account's credentials if necessary.\n\nThe Docker daemon's cache will already have the latest versions of all of\nthe officially supported build steps\n([https://github.com/GoogleCloudPlatform/cloud-builders](https://github.com/GoogleCloudPlatform/cloud-builders)).\nThe Docker daemon will also have cached many of the layers for some popular\nimages, like \"ubuntu\", \"debian\", but they will be refreshed at the time you\nattempt to use them.\n\nIf you built an image in a previous build step, it will be stored in the\nhost's Docker daemon's cache and is available to use as the name for a\nlater build step.", - "type": "string" - }, - "entrypoint": { - "description": "Optional entrypoint to be used instead of the build step image's default\nIf unset, the image's default will be used.", - "type": "string" - }, - "secretEnv": { - "description": "A list of environment variables which are encrypted using a Cloud KMS\ncrypto key. These values must be specified in the build's secrets.", - "type": "array", - "items": { - "type": "string" - } - }, - "id": { - "description": "Optional unique identifier for this build step, used in wait_for to\nreference this build step as a dependency.", - "type": "string" - } - }, - "id": "BuildStep", - "description": "BuildStep describes a step to perform in the build pipeline.", - "type": "object" - }, - "FileHashes": { - "properties": { - "fileHash": { - "description": "Collection of file hashes.", - "type": "array", - "items": { - "$ref": "Hash" } } }, - "id": "FileHashes", - "description": "Container message for hashes of byte content of files, used in\nSourceProvenance messages to verify integrity of source input to the build.", - "type": "object" + "id": "Secret" } }, "icons": { @@ -1258,7 +1260,5 @@ }, "rootUrl": "https://cloudbuild.googleapis.com/", "ownerDomain": "google.com", - "name": "cloudbuild", - "batchPath": "batch", - "title": "Google Cloud Container Builder API" + "name": "cloudbuild" }
diff --git a/clouddebugger/v2/clouddebugger-api.json b/clouddebugger/v2/clouddebugger-api.json index 3dc44c1..6540c45 100644 --- a/clouddebugger/v2/clouddebugger-api.json +++ b/clouddebugger/v2/clouddebugger-api.json
@@ -1,461 +1,422 @@ { - "schemas": { - "ListActiveBreakpointsResponse": { - "description": "Response for listing active breakpoints.", - "type": "object", - "properties": { - "nextWaitToken": { - "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.", - "type": "string" - }, - "breakpoints": { - "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.", - "type": "array", - "items": { - "$ref": "Breakpoint" - } - }, - "waitExpired": { - "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.", - "type": "boolean" - } - }, - "id": "ListActiveBreakpointsResponse" - }, - "ProjectRepoId": { - "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.", - "type": "object", - "properties": { - "projectId": { - "description": "The ID of the project.", - "type": "string" - }, - "repoName": { - "description": "The name of the repo. Leave empty for the default repo.", - "type": "string" - } - }, - "id": "ProjectRepoId" - }, - "CloudWorkspaceSourceContext": { - "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.", - "type": "object", - "properties": { - "snapshotId": { - "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.", - "type": "string" - }, - "workspaceId": { - "description": "The ID of the workspace.", - "$ref": "CloudWorkspaceId" - } - }, - "id": "CloudWorkspaceSourceContext" - }, - "UpdateActiveBreakpointResponse": { - "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.", - "type": "object", - "properties": {}, - "id": "UpdateActiveBreakpointResponse" - }, - "GerritSourceContext": { - "description": "A SourceContext referring to a Gerrit project.", - "type": "object", - "properties": { - "gerritProject": { - "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.", - "type": "string" - }, - "aliasContext": { - "description": "An alias, which may be a branch or tag.", - "$ref": "AliasContext" - }, - "hostUri": { - "description": "The URI of a running Gerrit instance.", - "type": "string" - }, - "revisionId": { - "description": "A revision (commit) ID.", - "type": "string" - }, - "aliasName": { - "description": "The name of an alias (branch, tag, etc.).", - "type": "string" - } - }, - "id": "GerritSourceContext" - }, - "CloudWorkspaceId": { - "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.", - "type": "object", - "properties": { - "repoId": { - "$ref": "RepoId", - "description": "The ID of the repo containing the workspace." - }, - "name": { - "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.", - "type": "string" - } - }, - "id": "CloudWorkspaceId" - }, - "ListBreakpointsResponse": { - "description": "Response for listing breakpoints.", - "type": "object", - "properties": { - "nextWaitToken": { - "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.", - "type": "string" - }, - "breakpoints": { - "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status.", - "type": "array", - "items": { - "$ref": "Breakpoint" - } - } - }, - "id": "ListBreakpointsResponse" - }, - "Breakpoint": { - "description": "Represents the breakpoint specification, status and results.", - "type": "object", - "properties": { - "stackFrames": { - "description": "The stack at breakpoint time.", - "type": "array", - "items": { - "$ref": "StackFrame" - } - }, - "condition": { - "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.", - "type": "string" - }, - "status": { - "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition", - "$ref": "StatusMessage" - }, - "userEmail": { - "description": "E-mail address of the user that created this breakpoint", - "type": "string" - }, - "action": { - "enumDescriptions": [ - "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.", - "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired." - ], - "enum": [ - "CAPTURE", - "LOG" - ], - "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.", - "type": "string" - }, - "logLevel": { - "enumDescriptions": [ - "Information log message.", - "Warning log message.", - "Error log message." - ], - "enum": [ - "INFO", - "WARNING", - "ERROR" - ], - "description": "Indicates the severity of the log. Only relevant when action is `LOG`.", - "type": "string" - }, - "id": { - "description": "Breakpoint identifier, unique in the scope of the debuggee.", - "type": "string" - }, - "location": { - "description": "Breakpoint source location.", - "$ref": "SourceLocation" - }, - "finalTime": { - "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.", - "format": "google-datetime", - "type": "string" - }, - "variableTable": { - "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.", - "type": "array", - "items": { - "$ref": "Variable" - } - }, - "logMessageFormat": { - "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" + "ownerName": "Google", + "resources": { + "debugger": { + "resources": { + "debuggees": { + "methods": { + "list": { + "path": "v2/debugger/debuggees", + "id": "clouddebugger.debugger.debuggees.list", + "description": "Lists all the debuggees that the user has access to.", + "response": { + "$ref": "ListDebuggeesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "includeInactive": { + "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.", + "type": "boolean", + "location": "query" + }, + "project": { + "location": "query", + "description": "Project number of a Google Cloud project whose debuggees to list.", + "type": "string" + }, + "clientVersion": { + "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "flatPath": "v2/debugger/debuggees" + } }, - "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.", - "type": "object" - }, - "createTime": { - "description": "Time this breakpoint was created by the server in seconds resolution.", - "format": "google-datetime", - "type": "string" - }, - "expressions": { - "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.", - "type": "array", - "items": { - "type": "string" + "resources": { + "breakpoints": { + "methods": { + "set": { + "response": { + "$ref": "SetBreakpointResponse" + }, + "parameterOrder": [ + "debuggeeId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "parameters": { + "debuggeeId": { + "description": "ID of the debuggee where the breakpoint is to be set.", + "required": true, + "type": "string", + "location": "path" + }, + "clientVersion": { + "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set", + "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set", + "id": "clouddebugger.debugger.debuggees.breakpoints.set", + "description": "Sets the breakpoint to the debuggee.", + "request": { + "$ref": "Breakpoint" + } + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "debuggeeId", + "breakpointId" + ], + "httpMethod": "DELETE", + "parameters": { + "clientVersion": { + "location": "query", + "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", + "type": "string" + }, + "breakpointId": { + "description": "ID of the breakpoint to delete.", + "required": true, + "type": "string", + "location": "path" + }, + "debuggeeId": { + "description": "ID of the debuggee whose breakpoint to delete.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", + "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", + "id": "clouddebugger.debugger.debuggees.breakpoints.delete", + "description": "Deletes the breakpoint from the debuggee." + }, + "get": { + "response": { + "$ref": "GetBreakpointResponse" + }, + "parameterOrder": [ + "debuggeeId", + "breakpointId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "parameters": { + "breakpointId": { + "location": "path", + "description": "ID of the breakpoint to get.", + "required": true, + "type": "string" + }, + "debuggeeId": { + "location": "path", + "description": "ID of the debuggee whose breakpoint to get.", + "required": true, + "type": "string" + }, + "clientVersion": { + "location": "query", + "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", + "type": "string" + } + }, + "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", + "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", + "id": "clouddebugger.debugger.debuggees.breakpoints.get", + "description": "Gets breakpoint information." + }, + "list": { + "response": { + "$ref": "ListBreakpointsResponse" + }, + "parameterOrder": [ + "debuggeeId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "parameters": { + "stripResults": { + "location": "query", + "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.", + "type": "boolean" + }, + "debuggeeId": { + "location": "path", + "description": "ID of the debuggee whose breakpoints to list.", + "required": true, + "type": "string" + }, + "waitToken": { + "location": "query", + "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.", + "type": "string" + }, + "clientVersion": { + "location": "query", + "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", + "type": "string" + }, + "action.value": { + "enum": [ + "CAPTURE", + "LOG" + ], + "description": "Only breakpoints with the specified action will pass the filter.", + "type": "string", + "location": "query" + }, + "includeInactive": { + "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.", + "type": "boolean", + "location": "query" + }, + "includeAllUsers": { + "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.", + "type": "boolean", + "location": "query" + } + }, + "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints", + "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints", + "id": "clouddebugger.debugger.debuggees.breakpoints.list", + "description": "Lists all breakpoints for the debuggee." + } + } + } } - }, - "evaluatedExpressions": { - "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text.", - "type": "array", - "items": { - "$ref": "Variable" + } + } + }, + "controller": { + "resources": { + "debuggees": { + "resources": { + "breakpoints": { + "methods": { + "update": { + "request": { + "$ref": "UpdateActiveBreakpointRequest" + }, + "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.", + "httpMethod": "PUT", + "parameterOrder": [ + "debuggeeId", + "id" + ], + "response": { + "$ref": "UpdateActiveBreakpointResponse" + }, + "parameters": { + "debuggeeId": { + "description": "Identifies the debuggee being debugged.", + "required": true, + "type": "string", + "location": "path" + }, + "id": { + "location": "path", + "description": "Breakpoint identifier, unique in the scope of the debuggee.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}", + "id": "clouddebugger.controller.debuggees.breakpoints.update", + "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}" + }, + "list": { + "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.", + "response": { + "$ref": "ListActiveBreakpointsResponse" + }, + "parameterOrder": [ + "debuggeeId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "parameters": { + "debuggeeId": { + "description": "Identifies the debuggee.", + "required": true, + "type": "string", + "location": "path" + }, + "successOnTimeout": { + "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.", + "type": "boolean", + "location": "query" + }, + "waitToken": { + "location": "query", + "description": "A token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server-selected timeout has\nexpired. The value should be set from the `next_wait_token` field in\nthe last response. The initial value should be set to `\"init\"`.", + "type": "string" + } + }, + "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints", + "path": "v2/controller/debuggees/{debuggeeId}/breakpoints", + "id": "clouddebugger.controller.debuggees.breakpoints.list" + } + } + } + }, + "methods": { + "register": { + "path": "v2/controller/debuggees/register", + "id": "clouddebugger.controller.debuggees.register", + "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.", + "request": { + "$ref": "RegisterDebuggeeRequest" + }, + "response": { + "$ref": "RegisterDebuggeeResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud_debugger" + ], + "parameters": {}, + "flatPath": "v2/controller/debuggees/register" + } } - }, - "isFinalState": { - "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.", - "type": "boolean" } - }, - "id": "Breakpoint" + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" }, - "UpdateActiveBreakpointRequest": { - "description": "Request to update an active breakpoint.", - "type": "object", - "properties": { - "breakpoint": { - "description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update.", - "$ref": "Breakpoint" - } - }, - "id": "UpdateActiveBreakpointRequest" + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" }, - "SetBreakpointResponse": { - "description": "Response for setting a breakpoint.", - "type": "object", - "properties": { - "breakpoint": { - "$ref": "Breakpoint", - "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)." - } - }, - "id": "SetBreakpointResponse" + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" }, - "SourceContext": { - "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.", - "type": "object", - "properties": { - "git": { - "$ref": "GitSourceContext", - "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)." - }, - "gerrit": { - "$ref": "GerritSourceContext", - "description": "A SourceContext referring to a Gerrit project." - }, - "cloudRepo": { - "$ref": "CloudRepoSourceContext", - "description": "A SourceContext referring to a revision in a cloud repo." - }, - "cloudWorkspace": { - "$ref": "CloudWorkspaceSourceContext", - "description": "A SourceContext referring to a snapshot in a cloud workspace." - } - }, - "id": "SourceContext" + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" }, - "CloudRepoSourceContext": { - "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", - "type": "object", - "properties": { - "revisionId": { - "description": "A revision ID.", - "type": "string" - }, - "aliasName": { - "description": "The name of an alias (branch, tag, etc.).", - "type": "string" - }, - "repoId": { - "description": "The ID of the repo.", - "$ref": "RepoId" - }, - "aliasContext": { - "$ref": "AliasContext", - "description": "An alias, which may be a branch or tag." - } - }, - "id": "CloudRepoSourceContext" + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" }, - "RegisterDebuggeeResponse": { - "description": "Response for registering a debuggee.", - "type": "object", - "properties": { - "debuggee": { - "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled.", - "$ref": "Debuggee" - } - }, - "id": "RegisterDebuggeeResponse" + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" }, - "RegisterDebuggeeRequest": { - "description": "Request to register a debuggee.", - "type": "object", - "properties": { - "debuggee": { - "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set.", - "$ref": "Debuggee" - } - }, - "id": "RegisterDebuggeeRequest" + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" }, - "GetBreakpointResponse": { - "description": "Response for getting breakpoint information.", - "type": "object", - "properties": { - "breakpoint": { - "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set.", - "$ref": "Breakpoint" - } - }, - "id": "GetBreakpointResponse" + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" }, - "StatusMessage": { - "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.", - "type": "object", - "properties": { - "isError": { - "description": "Distinguishes errors from informational messages.", - "type": "boolean" - }, - "description": { - "$ref": "FormatMessage", - "description": "Status message text." - }, - "refersTo": { - "enumDescriptions": [ - "Status doesn't refer to any particular input.", - "Status applies to the breakpoint and is related to its location.", - "Status applies to the breakpoint and is related to its condition.", - "Status applies to the breakpoint and is related to its expressions.", - "Status applies to the breakpoint and is related to its age.", - "Status applies to the entire variable.", - "Status applies to variable value (variable name is valid)." - ], - "enum": [ - "UNSPECIFIED", - "BREAKPOINT_SOURCE_LOCATION", - "BREAKPOINT_CONDITION", - "BREAKPOINT_EXPRESSION", - "BREAKPOINT_AGE", - "VARIABLE_NAME", - "VARIABLE_VALUE" - ], - "description": "Reference to which the message applies.", - "type": "string" - } - }, - "id": "StatusMessage" + "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.", + "type": "string", + "location": "query" }, - "GitSourceContext": { - "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).", - "type": "object", - "properties": { - "revisionId": { - "description": "Git commit hash.\nrequired.", - "type": "string" - }, - "url": { - "description": "Git repository URL.", - "type": "string" - } - }, - "id": "GitSourceContext" + "quotaUser": { + "location": "query", + "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.", + "type": "string" }, - "Variable": { - "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.", - "type": "object", - "properties": { - "type": { - "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.", - "type": "string" - }, - "varTableIndex": { - "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.", - "format": "int32", - "type": "integer" - }, - "value": { - "description": "Simple value of the variable.", - "type": "string" - }, - "members": { - "description": "Members contained or pointed to by the variable.", - "type": "array", - "items": { - "$ref": "Variable" - } - }, - "status": { - "$ref": "StatusMessage", - "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`" - }, - "name": { - "description": "Name of the variable, if any.", - "type": "string" - } - }, - "id": "Variable" + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" }, - "StackFrame": { - "description": "Represents a stack frame context.", - "type": "object", - "properties": { - "arguments": { - "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.", - "type": "array", - "items": { - "$ref": "Variable" - } - }, - "locals": { - "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.", - "type": "array", - "items": { - "$ref": "Variable" - } - }, - "location": { - "description": "Source location of the call site.", - "$ref": "SourceLocation" - }, - "function": { - "description": "Demangled function name at the call site.", - "type": "string" - } - }, - "id": "StackFrame" + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" }, - "RepoId": { - "description": "A unique identifier for a cloud repo.", - "type": "object", - "properties": { - "projectRepoId": { - "description": "A combination of a project ID and a repo name.", - "$ref": "ProjectRepoId" - }, - "uid": { - "description": "A server-assigned, globally unique identifier.", - "type": "string" - } - }, - "id": "RepoId" - }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + } + }, + "version": "v2", + "baseUrl": "https://clouddebugger.googleapis.com/", + "servicePath": "", + "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n", + "kind": "discovery#restDescription", + "basePath": "", + "revision": "20180102", + "documentationLink": "http://cloud.google.com/debugger", + "id": "clouddebugger:v2", + "discoveryVersion": "v1", + "version_module": true, + "schemas": { "FormatMessage": { "description": "Represents a message with parameters.", "type": "object", @@ -493,8 +454,6 @@ "id": "ExtendedSourceContext" }, "ListDebuggeesResponse": { - "description": "Response for listing debuggees.", - "type": "object", "properties": { "debuggees": { "description": "List of debuggees accessible to the calling user.\nThe fields `debuggee.id` and `description` are guaranteed to be set.\nThe `description` field is a human readable field provided by agents and\ncan be displayed to users.", @@ -504,12 +463,18 @@ } } }, - "id": "ListDebuggeesResponse" + "id": "ListDebuggeesResponse", + "description": "Response for listing debuggees.", + "type": "object" }, "AliasContext": { "description": "An alias to a repo revision.", "type": "object", "properties": { + "name": { + "description": "The alias name.", + "type": "string" + }, "kind": { "enumDescriptions": [ "Do not use.", @@ -525,10 +490,6 @@ ], "description": "The alias kind.", "type": "string" - }, - "name": { - "description": "The alias name.", - "type": "string" } }, "id": "AliasContext" @@ -540,25 +501,37 @@ "id": "Empty" }, "SourceLocation": { - "description": "Represents a location in the source code.", - "type": "object", "properties": { + "path": { + "description": "Path to the source file within the source context of the target binary.", + "type": "string" + }, "line": { "description": "Line inside the file. The first line in the file has the value `1`.", "format": "int32", "type": "integer" - }, - "path": { - "description": "Path to the source file within the source context of the target binary.", - "type": "string" } }, - "id": "SourceLocation" + "id": "SourceLocation", + "description": "Represents a location in the source code.", + "type": "object" }, "Debuggee": { "description": "Represents the debugged application. The application may include one or more\nreplicated processes executing the same code. Each of these processes is\nattached with a debugger agent, carrying out the debugging commands.\nAgents attached to the same debuggee identify themselves as such by using\nexactly the same Debuggee message value when registering.", "type": "object", "properties": { + "isDisabled": { + "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.", + "type": "boolean" + }, + "agentVersion": { + "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).", + "type": "string" + }, + "id": { + "description": "Unique identifier for the debuggee generated by the controller service.", + "type": "string" + }, "description": { "description": "Human readable description of the debuggee.\nIncluding a human-readable project name, environment name and version\ninformation is recommended.", "type": "string" @@ -582,38 +555,482 @@ } }, "labels": { - "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.", - "type": "object", "additionalProperties": { "type": "string" - } - }, - "status": { - "$ref": "StatusMessage", - "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status." + }, + "description": "A set of custom debuggee properties, populated by the agent, to be\ndisplayed to the user.", + "type": "object" }, "isInactive": { "description": "If set to `true`, indicates that Controller service does not detect any\nactivity from the debuggee agents and the application is possibly stopped.", "type": "boolean" }, + "status": { + "$ref": "StatusMessage", + "description": "Human readable message to be displayed to the user about this debuggee.\nAbsence of this field indicates no status. The message can be either\ninformational or an error status." + }, "project": { "description": "Project the debuggee is associated with.\nUse project number or id when registering a Google Cloud Platform project.", "type": "string" - }, - "id": { - "description": "Unique identifier for the debuggee generated by the controller service.", - "type": "string" - }, - "agentVersion": { - "description": "Version ID of the agent.\nSchema: `domain/language-platform/vmajor.minor` (for example\n`google.com/java-gcp/v1.1`).", - "type": "string" - }, - "isDisabled": { - "description": "If set to `true`, indicates that the agent should disable itself and\ndetach from the debuggee.", - "type": "boolean" } }, "id": "Debuggee" + }, + "ListActiveBreakpointsResponse": { + "properties": { + "breakpoints": { + "description": "List of all active breakpoints.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.", + "type": "array", + "items": { + "$ref": "Breakpoint" + } + }, + "waitExpired": { + "description": "If set to `true`, indicates that there is no change to the\nlist of active breakpoints and the server-selected timeout has expired.\nThe `breakpoints` field would be empty and should be ignored.", + "type": "boolean" + }, + "nextWaitToken": { + "description": "A token that can be used in the next method call to block until\nthe list of breakpoints changes.", + "type": "string" + } + }, + "id": "ListActiveBreakpointsResponse", + "description": "Response for listing active breakpoints.", + "type": "object" + }, + "ProjectRepoId": { + "properties": { + "projectId": { + "description": "The ID of the project.", + "type": "string" + }, + "repoName": { + "description": "The name of the repo. Leave empty for the default repo.", + "type": "string" + } + }, + "id": "ProjectRepoId", + "description": "Selects a repo using a Google Cloud Platform project ID\n(e.g. winged-cargo-31) and a repo name within that project.", + "type": "object" + }, + "CloudWorkspaceSourceContext": { + "description": "A CloudWorkspaceSourceContext denotes a workspace at a particular snapshot.", + "type": "object", + "properties": { + "snapshotId": { + "description": "The ID of the snapshot.\nAn empty snapshot_id refers to the most recent snapshot.", + "type": "string" + }, + "workspaceId": { + "$ref": "CloudWorkspaceId", + "description": "The ID of the workspace." + } + }, + "id": "CloudWorkspaceSourceContext" + }, + "UpdateActiveBreakpointResponse": { + "properties": {}, + "id": "UpdateActiveBreakpointResponse", + "description": "Response for updating an active breakpoint.\nThe message is defined to allow future extensions.", + "type": "object" + }, + "GerritSourceContext": { + "description": "A SourceContext referring to a Gerrit project.", + "type": "object", + "properties": { + "gerritProject": { + "description": "The full project name within the host. Projects may be nested, so\n\"project/subproject\" is a valid project name.\nThe \"repo name\" is hostURI/project.", + "type": "string" + }, + "aliasContext": { + "description": "An alias, which may be a branch or tag.", + "$ref": "AliasContext" + }, + "hostUri": { + "description": "The URI of a running Gerrit instance.", + "type": "string" + }, + "revisionId": { + "description": "A revision (commit) ID.", + "type": "string" + }, + "aliasName": { + "description": "The name of an alias (branch, tag, etc.).", + "type": "string" + } + }, + "id": "GerritSourceContext" + }, + "CloudWorkspaceId": { + "properties": { + "repoId": { + "description": "The ID of the repo containing the workspace.", + "$ref": "RepoId" + }, + "name": { + "description": "The unique name of the workspace within the repo. This is the name\nchosen by the client in the Source API's CreateWorkspace method.", + "type": "string" + } + }, + "id": "CloudWorkspaceId", + "description": "A CloudWorkspaceId is a unique identifier for a cloud workspace.\nA cloud workspace is a place associated with a repo where modified files\ncan be stored before they are committed.", + "type": "object" + }, + "ListBreakpointsResponse": { + "properties": { + "breakpoints": { + "description": "List of breakpoints matching the request.\nThe fields `id` and `location` are guaranteed to be set on each breakpoint.\nThe fields: `stack_frames`, `evaluated_expressions` and `variable_table`\nare cleared on each breakpoint regardless of its status.", + "type": "array", + "items": { + "$ref": "Breakpoint" + } + }, + "nextWaitToken": { + "description": "A wait token that can be used in the next call to `list` (REST) or\n`ListBreakpoints` (RPC) to block until the list of breakpoints has changes.", + "type": "string" + } + }, + "id": "ListBreakpointsResponse", + "description": "Response for listing breakpoints.", + "type": "object" + }, + "Breakpoint": { + "properties": { + "userEmail": { + "description": "E-mail address of the user that created this breakpoint", + "type": "string" + }, + "action": { + "enumDescriptions": [ + "Capture stack frame and variables and update the breakpoint.\nThe data is only captured once. After that the breakpoint is set\nin a final state.", + "Log each breakpoint hit. The breakpoint remains active until\ndeleted or expired." + ], + "enum": [ + "CAPTURE", + "LOG" + ], + "description": "Action that the agent should perform when the code at the\nbreakpoint location is hit.", + "type": "string" + }, + "logLevel": { + "enumDescriptions": [ + "Information log message.", + "Warning log message.", + "Error log message." + ], + "enum": [ + "INFO", + "WARNING", + "ERROR" + ], + "description": "Indicates the severity of the log. Only relevant when action is `LOG`.", + "type": "string" + }, + "id": { + "description": "Breakpoint identifier, unique in the scope of the debuggee.", + "type": "string" + }, + "location": { + "$ref": "SourceLocation", + "description": "Breakpoint source location." + }, + "finalTime": { + "description": "Time this breakpoint was finalized as seen by the server in seconds\nresolution.", + "format": "google-datetime", + "type": "string" + }, + "variableTable": { + "description": "The `variable_table` exists to aid with computation, memory and network\ntraffic optimization. It enables storing a variable once and reference\nit from multiple variables, including variables stored in the\n`variable_table` itself.\nFor example, the same `this` object, which may appear at many levels of\nthe stack, can have all of its data stored once in this table. The\nstack frame variables then would hold only a reference to it.\n\nThe variable `var_table_index` field is an index into this repeated field.\nThe stored objects are nameless and get their name from the referencing\nvariable. The effective variable is a merge of the referencing variable\nand the referenced variable.", + "type": "array", + "items": { + "$ref": "Variable" + } + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "A set of custom breakpoint properties, populated by the agent, to be\ndisplayed to the user.", + "type": "object" + }, + "logMessageFormat": { + "description": "Only relevant when action is `LOG`. Defines the message to log when\nthe breakpoint hits. The message may include parameter placeholders `$0`,\n`$1`, etc. These placeholders are replaced with the evaluated value\nof the appropriate expression. Expressions not referenced in\n`log_message_format` are not logged.\n\nExample: `Message received, id = $0, count = $1` with\n`expressions` = `[ message.id, message.count ]`.", + "type": "string" + }, + "createTime": { + "description": "Time this breakpoint was created by the server in seconds resolution.", + "format": "google-datetime", + "type": "string" + }, + "expressions": { + "description": "List of read-only expressions to evaluate at the breakpoint location.\nThe expressions are composed using expressions in the programming language\nat the source location. If the breakpoint action is `LOG`, the evaluated\nexpressions are included in log statements.", + "type": "array", + "items": { + "type": "string" + } + }, + "evaluatedExpressions": { + "description": "Values of evaluated expressions at breakpoint time.\nThe evaluated expressions appear in exactly the same order they\nare listed in the `expressions` field.\nThe `name` field holds the original expression text, the `value` or\n`members` field holds the result of the evaluated expression.\nIf the expression cannot be evaluated, the `status` inside the `Variable`\nwill indicate an error and contain the error text.", + "type": "array", + "items": { + "$ref": "Variable" + } + }, + "isFinalState": { + "description": "When true, indicates that this is a final result and the\nbreakpoint state will not change from here on.", + "type": "boolean" + }, + "stackFrames": { + "description": "The stack at breakpoint time.", + "type": "array", + "items": { + "$ref": "StackFrame" + } + }, + "condition": { + "description": "Condition that triggers the breakpoint.\nThe condition is a compound boolean expression composed using expressions\nin a programming language at the source location.", + "type": "string" + }, + "status": { + "description": "Breakpoint status.\n\nThe status includes an error flag and a human readable message.\nThis field is usually unset. The message can be either\ninformational or an error message. Regardless, clients should always\ndisplay the text message back to the user.\n\nError status indicates complete failure of the breakpoint.\n\nExample (non-final state): `Still loading symbols...`\n\nExamples (final state):\n\n* `Invalid line number` referring to location\n* `Field f not found in class C` referring to condition", + "$ref": "StatusMessage" + } + }, + "id": "Breakpoint", + "description": "Represents the breakpoint specification, status and results.", + "type": "object" + }, + "UpdateActiveBreakpointRequest": { + "properties": { + "breakpoint": { + "description": "Updated breakpoint information.\nThe field `id` must be set.\nThe agent must echo all Breakpoint specification fields in the update.", + "$ref": "Breakpoint" + } + }, + "id": "UpdateActiveBreakpointRequest", + "description": "Request to update an active breakpoint.", + "type": "object" + }, + "SetBreakpointResponse": { + "description": "Response for setting a breakpoint.", + "type": "object", + "properties": { + "breakpoint": { + "$ref": "Breakpoint", + "description": "Breakpoint resource.\nThe field `id` is guaranteed to be set (in addition to the echoed fileds)." + } + }, + "id": "SetBreakpointResponse" + }, + "SourceContext": { + "description": "A SourceContext is a reference to a tree of files. A SourceContext together\nwith a path point to a unique revision of a single file or directory.", + "type": "object", + "properties": { + "gerrit": { + "$ref": "GerritSourceContext", + "description": "A SourceContext referring to a Gerrit project." + }, + "cloudRepo": { + "$ref": "CloudRepoSourceContext", + "description": "A SourceContext referring to a revision in a cloud repo." + }, + "cloudWorkspace": { + "description": "A SourceContext referring to a snapshot in a cloud workspace.", + "$ref": "CloudWorkspaceSourceContext" + }, + "git": { + "$ref": "GitSourceContext", + "description": "A SourceContext referring to any third party Git repo (e.g. GitHub)." + } + }, + "id": "SourceContext" + }, + "CloudRepoSourceContext": { + "properties": { + "revisionId": { + "description": "A revision ID.", + "type": "string" + }, + "aliasName": { + "description": "The name of an alias (branch, tag, etc.).", + "type": "string" + }, + "repoId": { + "$ref": "RepoId", + "description": "The ID of the repo." + }, + "aliasContext": { + "$ref": "AliasContext", + "description": "An alias, which may be a branch or tag." + } + }, + "id": "CloudRepoSourceContext", + "description": "A CloudRepoSourceContext denotes a particular revision in a cloud\nrepo (a repo hosted by the Google Cloud Platform).", + "type": "object" + }, + "RegisterDebuggeeResponse": { + "properties": { + "debuggee": { + "$ref": "Debuggee", + "description": "Debuggee resource.\nThe field `id` is guranteed to be set (in addition to the echoed fields).\nIf the field `is_disabled` is set to `true`, the agent should disable\nitself by removing all breakpoints and detaching from the application.\nIt should however continue to poll `RegisterDebuggee` until reenabled." + } + }, + "id": "RegisterDebuggeeResponse", + "description": "Response for registering a debuggee.", + "type": "object" + }, + "RegisterDebuggeeRequest": { + "description": "Request to register a debuggee.", + "type": "object", + "properties": { + "debuggee": { + "$ref": "Debuggee", + "description": "Debuggee information to register.\nThe fields `project`, `uniquifier`, `description` and `agent_version`\nof the debuggee must be set." + } + }, + "id": "RegisterDebuggeeRequest" + }, + "GetBreakpointResponse": { + "description": "Response for getting breakpoint information.", + "type": "object", + "properties": { + "breakpoint": { + "$ref": "Breakpoint", + "description": "Complete breakpoint state.\nThe fields `id` and `location` are guaranteed to be set." + } + }, + "id": "GetBreakpointResponse" + }, + "StatusMessage": { + "description": "Represents a contextual status message.\nThe message can indicate an error or informational status, and refer to\nspecific parts of the containing object.\nFor example, the `Breakpoint.status` field can indicate an error referring\nto the `BREAKPOINT_SOURCE_LOCATION` with the message `Location not found`.", + "type": "object", + "properties": { + "isError": { + "description": "Distinguishes errors from informational messages.", + "type": "boolean" + }, + "description": { + "$ref": "FormatMessage", + "description": "Status message text." + }, + "refersTo": { + "enum": [ + "UNSPECIFIED", + "BREAKPOINT_SOURCE_LOCATION", + "BREAKPOINT_CONDITION", + "BREAKPOINT_EXPRESSION", + "BREAKPOINT_AGE", + "VARIABLE_NAME", + "VARIABLE_VALUE" + ], + "description": "Reference to which the message applies.", + "type": "string", + "enumDescriptions": [ + "Status doesn't refer to any particular input.", + "Status applies to the breakpoint and is related to its location.", + "Status applies to the breakpoint and is related to its condition.", + "Status applies to the breakpoint and is related to its expressions.", + "Status applies to the breakpoint and is related to its age.", + "Status applies to the entire variable.", + "Status applies to variable value (variable name is valid)." + ] + } + }, + "id": "StatusMessage" + }, + "GitSourceContext": { + "description": "A GitSourceContext denotes a particular revision in a third party Git\nrepository (e.g. GitHub).", + "type": "object", + "properties": { + "revisionId": { + "description": "Git commit hash.\nrequired.", + "type": "string" + }, + "url": { + "description": "Git repository URL.", + "type": "string" + } + }, + "id": "GitSourceContext" + }, + "Variable": { + "properties": { + "name": { + "description": "Name of the variable, if any.", + "type": "string" + }, + "type": { + "description": "Variable type (e.g. `MyClass`). If the variable is split with\n`var_table_index`, `type` goes next to `value`. The interpretation of\na type is agent specific. It is recommended to include the dynamic type\nrather than a static type of an object.", + "type": "string" + }, + "varTableIndex": { + "description": "Reference to a variable in the shared variable table. More than\none variable can reference the same variable in the table. The\n`var_table_index` field is an index into `variable_table` in Breakpoint.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "Simple value of the variable.", + "type": "string" + }, + "members": { + "description": "Members contained or pointed to by the variable.", + "type": "array", + "items": { + "$ref": "Variable" + } + }, + "status": { + "description": "Status associated with the variable. This field will usually stay\nunset. A status of a single variable only applies to that variable or\nexpression. The rest of breakpoint data still remains valid. Variables\nmight be reported in error state even when breakpoint is not in final\nstate.\n\nThe message may refer to variable name with `refers_to` set to\n`VARIABLE_NAME`. Alternatively `refers_to` will be set to `VARIABLE_VALUE`.\nIn either case variable value and members will be unset.\n\nExample of error message applied to name: `Invalid expression syntax`.\n\nExample of information message applied to value: `Not captured`.\n\nExamples of error message applied to value:\n\n* `Malformed string`,\n* `Field f not found in class C`\n* `Null pointer dereference`", + "$ref": "StatusMessage" + } + }, + "id": "Variable", + "description": "Represents a variable or an argument possibly of a compound object type.\nNote how the following variables are represented:\n\n1) A simple variable:\n\n int x = 5\n\n { name: \"x\", value: \"5\", type: \"int\" } // Captured variable\n\n2) A compound object:\n\n struct T {\n int m1;\n int m2;\n };\n T x = { 3, 7 };\n\n { // Captured variable\n name: \"x\",\n type: \"T\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n3) A pointer where the pointee was captured:\n\n T x = { 3, 7 };\n T* p = &x;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00500500\",\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\n4) A pointer where the pointee was not captured:\n\n T* p = new T;\n\n { // Captured variable\n name: \"p\",\n type: \"T*\",\n value: \"0x00400400\"\n status { is_error: true, description { format: \"unavailable\" } }\n }\n\nThe status should describe the reason for the missing value,\nsuch as `\u003coptimized out\u003e`, `\u003cinaccessible\u003e`, `\u003cpointers limit reached\u003e`.\n\nNote that a null pointer should not have members.\n\n5) An unnamed value:\n\n int* p = new int(7);\n\n { // Captured variable\n name: \"p\",\n value: \"0x00500500\",\n type: \"int*\",\n members { value: \"7\", type: \"int\" } }\n\n6) An unnamed pointer where the pointee was not captured:\n\n int* p = new int(7);\n int** pp = &p;\n\n { // Captured variable\n name: \"pp\",\n value: \"0x00500500\",\n type: \"int**\",\n members {\n value: \"0x00400400\",\n type: \"int*\"\n status {\n is_error: true,\n description: { format: \"unavailable\" } }\n }\n }\n }\n\nTo optimize computation, memory and network traffic, variables that\nrepeat in the output multiple times can be stored once in a shared\nvariable table and be referenced using the `var_table_index` field. The\nvariables stored in the shared table are nameless and are essentially\na partition of the complete variable. To reconstruct the complete\nvariable, merge the referencing variable with the referenced variable.\n\nWhen using the shared variable table, the following variables:\n\n T x = { 3, 7 };\n T* p = &x;\n T& r = x;\n\n { name: \"x\", var_table_index: 3, type: \"T\" } // Captured variables\n { name: \"p\", value \"0x00500500\", type=\"T*\", var_table_index: 3 }\n { name: \"r\", type=\"T&\", var_table_index: 3 }\n\n { // Shared variable table entry #3:\n members { name: \"m1\", value: \"3\", type: \"int\" },\n members { name: \"m2\", value: \"7\", type: \"int\" }\n }\n\nNote that the pointer address is stored with the referencing variable\nand not with the referenced variable. This allows the referenced variable\nto be shared between pointers and references.\n\nThe type field is optional. The debugger agent may or may not support it.", + "type": "object" + }, + "StackFrame": { + "properties": { + "arguments": { + "description": "Set of arguments passed to this function.\nNote that this might not be populated for all stack frames.", + "type": "array", + "items": { + "$ref": "Variable" + } + }, + "locals": { + "description": "Set of local variables at the stack frame location.\nNote that this might not be populated for all stack frames.", + "type": "array", + "items": { + "$ref": "Variable" + } + }, + "location": { + "description": "Source location of the call site.", + "$ref": "SourceLocation" + }, + "function": { + "description": "Demangled function name at the call site.", + "type": "string" + } + }, + "id": "StackFrame", + "description": "Represents a stack frame context.", + "type": "object" + }, + "RepoId": { + "description": "A unique identifier for a cloud repo.", + "type": "object", + "properties": { + "uid": { + "description": "A server-assigned, globally unique identifier.", + "type": "string" + }, + "projectRepoId": { + "description": "A combination of a project ID and a repo name.", + "$ref": "ProjectRepoId" + } + }, + "id": "RepoId" } }, "icons": { @@ -625,11 +1042,11 @@ "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud_debugger": { - "description": "Manage cloud debugger" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud_debugger": { + "description": "Manage cloud debugger" } } } @@ -638,422 +1055,5 @@ "ownerDomain": "google.com", "name": "clouddebugger", "batchPath": "batch", - "title": "Stackdriver Debugger API", - "ownerName": "Google", - "resources": { - "controller": { - "resources": { - "debuggees": { - "methods": { - "register": { - "request": { - "$ref": "RegisterDebuggeeRequest" - }, - "description": "Registers the debuggee with the controller service.\n\nAll agents attached to the same application must call this method with\nexactly the same request content to get back the same stable `debuggee_id`.\nAgents should call this method again whenever `google.rpc.Code.NOT_FOUND`\nis returned from any controller method.\n\nThis protocol allows the controller service to disable debuggees, recover\nfrom data loss, or change the `debuggee_id` format. Agents must handle\n`debuggee_id` value changing upon re-registration.", - "response": { - "$ref": "RegisterDebuggeeResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "flatPath": "v2/controller/debuggees/register", - "path": "v2/controller/debuggees/register", - "id": "clouddebugger.controller.debuggees.register" - } - }, - "resources": { - "breakpoints": { - "methods": { - "list": { - "description": "Returns the list of all active breakpoints for the debuggee.\n\nThe breakpoint specification (`location`, `condition`, and `expressions`\nfields) is semantically immutable, although the field values may\nchange. For example, an agent may update the location line number\nto reflect the actual line where the breakpoint was set, but this\ndoesn't change the breakpoint semantics.\n\nThis means that an agent does not need to check if a breakpoint has changed\nwhen it encounters the same breakpoint on a successive call.\nMoreover, an agent should remember the breakpoints that are completed\nuntil the controller removes them from the active list to avoid\nsetting those breakpoints again.", - "response": { - "$ref": "ListActiveBreakpointsResponse" - }, - "parameterOrder": [ - "debuggeeId" - ], - "httpMethod": "GET", - "parameters": { - "debuggeeId": { - "description": "Identifies the debuggee.", - "required": true, - "type": "string", - "location": "path" - }, - "successOnTimeout": { - "description": "If set to `true` (recommended), returns `google.rpc.Code.OK` status and\nsets the `wait_expired` response field to `true` when the server-selected\ntimeout has expired.\n\nIf set to `false` (deprecated), returns `google.rpc.Code.ABORTED` status\nwhen the server-selected timeout has expired.", - "type": "boolean", - "location": "query" - }, - "waitToken": { - "location": "query", - "description": "A token that, if specified, blocks the method call until the list\nof active breakpoints has changed, or a server-selected timeout has\nexpired. The value should be set from the `next_wait_token` field in\nthe last response. The initial value should be set to `\"init\"`.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints", - "path": "v2/controller/debuggees/{debuggeeId}/breakpoints", - "id": "clouddebugger.controller.debuggees.breakpoints.list" - }, - "update": { - "description": "Updates the breakpoint state or mutable fields.\nThe entire Breakpoint message must be sent back to the controller service.\n\nUpdates to active breakpoint fields are only allowed if the new value\ndoes not change the breakpoint specification. Updates to the `location`,\n`condition` and `expressions` fields should not alter the breakpoint\nsemantics. These may only make changes such as canonicalizing a value\nor snapping the location to the correct line of code.", - "request": { - "$ref": "UpdateActiveBreakpointRequest" - }, - "response": { - "$ref": "UpdateActiveBreakpointResponse" - }, - "parameterOrder": [ - "debuggeeId", - "id" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "parameters": { - "debuggeeId": { - "location": "path", - "description": "Identifies the debuggee being debugged.", - "required": true, - "type": "string" - }, - "id": { - "description": "Breakpoint identifier, unique in the scope of the debuggee.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}", - "path": "v2/controller/debuggees/{debuggeeId}/breakpoints/{id}", - "id": "clouddebugger.controller.debuggees.breakpoints.update" - } - } - } - } - } - } - }, - "debugger": { - "resources": { - "debuggees": { - "methods": { - "list": { - "description": "Lists all the debuggees that the user has access to.", - "response": { - "$ref": "ListDebuggeesResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": { - "project": { - "location": "query", - "description": "Project number of a Google Cloud project whose debuggees to list.", - "type": "string" - }, - "clientVersion": { - "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", - "type": "string", - "location": "query" - }, - "includeInactive": { - "description": "When set to `true`, the result includes all debuggees. Otherwise, the\nresult includes only debuggees that are active.", - "type": "boolean", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "flatPath": "v2/debugger/debuggees", - "path": "v2/debugger/debuggees", - "id": "clouddebugger.debugger.debuggees.list" - } - }, - "resources": { - "breakpoints": { - "methods": { - "get": { - "description": "Gets breakpoint information.", - "httpMethod": "GET", - "parameterOrder": [ - "debuggeeId", - "breakpointId" - ], - "response": { - "$ref": "GetBreakpointResponse" - }, - "parameters": { - "debuggeeId": { - "description": "ID of the debuggee whose breakpoint to get.", - "required": true, - "type": "string", - "location": "path" - }, - "clientVersion": { - "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", - "type": "string", - "location": "query" - }, - "breakpointId": { - "description": "ID of the breakpoint to get.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", - "id": "clouddebugger.debugger.debuggees.breakpoints.get", - "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}" - }, - "list": { - "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints", - "id": "clouddebugger.debugger.debuggees.breakpoints.list", - "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints", - "description": "Lists all breakpoints for the debuggee.", - "httpMethod": "GET", - "parameterOrder": [ - "debuggeeId" - ], - "response": { - "$ref": "ListBreakpointsResponse" - }, - "parameters": { - "stripResults": { - "location": "query", - "description": "This field is deprecated. The following fields are always stripped out of\nthe result: `stack_frames`, `evaluated_expressions` and `variable_table`.", - "type": "boolean" - }, - "debuggeeId": { - "description": "ID of the debuggee whose breakpoints to list.", - "required": true, - "type": "string", - "location": "path" - }, - "waitToken": { - "description": "A wait token that, if specified, blocks the call until the breakpoints\nlist has changed, or a server selected timeout has expired. The value\nshould be set from the last response. The error code\n`google.rpc.Code.ABORTED` (RPC) is returned on wait timeout, which\nshould be called again with the same `wait_token`.", - "type": "string", - "location": "query" - }, - "clientVersion": { - "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", - "type": "string", - "location": "query" - }, - "action.value": { - "location": "query", - "enum": [ - "CAPTURE", - "LOG" - ], - "description": "Only breakpoints with the specified action will pass the filter.", - "type": "string" - }, - "includeInactive": { - "description": "When set to `true`, the response includes active and inactive\nbreakpoints. Otherwise, it includes only active breakpoints.", - "type": "boolean", - "location": "query" - }, - "includeAllUsers": { - "location": "query", - "description": "When set to `true`, the response includes the list of breakpoints set by\nany user. Otherwise, it includes only breakpoints set by the caller.", - "type": "boolean" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ] - }, - "set": { - "request": { - "$ref": "Breakpoint" - }, - "description": "Sets the breakpoint to the debuggee.", - "response": { - "$ref": "SetBreakpointResponse" - }, - "parameterOrder": [ - "debuggeeId" - ], - "httpMethod": "POST", - "parameters": { - "clientVersion": { - "location": "query", - "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", - "type": "string" - }, - "debuggeeId": { - "description": "ID of the debuggee where the breakpoint is to be set.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set", - "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/set", - "id": "clouddebugger.debugger.debuggees.breakpoints.set" - }, - "delete": { - "description": "Deletes the breakpoint from the debuggee.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "debuggeeId", - "breakpointId" - ], - "httpMethod": "DELETE", - "parameters": { - "clientVersion": { - "description": "The client version making the call.\nSchema: `domain/type/version` (e.g., `google.com/intellij/v1`).", - "type": "string", - "location": "query" - }, - "breakpointId": { - "location": "path", - "description": "ID of the breakpoint to delete.", - "required": true, - "type": "string" - }, - "debuggeeId": { - "description": "ID of the debuggee whose breakpoint to delete.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud_debugger" - ], - "flatPath": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", - "path": "v2/debugger/debuggees/{debuggeeId}/breakpoints/{breakpointId}", - "id": "clouddebugger.debugger.debuggees.breakpoints.delete" - } - } - } - } - } - } - } - }, - "parameters": { - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - } - }, - "version": "v2", - "baseUrl": "https://clouddebugger.googleapis.com/", - "servicePath": "", - "description": "Examines the call stack and variables of a running application without stopping or slowing it down.\n", - "kind": "discovery#restDescription", - "basePath": "", - "id": "clouddebugger:v2", - "documentationLink": "http://cloud.google.com/debugger", - "revision": "20180102", - "discoveryVersion": "v1", - "version_module": true + "title": "Stackdriver Debugger API" }
diff --git a/clouderrorreporting/v1beta1/clouderrorreporting-api.json b/clouderrorreporting/v1beta1/clouderrorreporting-api.json index 1bffe74..e81c078 100644 --- a/clouderrorreporting/v1beta1/clouderrorreporting-api.json +++ b/clouderrorreporting/v1beta1/clouderrorreporting-api.json
@@ -1,25 +1,93 @@ { - "version": "v1beta1", - "baseUrl": "https://clouderrorreporting.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n", - "servicePath": "", - "basePath": "", - "revision": "20171215", - "documentationLink": "https://cloud.google.com/error-reporting/", - "id": "clouderrorreporting:v1beta1", "discoveryVersion": "v1", "version_module": true, "schemas": { + "ReportErrorEventResponse": { + "description": "Response for reporting an individual error event.\nData may be added to this message in the future.", + "type": "object", + "properties": {}, + "id": "ReportErrorEventResponse" + }, + "HttpRequestContext": { + "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.", + "type": "object", + "properties": { + "referrer": { + "description": "The referrer information that is provided with the request.", + "type": "string" + }, + "userAgent": { + "description": "The user agent information that is provided with the request.", + "type": "string" + }, + "url": { + "description": "The URL of the request.", + "type": "string" + }, + "responseStatusCode": { + "description": "The HTTP response status code for the request.", + "format": "int32", + "type": "integer" + }, + "method": { + "description": "The type of HTTP request, such as `GET`, `POST`, etc.", + "type": "string" + }, + "remoteIp": { + "description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.", + "type": "string" + } + }, + "id": "HttpRequestContext" + }, + "ListGroupStatsResponse": { + "type": "object", + "properties": { + "nextPageToken": { + "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.", + "type": "string" + }, + "timeRangeBegin": { + "description": "The timestamp specifies the start time to which the request was restricted.\nThe start time is set based on the requested time range. It may be adjusted\nto a later time if a project has exceeded the storage quota and older data\nhas been deleted.", + "format": "google-datetime", + "type": "string" + }, + "errorGroupStats": { + "description": "The error group stats which match the given request.", + "type": "array", + "items": { + "$ref": "ErrorGroupStats" + } + } + }, + "id": "ListGroupStatsResponse", + "description": "Contains a set of requested error group stats." + }, + "SourceReference": { + "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.", + "type": "object", + "properties": { + "revisionId": { + "type": "string", + "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"" + }, + "repository": { + "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", + "type": "string" + } + }, + "id": "SourceReference" + }, + "DeleteEventsResponse": { + "description": "Response message for deleting error events.", + "type": "object", + "properties": {}, + "id": "DeleteEventsResponse" + }, "ErrorEvent": { "description": "An error event which is returned by the Error Reporting system.", "type": "object", "properties": { - "eventTime": { - "description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.", - "format": "google-datetime", - "type": "string" - }, "context": { "description": "Data about the context in which the error occurred.", "$ref": "ErrorContext" @@ -31,59 +99,64 @@ "serviceContext": { "$ref": "ServiceContext", "description": "The `ServiceContext` for which this error was reported." + }, + "eventTime": { + "description": "Time when the event occurred as provided in the error report.\nIf the report did not contain a timestamp, the time the error was received\nby the Error Reporting system is used.", + "format": "google-datetime", + "type": "string" } }, "id": "ErrorEvent" }, "ReportedErrorEvent": { - "description": "An error event which is reported to the Error Reporting system.", - "type": "object", "properties": { + "serviceContext": { + "$ref": "ServiceContext", + "description": "[Required] The service context in which this error has occurred." + }, "eventTime": { "description": "[Optional] Time when the event occurred.\nIf not provided, the time when the event was received by the\nError Reporting system will be used.", "format": "google-datetime", "type": "string" }, "context": { - "description": "[Optional] A description of the context in which the error occurred.", - "$ref": "ErrorContext" + "$ref": "ErrorContext", + "description": "[Optional] A description of the context in which the error occurred." }, "message": { - "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack).", - "type": "string" - }, - "serviceContext": { - "description": "[Required] The service context in which this error has occurred.", - "$ref": "ServiceContext" + "type": "string", + "description": "[Required] The error message.\nIf no `context.reportLocation` is provided, the message must contain a\nheader (typically consisting of the exception type name and an error\nmessage) and an exception stack trace in one of the supported programming\nlanguages and formats.\nSupported languages are Java, Python, JavaScript, Ruby, C#, PHP, and Go.\nSupported stack trace formats are:\n\n* **Java**: Must be the return value of [`Throwable.printStackTrace()`](https://docs.oracle.com/javase/7/docs/api/java/lang/Throwable.html#printStackTrace%28%29).\n* **Python**: Must be the return value of [`traceback.format_exc()`](https://docs.python.org/2/library/traceback.html#traceback.format_exc).\n* **JavaScript**: Must be the value of [`error.stack`](https://github.com/v8/v8/wiki/Stack-Trace-API)\nas returned by V8.\n* **Ruby**: Must contain frames returned by [`Exception.backtrace`](https://ruby-doc.org/core-2.2.0/Exception.html#method-i-backtrace).\n* **C#**: Must be the return value of [`Exception.ToString()`](https://msdn.microsoft.com/en-us/library/system.exception.tostring.aspx).\n* **PHP**: Must start with `PHP (Notice|Parse error|Fatal error|Warning)`\nand contain the result of [`(string)$exception`](http://php.net/manual/en/exception.tostring.php).\n* **Go**: Must be the return value of [`runtime.Stack()`](https://golang.org/pkg/runtime/debug/#Stack)." } }, - "id": "ReportedErrorEvent" + "id": "ReportedErrorEvent", + "description": "An error event which is reported to the Error Reporting system.", + "type": "object" }, "ErrorContext": { - "description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.", - "type": "object", "properties": { + "user": { + "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.", + "type": "string" + }, "reportLocation": { "$ref": "SourceLocation", "description": "The location in the source code where the decision was made to\nreport the error, usually the place where it was logged.\nFor a logged exception this would be the source line where the\nexception is logged, usually close to the place where it was\ncaught." }, "sourceReferences": { - "description": "Source code that was used to build the executable which has\ncaused the given error message.", "type": "array", "items": { "$ref": "SourceReference" - } + }, + "description": "Source code that was used to build the executable which has\ncaused the given error message." }, "httpRequest": { "$ref": "HttpRequestContext", "description": "The HTTP request which was processed when the error was\ntriggered." - }, - "user": { - "description": "The user who caused or was affected by the crash.\nThis can be a user ID, an email address, or an arbitrary token that\nuniquely identifies the user.\nWhen sending an error report, leave this field empty if the user was not\nlogged in. In this case the\nError Reporting system will use other data, such as remote IP address, to\ndistinguish affected users. See `affected_users_count` in\n`ErrorGroupStats`.", - "type": "string" } }, - "id": "ErrorContext" + "id": "ErrorContext", + "description": "A description of the context in which an error occurred.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.", + "type": "object" }, "TrackingIssue": { "description": "Information related to tracking the progress on resolving the error.", @@ -97,7 +170,6 @@ "id": "TrackingIssue" }, "ErrorGroupStats": { - "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter.", "type": "object", "properties": { "group": { @@ -110,14 +182,14 @@ "type": "string" }, "count": { + "type": "string", "description": "Approximate total number of events in the given group that match\nthe filter criteria.", - "format": "int64", - "type": "string" + "format": "int64" }, "lastSeenTime": { + "type": "string", "description": "Approximate last occurrence that was ever seen for this group and\nwhich matches the given filter criteria, ignoring the time_range\nthat was specified in the request.", - "format": "google-datetime", - "type": "string" + "format": "google-datetime" }, "affectedUsersCount": { "description": "Approximate number of affected users in the given group that\nmatch the filter criteria.\nUsers are distinguished by data in the `ErrorContext` of the\nindividual error events, such as their login name or their remote\nIP address in case of HTTP requests.\nThe number of affected users can be zero even if the number of\nerrors is non-zero if no data was provided from which the\naffected user could be deduced.\nUsers are counted based on data in the request\ncontext that was provided in the error report. If more users are\nimplicitly affected, such as due to a crash of the whole service,\nthis is not reflected here.", @@ -137,23 +209,28 @@ } }, "representative": { - "$ref": "ErrorEvent", - "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole." + "description": "An arbitrary event that is chosen as representative for the whole group.\nThe representative event is intended to be used as a quick preview for\nthe whole group. Events in the group are usually sufficiently similar\nto each other such that showing an arbitrary representative provides\ninsight into the characteristics of the group as a whole.", + "$ref": "ErrorEvent" }, "timedCounts": { - "description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time.", "type": "array", "items": { "$ref": "TimedCount" - } + }, + "description": "Approximate number of occurrences over time.\nTimed counts returned by ListGroups are guaranteed to be:\n\n- Inside the requested time interval\n- Non-overlapping, and\n- Ordered by ascending time." } }, - "id": "ErrorGroupStats" + "id": "ErrorGroupStats", + "description": "Data extracted for a specific group based on certain filter criteria,\nsuch as a given time period and/or service filter." }, "ListEventsResponse": { "description": "Contains a set of requested error events.", "type": "object", "properties": { + "nextPageToken": { + "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.", + "type": "string" + }, "timeRangeBegin": { "description": "The timestamp specifies the start time to which the request was restricted.", "format": "google-datetime", @@ -165,10 +242,6 @@ "items": { "$ref": "ErrorEvent" } - }, - "nextPageToken": { - "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.", - "type": "string" } }, "id": "ListEventsResponse" @@ -217,33 +290,13 @@ }, "id": "ErrorGroup" }, - "SourceLocation": { - "description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.", - "type": "object", - "properties": { - "functionName": { - "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java.", - "type": "string" - }, - "filePath": { - "description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.", - "type": "string" - }, - "lineNumber": { - "description": "1-based. 0 indicates that the line number is unknown.", - "format": "int32", - "type": "integer" - } - }, - "id": "SourceLocation" - }, "ServiceContext": { "description": "Describes a running service that sends errors.\nIts version changes over time and multiple versions can run in parallel.", "type": "object", "properties": { "resourceType": { - "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors.", - "type": "string" + "type": "string", + "description": "Type of the MonitoredResource. List of possible values:\nhttps://cloud.google.com/monitoring/api/resources\n\nValue is set automatically for incoming errors and must not be set when\nreporting errors." }, "version": { "description": "Represents the source code version that the developer provided,\nwhich could represent a version label or a Git SHA-1 hash, for example.\nFor App Engine standard environment, the version is set to the version of\nthe app.", @@ -256,94 +309,32 @@ }, "id": "ServiceContext" }, - "ReportErrorEventResponse": { - "description": "Response for reporting an individual error event.\nData may be added to this message in the future.", - "type": "object", - "properties": {}, - "id": "ReportErrorEventResponse" - }, - "HttpRequestContext": { - "description": "HTTP request data that is related to a reported error.\nThis data should be provided by the application when reporting an error,\nunless the\nerror report has been generated automatically from Google App Engine logs.", + "SourceLocation": { + "description": "Indicates a location in the source code of the service for which errors are\nreported. `functionName` must be provided by the application when reporting\nan error, unless the error report contains a `message` with a supported\nexception stack trace. All fields are optional for the later case.", "type": "object", "properties": { - "referrer": { - "description": "The referrer information that is provided with the request.", + "filePath": { + "description": "The source code filename, which can include a truncated relative\npath, or a full path from a production machine.", "type": "string" }, - "userAgent": { - "description": "The user agent information that is provided with the request.", - "type": "string" - }, - "url": { - "description": "The URL of the request.", - "type": "string" - }, - "responseStatusCode": { - "description": "The HTTP response status code for the request.", + "lineNumber": { + "description": "1-based. 0 indicates that the line number is unknown.", "format": "int32", "type": "integer" }, - "method": { - "description": "The type of HTTP request, such as `GET`, `POST`, etc.", - "type": "string" - }, - "remoteIp": { - "description": "The IP address from which the request originated.\nThis can be IPv4, IPv6, or a token which is derived from the\nIP address, depending on the data that has been provided\nin the error report.", - "type": "string" + "functionName": { + "type": "string", + "description": "Human-readable name of a function or method.\nThe value can include optional context like the class or package name.\nFor example, `my.package.MyClass.method` in case of Java." } }, - "id": "HttpRequestContext" - }, - "ListGroupStatsResponse": { - "description": "Contains a set of requested error group stats.", - "type": "object", - "properties": { - "timeRangeBegin": { - "description": "The timestamp specifies the start time to which the request was restricted.\nThe start time is set based on the requested time range. It may be adjusted\nto a later time if a project has exceeded the storage quota and older data\nhas been deleted.", - "format": "google-datetime", - "type": "string" - }, - "errorGroupStats": { - "description": "The error group stats which match the given request.", - "type": "array", - "items": { - "$ref": "ErrorGroupStats" - } - }, - "nextPageToken": { - "description": "If non-empty, more results are available.\nPass this token, along with the same query parameters as the first\nrequest, to view the next page of results.", - "type": "string" - } - }, - "id": "ListGroupStatsResponse" - }, - "SourceReference": { - "description": "A reference to a particular snapshot of the source tree used to build and\ndeploy an application.", - "type": "object", - "properties": { - "revisionId": { - "description": "The canonical and persistent identifier of the deployed revision.\nExample (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"", - "type": "string" - }, - "repository": { - "description": "Optional. A URI string identifying the repository.\nExample: \"https://github.com/GoogleCloudPlatform/kubernetes.git\"", - "type": "string" - } - }, - "id": "SourceReference" - }, - "DeleteEventsResponse": { - "description": "Response message for deleting error events.", - "type": "object", - "properties": {}, - "id": "DeleteEventsResponse" + "id": "SourceLocation" } }, - "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, + "protocol": "rest", "canonicalName": "Clouderrorreporting", "auth": { "oauth2": { @@ -365,16 +356,16 @@ "methods": { "deleteEvents": { "flatPath": "v1beta1/projects/{projectsId}/events", - "path": "v1beta1/{+projectName}/events", "id": "clouderrorreporting.projects.deleteEvents", + "path": "v1beta1/{+projectName}/events", "description": "Deletes all error events of a given project.", - "response": { - "$ref": "DeleteEventsResponse" - }, + "httpMethod": "DELETE", "parameterOrder": [ "projectName" ], - "httpMethod": "DELETE", + "response": { + "$ref": "DeleteEventsResponse" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], @@ -390,9 +381,111 @@ } }, "resources": { + "events": { + "methods": { + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "projectName" + ], + "response": { + "$ref": "ListEventsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "groupId": { + "location": "query", + "description": "[Required] The group for which events shall be returned.", + "type": "string" + }, + "pageToken": { + "type": "string", + "location": "query", + "description": "[Optional] A `next_page_token` provided by a previous response." + }, + "serviceFilter.service": { + "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "[Optional] The maximum number of results to return per response.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "serviceFilter.version": { + "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", + "type": "string", + "location": "query" + }, + "serviceFilter.resourceType": { + "location": "query", + "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", + "type": "string" + }, + "timeRange.period": { + "description": "Restricts the query to the specified time range.", + "type": "string", + "location": "query", + "enum": [ + "PERIOD_UNSPECIFIED", + "PERIOD_1_HOUR", + "PERIOD_6_HOURS", + "PERIOD_1_DAY", + "PERIOD_1_WEEK", + "PERIOD_30_DAYS" + ] + }, + "projectName": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`." + } + }, + "flatPath": "v1beta1/projects/{projectsId}/events", + "id": "clouderrorreporting.projects.events.list", + "path": "v1beta1/{+projectName}/events", + "description": "Lists the specified events." + }, + "report": { + "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e", + "request": { + "$ref": "ReportedErrorEvent" + }, + "response": { + "$ref": "ReportErrorEventResponse" + }, + "parameterOrder": [ + "projectName" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectName": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/events:report", + "path": "v1beta1/{+projectName}/events:report", + "id": "clouderrorreporting.projects.events.report" + } + } + }, "groups": { "methods": { "get": { + "description": "Get the specified group.", "response": { "$ref": "ErrorGroup" }, @@ -402,11 +495,11 @@ "httpMethod": "GET", "parameters": { "groupName": { - "location": "path", - "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e", "required": true, "type": "string", - "pattern": "^projects/[^/]+/groups/[^/]+$" + "pattern": "^projects/[^/]+/groups/[^/]+$", + "location": "path", + "description": "[Required] The group resource name. Written as\n\u003ccode\u003eprojects/\u003cvar\u003eprojectID\u003c/var\u003e/groups/\u003cvar\u003egroup_name\u003c/var\u003e\u003c/code\u003e.\nCall\n\u003ca href=\"/error-reporting/reference/rest/v1beta1/projects.groupStats/list\"\u003e\n\u003ccode\u003egroupStats.list\u003c/code\u003e\u003c/a\u003e to return a list of groups belonging to\nthis project.\n\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-group\u003c/code\u003e" } }, "scopes": [ @@ -414,31 +507,30 @@ ], "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}", "path": "v1beta1/{+groupName}", - "id": "clouderrorreporting.projects.groups.get", - "description": "Get the specified group." + "id": "clouderrorreporting.projects.groups.get" }, "update": { "flatPath": "v1beta1/projects/{projectsId}/groups/{groupsId}", - "path": "v1beta1/{+name}", "id": "clouderrorreporting.projects.groups.update", + "path": "v1beta1/{+name}", "request": { "$ref": "ErrorGroup" }, "description": "Replace the data for the specified group.\nFails if the group does not exist.", - "response": { - "$ref": "ErrorGroup" - }, + "httpMethod": "PUT", "parameterOrder": [ "name" ], - "httpMethod": "PUT", + "response": { + "$ref": "ErrorGroup" + }, "parameters": { "name": { - "location": "path", - "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e", "required": true, "type": "string", - "pattern": "^projects/[^/]+/groups/[^/]+$" + "pattern": "^projects/[^/]+/groups/[^/]+$", + "location": "path", + "description": "The group resource name.\nExample: \u003ccode\u003eprojects/my-project-123/groups/my-groupid\u003c/code\u003e" } }, "scopes": [ @@ -450,7 +542,6 @@ "groupStats": { "methods": { "list": { - "flatPath": "v1beta1/projects/{projectsId}/groupStats", "path": "v1beta1/{+projectName}/groupStats", "id": "clouderrorreporting.projects.groupStats.list", "description": "Lists the specified groups.", @@ -465,52 +556,6 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "serviceFilter.service": { - "description": "[Optional] The exact value to match against\n[`ServiceContext.service`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.service).", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.", - "format": "int32", - "type": "integer" - }, - "serviceFilter.version": { - "location": "query", - "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", - "type": "string" - }, - "order": { - "location": "query", - "enum": [ - "GROUP_ORDER_UNSPECIFIED", - "COUNT_DESC", - "LAST_SEEN_DESC", - "CREATED_DESC", - "AFFECTED_USERS_DESC" - ], - "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.", - "type": "string" - }, - "serviceFilter.resourceType": { - "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", - "type": "string", - "location": "query" - }, - "alignmentTime": { - "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.", - "format": "google-datetime", - "type": "string", - "location": "query" - }, - "projectName": { - "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, "timedCountDuration": { "location": "query", "description": "[Optional] The preferred duration for a single returned `TimedCount`.\nIf not set, no timed counts are returned.", @@ -518,12 +563,11 @@ "type": "string" }, "pageToken": { - "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request.", "type": "string", - "location": "query" + "location": "query", + "description": "[Optional] A `next_page_token` provided by a previous response. To view\nadditional results, pass this token along with the identical query\nparameters as the first request." }, "timeRange.period": { - "location": "query", "enum": [ "PERIOD_UNSPECIFIED", "PERIOD_1_HOUR", @@ -533,75 +577,24 @@ "PERIOD_30_DAYS" ], "description": "Restricts the query to the specified time range.", - "type": "string" + "type": "string", + "location": "query" }, "alignment": { - "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`.", "type": "string", "location": "query", "enum": [ "ERROR_COUNT_ALIGNMENT_UNSPECIFIED", "ALIGNMENT_EQUAL_ROUNDED", "ALIGNMENT_EQUAL_AT_END" - ] + ], + "description": "[Optional] The alignment of the timed counts to be returned.\nDefault is `ALIGNMENT_EQUAL_AT_END`." }, "groupId": { - "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.", - "type": "string", "repeated": true, - "location": "query" - } - } - } - } - }, - "events": { - "methods": { - "report": { - "flatPath": "v1beta1/projects/{projectsId}/events:report", - "id": "clouderrorreporting.projects.events.report", - "path": "v1beta1/{+projectName}/events:report", - "request": { - "$ref": "ReportedErrorEvent" - }, - "description": "Report an individual error event.\n\nThis endpoint accepts \u003cstrong\u003eeither\u003c/strong\u003e an OAuth token,\n\u003cstrong\u003eor\u003c/strong\u003e an\n\u003ca href=\"https://support.google.com/cloud/answer/6158862\"\u003eAPI key\u003c/a\u003e\nfor authentication. To use an API key, append it to the URL as the value of\na `key` parameter. For example:\n\u003cpre\u003ePOST https://clouderrorreporting.googleapis.com/v1beta1/projects/example-project/events:report?key=123ABC456\u003c/pre\u003e", - "httpMethod": "POST", - "parameterOrder": [ - "projectName" - ], - "response": { - "$ref": "ReportErrorEventResponse" - }, - "parameters": { - "projectName": { - "location": "path", - "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project ID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "flatPath": "v1beta1/projects/{projectsId}/events", - "id": "clouderrorreporting.projects.events.list", - "path": "v1beta1/{+projectName}/events", - "description": "Lists the specified events.", - "httpMethod": "GET", - "response": { - "$ref": "ListEventsResponse" - }, - "parameterOrder": [ - "projectName" - ], - "parameters": { - "pageToken": { - "description": "[Optional] A `next_page_token` provided by a previous response.", - "type": "string", - "location": "query" + "location": "query", + "description": "[Optional] List all \u003ccode\u003eErrorGroupStats\u003c/code\u003e with these IDs.", + "type": "string" }, "serviceFilter.service": { "location": "query", @@ -610,49 +603,47 @@ }, "pageSize": { "location": "query", - "description": "[Optional] The maximum number of results to return per response.", + "description": "[Optional] The maximum number of results to return per response.\nDefault is 20.", "format": "int32", "type": "integer" }, + "order": { + "description": "[Optional] The sort order in which the results are returned.\nDefault is `COUNT_DESC`.", + "type": "string", + "location": "query", + "enum": [ + "GROUP_ORDER_UNSPECIFIED", + "COUNT_DESC", + "LAST_SEEN_DESC", + "CREATED_DESC", + "AFFECTED_USERS_DESC" + ] + }, "serviceFilter.version": { "description": "[Optional] The exact value to match against\n[`ServiceContext.version`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.version).", "type": "string", "location": "query" }, + "alignmentTime": { + "location": "query", + "description": "[Optional] Time where the timed counts shall be aligned if rounded\nalignment is chosen. Default is 00:00 UTC.", + "format": "google-datetime", + "type": "string" + }, "serviceFilter.resourceType": { "location": "query", "description": "[Optional] The exact value to match against\n[`ServiceContext.resource_type`](/error-reporting/reference/rest/v1beta1/ServiceContext#FIELDS.resource_type).", "type": "string" }, - "timeRange.period": { - "location": "query", - "enum": [ - "PERIOD_UNSPECIFIED", - "PERIOD_1_HOUR", - "PERIOD_6_HOURS", - "PERIOD_1_DAY", - "PERIOD_1_WEEK", - "PERIOD_30_DAYS" - ], - "description": "Restricts the query to the specified time range.", - "type": "string" - }, "projectName": { + "pattern": "^projects/[^/]+$", "location": "path", - "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas `projects/` plus the\n[Google Cloud Platform project\nID](https://support.google.com/cloud/answer/6158840).\nExample: `projects/my-project-123`.", + "description": "[Required] The resource name of the Google Cloud Platform project. Written\nas \u003ccode\u003eprojects/\u003c/code\u003e plus the\n\u003ca href=\"https://support.google.com/cloud/answer/6158840\"\u003eGoogle Cloud\nPlatform project ID\u003c/a\u003e.\n\nExample: \u003ccode\u003eprojects/my-project-123\u003c/code\u003e.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "groupId": { - "location": "query", - "description": "[Required] The group for which events shall be returned.", "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "flatPath": "v1beta1/projects/{projectsId}/groupStats" } } } @@ -660,11 +651,27 @@ } }, "parameters": { - "callback": { - "description": "JSONP", + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, + "fields": { + "type": "string", + "location": "query", + "description": "Selector specifying which fields to include in a partial response." + }, "$.xgafv": { "description": "V1 error format.", "type": "string", @@ -678,7 +685,14 @@ "2" ] }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "alt": { + "description": "Data format for response.", + "default": "json", "enum": [ "json", "media", @@ -690,61 +704,47 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], + "location": "query" + }, + "key": { "location": "query", - "description": "Data format for response.", - "default": "json" + "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.", + "type": "string" }, "access_token": { "location": "query", "description": "OAuth access token.", "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.", + "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.", "type": "string", "location": "query" }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, "pp": { - "location": "query", - "description": "Pretty-print response.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query", + "description": "Pretty-print response." + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" }, "bearer_token": { "description": "OAuth bearer token.", "type": "string", "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" } - } + }, + "version": "v1beta1", + "baseUrl": "https://clouderrorreporting.googleapis.com/", + "servicePath": "", + "kind": "discovery#restDescription", + "description": "Groups and counts similar errors from cloud services and applications, reports new errors, and provides access to error groups and their associated errors.\n", + "basePath": "", + "id": "clouderrorreporting:v1beta1", + "documentationLink": "https://cloud.google.com/error-reporting/", + "revision": "20171215" }
diff --git a/cloudfunctions/v1/cloudfunctions-api.json b/cloudfunctions/v1/cloudfunctions-api.json index 2757193..526d47f 100644 --- a/cloudfunctions/v1/cloudfunctions-api.json +++ b/cloudfunctions/v1/cloudfunctions-api.json
@@ -1,513 +1,12 @@ { - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "locations": { - "methods": { - "list": { - "response": { - "$ref": "ListLocationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The resource that owns the locations collection, if applicable.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - }, - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/projects/{projectsId}/locations", - "path": "v1/{+name}/locations", - "id": "cloudfunctions.projects.locations.list", - "description": "Lists information about the supported locations for this service." - } - }, - "resources": { - "functions": { - "methods": { - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the function which should be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "path": "v1/{+name}", - "id": "cloudfunctions.projects.locations.functions.delete", - "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function." - }, - "list": { - "description": "Returns a list of functions that belong to the requested project.", - "response": { - "$ref": "ListFunctionsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "Maximum number of functions to return per call.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.", - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", - "path": "v1/{+parent}/functions", - "id": "cloudfunctions.projects.locations.functions.list" - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "location" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "location": { - "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", - "path": "v1/{+location}/functions", - "id": "cloudfunctions.projects.locations.functions.create", - "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.", - "request": { - "$ref": "CloudFunction" - } - }, - "call": { - "response": { - "$ref": "CallFunctionResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the function to be called.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call", - "path": "v1/{+name}:call", - "id": "cloudfunctions.projects.locations.functions.call", - "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.", - "request": { - "$ref": "CallFunctionRequest" - } - }, - "generateUploadUrl": { - "response": { - "$ref": "GenerateUploadUrlResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", - "path": "v1/{+parent}/functions:generateUploadUrl", - "id": "cloudfunctions.projects.locations.functions.generateUploadUrl", - "request": { - "$ref": "GenerateUploadUrlRequest" - }, - "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`" - }, - "generateDownloadUrl": { - "request": { - "$ref": "GenerateDownloadUrlRequest" - }, - "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GenerateDownloadUrlResponse" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl", - "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl", - "path": "v1/{+name}:generateDownloadUrl" - }, - "get": { - "response": { - "$ref": "CloudFunction" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the function which details should be obtained.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "path": "v1/{+name}", - "id": "cloudfunctions.projects.locations.functions.get", - "description": "Returns a function with the given name from the requested project." - }, - "patch": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "path": "v1/{+name}", - "id": "cloudfunctions.projects.locations.functions.patch", - "request": { - "$ref": "CloudFunction" - }, - "description": "Updates existing function.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "name": { - "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path" - }, - "updateMask": { - "location": "query", - "description": "Required list of fields to be updated in this request.", - "format": "google-fieldmask", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - }, - "operations": { - "methods": { - "list": { - "flatPath": "v1/operations", - "id": "cloudfunctions.operations.list", - "path": "v1/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 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", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [], - "parameters": { - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - }, - "name": { - "location": "query", - "description": "The name of the operation's parent resource.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - } - }, - "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", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations/{operationsId}", - "id": "cloudfunctions.operations.get", - "path": "v1/{+name}" - } - } - } - }, - "parameters": { - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - } - }, - "version": "v1", - "baseUrl": "https://cloudfunctions.googleapis.com/", - "kind": "discovery#restDescription", - "description": "API for managing lightweight user-provided functions executed in response to events.", - "servicePath": "", - "basePath": "", "id": "cloudfunctions:v1", "documentationLink": "https://cloud.google.com/functions", "revision": "20180102", "discoveryVersion": "v1", "version_module": true, "schemas": { - "OperationMetadataV1Beta2": { - "properties": { - "request": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "versionId": { - "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", - "format": "int64", - "type": "string" - }, - "type": { - "enumDescriptions": [ - "Unknown operation type.", - "Triggered by CreateFunction call", - "Triggered by UpdateFunction call", - "Triggered by DeleteFunction call." - ], - "enum": [ - "OPERATION_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION" - ], - "description": "Type of operation.", - "type": "string" - }, - "updateTime": { - "description": "The last update timestamp of the operation.", - "format": "google-datetime", - "type": "string" - }, - "target": { - "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", - "type": "string" - } - }, - "id": "OperationMetadataV1Beta2", - "description": "Metadata describing an Operation", - "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.", - "type": "object", "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 is a common set of\nmessage types for APIs to use.", "type": "array", @@ -523,24 +22,28 @@ "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" } }, - "id": "Status" + "id": "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.", + "type": "object" }, "CallFunctionRequest": { - "description": "Request for the `CallFunction` method.", - "type": "object", "properties": { "data": { "description": "Input to be passed to the function.", "type": "string" } }, - "id": "CallFunctionRequest" + "id": "CallFunctionRequest", + "description": "Request for the `CallFunction` method.", + "type": "object" }, "SourceRepository": { - "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.", - "type": "object", "properties": { "deployedUrl": { "description": "Output only. The URL pointing to the hosted repository where the function\nwere defined at the time of deployment. It always points to a specific\ncommit in the format described above.", @@ -551,67 +54,27 @@ "type": "string" } }, - "id": "SourceRepository" + "id": "SourceRepository", + "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.", + "type": "object" }, "CloudFunction": { "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.", "type": "object", "properties": { - "availableMemoryMb": { - "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", - "type": "string" - }, - "versionId": { - "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.", - "format": "int64", - "type": "string" - }, - "sourceArchiveUrl": { - "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.", - "type": "string" - }, - "sourceRepository": { - "description": "**Beta Feature**\n\nThe source repository where a function is hosted.", - "$ref": "SourceRepository" - }, - "labels": { - "description": "Labels associated with this Cloud Function.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "entryPoint": { - "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.", - "type": "string" - }, - "updateTime": { - "description": "Output only. The last update timestamp of a Cloud Function.", - "format": "google-datetime", - "type": "string" - }, - "httpsTrigger": { - "$ref": "HttpsTrigger", - "description": "An HTTPS endpoint type of source that can be triggered via URL." - }, - "serviceAccountEmail": { - "description": "Output only. The email of the function's service account.", - "type": "string" - }, - "description": { - "description": "User-provided description of a function.", - "type": "string" - }, "timeout": { "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.", "format": "google-duration", "type": "string" }, + "sourceUploadUrl": { + "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl", + "type": "string" + }, + "eventTrigger": { + "$ref": "EventTrigger", + "description": "A source that fires events in response to a condition in another service." + }, "status": { "enumDescriptions": [ "Not specified. Invalid state.", @@ -632,32 +95,81 @@ "description": "Output only. Status of the function deployment.", "type": "string" }, - "eventTrigger": { - "$ref": "EventTrigger", - "description": "A source that fires events in response to a condition in another service." + "availableMemoryMb": { + "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.", + "format": "int32", + "type": "integer" }, - "sourceUploadUrl": { - "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl", + "name": { + "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", + "type": "string" + }, + "versionId": { + "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.", + "format": "int64", + "type": "string" + }, + "sourceArchiveUrl": { + "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.", + "type": "string" + }, + "sourceRepository": { + "$ref": "SourceRepository", + "description": "**Beta Feature**\n\nThe source repository where a function is hosted." + }, + "entryPoint": { + "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with this Cloud Function.", + "type": "object" + }, + "updateTime": { + "description": "Output only. The last update timestamp of a Cloud Function.", + "format": "google-datetime", + "type": "string" + }, + "httpsTrigger": { + "$ref": "HttpsTrigger", + "description": "An HTTPS endpoint type of source that can be triggered via URL." + }, + "serviceAccountEmail": { + "description": "Output only. The email of the function's service account.", + "type": "string" + }, + "description": { + "description": "User-provided description of a function.", "type": "string" } }, "id": "CloudFunction" }, "HttpsTrigger": { + "description": "Describes HttpsTrigger, could be used to connect web hooks to function.", + "type": "object", "properties": { "url": { "description": "Output only. The deployed url for the function.", "type": "string" } }, - "id": "HttpsTrigger", - "description": "Describes HttpsTrigger, could be used to connect web hooks to function.", - "type": "object" + "id": "HttpsTrigger" }, "Location": { "description": "A resource that represents Google Cloud Platform location.", "type": "object", "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, "name": { "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", "type": "string" @@ -673,13 +185,6 @@ }, "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", "type": "object" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" } }, "id": "Location" @@ -696,18 +201,20 @@ "id": "GenerateDownloadUrlResponse" }, "Retry": { - "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.", - "type": "object", "properties": {}, - "id": "Retry" + "id": "Retry", + "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.", + "type": "object" }, "GenerateUploadUrlRequest": { - "description": "Request of `GenerateSourceUploadUrl` method.", - "type": "object", "properties": {}, - "id": "GenerateUploadUrlRequest" + "id": "GenerateUploadUrlRequest", + "description": "Request of `GenerateSourceUploadUrl` method.", + "type": "object" }, "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", @@ -721,9 +228,7 @@ } } }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations.", - "type": "object" + "id": "ListOperationsResponse" }, "GenerateUploadUrlResponse": { "description": "Response of `GenerateSourceUploadUrl` method.", @@ -758,6 +263,10 @@ "description": "Response of `CallFunction` method.", "type": "object", "properties": { + "executionId": { + "description": "Execution id of function invocation.", + "type": "string" + }, "result": { "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.", "type": "string" @@ -765,10 +274,6 @@ "error": { "description": "Either system or user-function generated error. Set if execution\nwas not successful.", "type": "string" - }, - "executionId": { - "description": "Execution id of function invocation.", - "type": "string" } }, "id": "CallFunctionResponse" @@ -792,7 +297,13 @@ "id": "ListLocationsResponse" }, "EventTrigger": { + "description": "Describes EventTrigger, used to request events be sent from another\nservice.", + "type": "object", "properties": { + "failurePolicy": { + "$ref": "FailurePolicy", + "description": "Specifies policy for failed executions." + }, "eventType": { "description": "Required. The type of event to observe. For example:\n`providers/cloud.storage/eventTypes/object.change` and\n`providers/cloud.pubsub/eventTypes/topic.publish`.\n\nEvent types match pattern `providers/*/eventTypes/*.*`.\nThe pattern contains:\n\n1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case.", "type": "string" @@ -804,26 +315,54 @@ "service": { "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.", "type": "string" - }, - "failurePolicy": { - "description": "Specifies policy for failed executions.", - "$ref": "FailurePolicy" } }, - "id": "EventTrigger", - "description": "Describes EventTrigger, used to request events be sent from another\nservice.", - "type": "object" + "id": "EventTrigger" }, - "FailurePolicy": { - "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).", - "type": "object", + "OperationMetadataV1": { "properties": { - "retry": { - "description": "If specified, then the function will be retried in case of a failure.", - "$ref": "Retry" + "updateTime": { + "description": "The last update timestamp of the operation.", + "format": "google-datetime", + "type": "string" + }, + "target": { + "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", + "type": "string" + }, + "request": { + "description": "The original request that started the operation.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "versionId": { + "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", + "format": "int64", + "type": "string" + }, + "type": { + "enumDescriptions": [ + "Unknown operation type.", + "Triggered by CreateFunction call", + "Triggered by UpdateFunction call", + "Triggered by DeleteFunction call." + ], + "enum": [ + "OPERATION_UNSPECIFIED", + "CREATE_FUNCTION", + "UPDATE_FUNCTION", + "DELETE_FUNCTION" + ], + "description": "Type of operation.", + "type": "string" } }, - "id": "FailurePolicy" + "id": "OperationMetadataV1", + "description": "Metadata describing an Operation", + "type": "object" }, "GenerateDownloadUrlRequest": { "description": "Request of `GenerateDownloadUrl` method.", @@ -837,7 +376,53 @@ }, "id": "GenerateDownloadUrlRequest" }, - "OperationMetadataV1": { + "FailurePolicy": { + "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).", + "type": "object", + "properties": { + "retry": { + "description": "If specified, then the function will be retried in case of a failure.", + "$ref": "Retry" + } + }, + "id": "FailurePolicy" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "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.", + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object" + } + }, + "id": "Operation" + }, + "OperationMetadataV1Beta2": { "description": "Metadata describing an Operation", "type": "object", "properties": { @@ -880,49 +465,14 @@ ] } }, - "id": "OperationMetadataV1" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "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.", - "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" - } - }, - "id": "Operation" + "id": "OperationMetadataV1Beta2" } }, - "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, + "protocol": "rest", "canonicalName": "Cloud Functions", "auth": { "oauth2": { @@ -938,5 +488,455 @@ "name": "cloudfunctions", "batchPath": "batch", "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Functions API" + "title": "Google Cloud Functions API", + "ownerName": "Google", + "resources": { + "operations": { + "methods": { + "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.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + }, + "name": { + "description": "The name of the operation's parent resource.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations", + "path": "v1/operations", + "id": "cloudfunctions.operations.list" + }, + "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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "cloudfunctions.operations.get" + } + } + }, + "projects": { + "resources": { + "locations": { + "methods": { + "list": { + "response": { + "$ref": "ListLocationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations", + "path": "v1/{+name}/locations", + "id": "cloudfunctions.projects.locations.list", + "description": "Lists information about the supported locations for this service." + } + }, + "resources": { + "functions": { + "methods": { + "delete": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The name of the function which should be deleted.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "path": "v1/{+name}", + "id": "cloudfunctions.projects.locations.functions.delete", + "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function." + }, + "list": { + "description": "Returns a list of functions that belong to the requested project.", + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListFunctionsResponse" + }, + "parameters": { + "pageToken": { + "location": "query", + "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.", + "type": "string" + }, + "pageSize": { + "description": "Maximum number of functions to return per call.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", + "id": "cloudfunctions.projects.locations.functions.list", + "path": "v1/{+parent}/functions" + }, + "create": { + "path": "v1/{+location}/functions", + "id": "cloudfunctions.projects.locations.functions.create", + "request": { + "$ref": "CloudFunction" + }, + "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "location" + ], + "httpMethod": "POST", + "parameters": { + "location": { + "location": "path", + "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions" + }, + "call": { + "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.", + "request": { + "$ref": "CallFunctionRequest" + }, + "response": { + "$ref": "CallFunctionResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "location": "path", + "description": "The name of the function to be called.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call", + "path": "v1/{+name}:call", + "id": "cloudfunctions.projects.locations.functions.call" + }, + "generateUploadUrl": { + "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`", + "request": { + "$ref": "GenerateUploadUrlRequest" + }, + "response": { + "$ref": "GenerateUploadUrlResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", + "path": "v1/{+parent}/functions:generateUploadUrl", + "id": "cloudfunctions.projects.locations.functions.generateUploadUrl" + }, + "generateDownloadUrl": { + "path": "v1/{+name}:generateDownloadUrl", + "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl", + "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls", + "request": { + "$ref": "GenerateDownloadUrlRequest" + }, + "response": { + "$ref": "GenerateDownloadUrlResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl" + }, + "get": { + "httpMethod": "GET", + "response": { + "$ref": "CloudFunction" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name of the function which details should be obtained.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "id": "cloudfunctions.projects.locations.functions.get", + "path": "v1/{+name}", + "description": "Returns a function with the given name from the requested project." + }, + "patch": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "updateMask": { + "description": "Required list of fields to be updated in this request.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "name": { + "location": "path", + "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "path": "v1/{+name}", + "id": "cloudfunctions.projects.locations.functions.patch", + "request": { + "$ref": "CloudFunction" + }, + "description": "Updates existing function." + } + } + } + } + } + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + } + }, + "version": "v1", + "baseUrl": "https://cloudfunctions.googleapis.com/", + "kind": "discovery#restDescription", + "description": "API for managing lightweight user-provided functions executed in response to events.", + "servicePath": "", + "basePath": "" }
diff --git a/cloudfunctions/v1beta2/cloudfunctions-api.json b/cloudfunctions/v1beta2/cloudfunctions-api.json index 3db45c4..6c6f40e 100644 --- a/cloudfunctions/v1beta2/cloudfunctions-api.json +++ b/cloudfunctions/v1beta2/cloudfunctions-api.json
@@ -1,4 +1,511 @@ { + "baseUrl": "https://cloudfunctions.googleapis.com/", + "kind": "discovery#restDescription", + "description": "API for managing lightweight user-provided functions executed in response to events.", + "servicePath": "", + "basePath": "", + "revision": "20180102", + "documentationLink": "https://cloud.google.com/functions", + "id": "cloudfunctions:v1beta2", + "discoveryVersion": "v1", + "version_module": true, + "schemas": { + "OperationMetadataV1Beta2": { + "description": "Metadata describing an Operation", + "type": "object", + "properties": { + "updateTime": { + "description": "The last update timestamp of the operation.", + "format": "google-datetime", + "type": "string" + }, + "target": { + "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", + "type": "string" + }, + "request": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The original request that started the operation.", + "type": "object" + }, + "versionId": { + "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", + "format": "int64", + "type": "string" + }, + "type": { + "enumDescriptions": [ + "Unknown operation type.", + "Triggered by CreateFunction call", + "Triggered by UpdateFunction call", + "Triggered by DeleteFunction call." + ], + "enum": [ + "OPERATION_UNSPECIFIED", + "CREATE_FUNCTION", + "UPDATE_FUNCTION", + "DELETE_FUNCTION" + ], + "description": "Type of operation.", + "type": "string" + } + }, + "id": "OperationMetadataV1Beta2" + }, + "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.", + "type": "object", + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "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" + } + }, + "id": "Status" + }, + "CallFunctionRequest": { + "description": "Request for the `CallFunction` method.", + "type": "object", + "properties": { + "data": { + "description": "Input to be passed to the function.", + "type": "string" + } + }, + "id": "CallFunctionRequest" + }, + "SourceRepository": { + "description": "Describes the location of the function source in a remote repository.", + "type": "object", + "properties": { + "tag": { + "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched.", + "type": "string" + }, + "branch": { + "description": "The name of the branch from which the function should be fetched.", + "type": "string" + }, + "sourcePath": { + "description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.", + "type": "string" + }, + "deployedRevision": { + "description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.", + "type": "string" + }, + "revision": { + "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.", + "type": "string" + }, + "repositoryUrl": { + "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.", + "type": "string" + } + }, + "id": "SourceRepository" + }, + "CloudFunction": { + "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.", + "type": "object", + "properties": { + "timeout": { + "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.", + "format": "google-duration", + "type": "string" + }, + "status": { + "description": "Output only. Status of the function deployment.", + "type": "string", + "enumDescriptions": [ + "Status not specified.", + "Successfully deployed.", + "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.", + "Creation or update in progress.", + "Deletion in progress." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "READY", + "FAILED", + "DEPLOYING", + "DELETING" + ] + }, + "eventTrigger": { + "$ref": "EventTrigger", + "description": "A source that fires events in response to a condition in another service." + }, + "sourceUploadUrl": { + "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl", + "type": "string" + }, + "availableMemoryMb": { + "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", + "type": "string" + }, + "versionId": { + "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.", + "format": "int64", + "type": "string" + }, + "serviceAccount": { + "description": "Output only. The service account of the function.", + "type": "string" + }, + "sourceArchiveUrl": { + "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.", + "type": "string" + }, + "sourceRepository": { + "description": "The hosted repository where the function is defined.", + "$ref": "SourceRepository" + }, + "entryPoint": { + "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with this Cloud Function.", + "type": "object" + }, + "sourceRepositoryUrl": { + "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.", + "type": "string" + }, + "updateTime": { + "description": "Output only. The last update timestamp of a Cloud Function.", + "format": "google-datetime", + "type": "string" + }, + "latestOperation": { + "description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.", + "type": "string" + }, + "httpsTrigger": { + "description": "An HTTPS endpoint type of source that can be triggered via URL.", + "$ref": "HTTPSTrigger" + } + }, + "id": "CloudFunction" + }, + "Location": { + "description": "A resource that represents Google Cloud Platform location.", + "type": "object", + "properties": { + "labels": { + "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", + "type": "object" + } + }, + "id": "Location" + }, + "GenerateDownloadUrlResponse": { + "description": "Response of `GenerateDownloadUrl` method.", + "type": "object", + "properties": { + "downloadUrl": { + "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.", + "type": "string" + } + }, + "id": "GenerateDownloadUrlResponse" + }, + "Retry": { + "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.", + "type": "object", + "properties": {}, + "id": "Retry" + }, + "GenerateUploadUrlRequest": { + "description": "Request of `GenerateUploadUrl` method.", + "type": "object", + "properties": {}, + "id": "GenerateUploadUrlRequest" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + }, + "id": "ListOperationsResponse" + }, + "GenerateUploadUrlResponse": { + "description": "Response of `GenerateUploadUrl` method.", + "type": "object", + "properties": { + "uploadUrl": { + "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.", + "type": "string" + } + }, + "id": "GenerateUploadUrlResponse" + }, + "ListFunctionsResponse": { + "description": "Response for the `ListFunctions` method.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions.", + "type": "string" + }, + "functions": { + "description": "The functions that match the request.", + "type": "array", + "items": { + "$ref": "CloudFunction" + } + } + }, + "id": "ListFunctionsResponse" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Location" + } + } + }, + "id": "ListLocationsResponse" + }, + "CallFunctionResponse": { + "description": "Response of `CallFunction` method.", + "type": "object", + "properties": { + "result": { + "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.", + "type": "string" + }, + "error": { + "description": "Either system or user-function generated error. Set if execution\nwas not successful.", + "type": "string" + }, + "executionId": { + "description": "Execution id of function invocation.", + "type": "string" + } + }, + "id": "CallFunctionResponse" + }, + "EventTrigger": { + "description": "Describes EventTrigger, used to request events be sent from another\nservice.", + "type": "object", + "properties": { + "failurePolicy": { + "$ref": "FailurePolicy", + "description": "Specifies policy for failed executions." + }, + "eventType": { + "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.\n\nHandle an object changing in Google Cloud Storage:\n`providers/cloud.storage/eventTypes/object.change`\n\nHandle a write to the Firebase Realtime Database:\n`providers/google.firebase.database/eventTypes/ref.write`", + "type": "string" + }, + "resource": { + "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)", + "type": "string" + }, + "service": { + "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.", + "type": "string" + } + }, + "id": "EventTrigger" + }, + "HTTPSTrigger": { + "description": "Describes HTTPSTrigger, could be used to connect web hooks to function.", + "type": "object", + "properties": { + "url": { + "description": "Output only. The deployed url for the function.", + "type": "string" + } + }, + "id": "HTTPSTrigger" + }, + "FailurePolicy": { + "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).", + "type": "object", + "properties": { + "retry": { + "$ref": "Retry", + "description": "If specified, then the function will be retried in case of a failure." + } + }, + "id": "FailurePolicy" + }, + "OperationMetadataV1": { + "description": "Metadata describing an Operation", + "type": "object", + "properties": { + "updateTime": { + "description": "The last update timestamp of the operation.", + "format": "google-datetime", + "type": "string" + }, + "target": { + "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", + "type": "string" + }, + "request": { + "description": "The original request that started the operation.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "versionId": { + "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", + "format": "int64", + "type": "string" + }, + "type": { + "enumDescriptions": [ + "Unknown operation type.", + "Triggered by CreateFunction call", + "Triggered by UpdateFunction call", + "Triggered by DeleteFunction call." + ], + "enum": [ + "OPERATION_UNSPECIFIED", + "CREATE_FUNCTION", + "UPDATE_FUNCTION", + "DELETE_FUNCTION" + ], + "description": "Type of operation.", + "type": "string" + } + }, + "id": "OperationMetadataV1" + }, + "GenerateDownloadUrlRequest": { + "description": "Request of `GenerateDownloadUrl` method.", + "type": "object", + "properties": { + "versionId": { + "description": "The optional version of function.", + "format": "uint64", + "type": "string" + } + }, + "id": "GenerateDownloadUrlRequest" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "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.", + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "id": "Operation" + } + }, + "protocol": "rest", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "canonicalName": "Cloud Functions", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, "rootUrl": "https://cloudfunctions.googleapis.com/", "ownerDomain": "google.com", "name": "cloudfunctions", @@ -10,6 +517,9 @@ "operations": { "methods": { "list": { + "flatPath": "v1beta2/operations", + "path": "v1beta2/operations", + "id": "cloudfunctions.operations.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.", "response": { "$ref": "ListOperationsResponse" @@ -17,34 +527,31 @@ "parameterOrder": [], "httpMethod": "GET", "parameters": { - "name": { - "type": "string", - "location": "query", - "description": "The name of the operation's parent resource." - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "The standard list page size.", - "format": "int32" - }, "filter": { "location": "query", "description": "The standard list filter.", "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "type": "string", + "location": "query" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/operations", - "path": "v1beta2/operations", - "id": "cloudfunctions.operations.list" + ] }, "get": { "response": { @@ -56,11 +563,11 @@ "httpMethod": "GET", "parameters": { "name": { + "description": "The name of the operation resource.", "required": true, "type": "string", "pattern": "^operations/[^/]+$", - "location": "path", - "description": "The name of the operation resource." + "location": "path" } }, "scopes": [ @@ -78,10 +585,6 @@ "locations": { "methods": { "list": { - "flatPath": "v1beta2/projects/{projectsId}/locations", - "path": "v1beta2/{+name}/locations", - "id": "cloudfunctions.projects.locations.list", - "description": "Lists information about the supported locations for this service.", "response": { "$ref": "ListLocationsResponse" }, @@ -93,36 +596,192 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "name": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The resource that owns the locations collection, if applicable." - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, "pageSize": { - "location": "query", "description": "The standard list page size.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "filter": { - "type": "string", "location": "query", - "description": "The standard list filter." + "description": "The standard list filter.", + "type": "string" + }, + "name": { + "location": "path", + "description": "The resource that owns the locations collection, if applicable.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" } - } + }, + "flatPath": "v1beta2/projects/{projectsId}/locations", + "path": "v1beta2/{+name}/locations", + "id": "cloudfunctions.projects.locations.list", + "description": "Lists information about the supported locations for this service." } }, "resources": { "functions": { "methods": { + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "location" + ], + "response": { + "$ref": "ListFunctionsResponse" + }, + "parameters": { + "pageSize": { + "description": "Maximum number of functions to return per call.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "location": { + "location": "path", + "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions", + "id": "cloudfunctions.projects.locations.functions.list", + "path": "v1beta2/{+location}/functions", + "description": "Returns a list of functions that belong to the requested project." + }, + "create": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "location" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "location": { + "location": "path", + "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions", + "path": "v1beta2/{+location}/functions", + "id": "cloudfunctions.projects.locations.functions.create", + "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.", + "request": { + "$ref": "CloudFunction" + } + }, + "call": { + "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.", + "request": { + "$ref": "CallFunctionRequest" + }, + "response": { + "$ref": "CallFunctionResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the function to be called.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call", + "path": "v1beta2/{+name}:call", + "id": "cloudfunctions.projects.locations.functions.call" + }, + "generateUploadUrl": { + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", + "path": "v1beta2/{+parent}/functions:generateUploadUrl", + "id": "cloudfunctions.projects.locations.functions.generateUploadUrl", + "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`", + "request": { + "$ref": "GenerateUploadUrlRequest" + }, + "response": { + "$ref": "GenerateUploadUrlResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "location": "path", + "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + } + }, + "generateDownloadUrl": { + "request": { + "$ref": "GenerateDownloadUrlRequest" + }, + "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls", + "response": { + "$ref": "GenerateDownloadUrlResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl", + "path": "v1beta2/{+name}:generateDownloadUrl", + "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl" + }, "get": { + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "path": "v1beta2/{+name}", + "id": "cloudfunctions.projects.locations.functions.get", + "description": "Returns a function with the given name from the requested project.", "response": { "$ref": "CloudFunction" }, @@ -132,20 +791,16 @@ "httpMethod": "GET", "parameters": { "name": { - "location": "path", "description": "The name of the function which details should be obtained.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "path": "v1beta2/{+name}", - "id": "cloudfunctions.projects.locations.functions.get", - "description": "Returns a function with the given name from the requested project." + ] }, "update": { "response": { @@ -176,10 +831,6 @@ } }, "delete": { - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "id": "cloudfunctions.projects.locations.functions.delete", - "path": "v1beta2/{+name}", - "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.", "httpMethod": "DELETE", "parameterOrder": [ "name" @@ -189,164 +840,20 @@ }, "parameters": { "name": { - "location": "path", "description": "The name of the function which should be deleted.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions", - "id": "cloudfunctions.projects.locations.functions.list", - "path": "v1beta2/{+location}/functions", - "description": "Returns a list of functions that belong to the requested project.", - "httpMethod": "GET", - "parameterOrder": [ - "location" - ], - "response": { - "$ref": "ListFunctionsResponse" - }, - "parameters": { - "location": { - "location": "path", - "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - }, - "pageToken": { - "type": "string", - "location": "query", - "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data." - }, - "pageSize": { - "location": "query", - "description": "Maximum number of functions to return per call.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.", - "request": { - "$ref": "CloudFunction" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "location" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "location": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions", - "path": "v1beta2/{+location}/functions", - "id": "cloudfunctions.projects.locations.functions.create" - }, - "call": { - "response": { - "$ref": "CallFunctionResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "required": true, - "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path", - "description": "The name of the function to be called." - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call", - "path": "v1beta2/{+name}:call", - "id": "cloudfunctions.projects.locations.functions.call", - "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.", - "request": { - "$ref": "CallFunctionRequest" - } - }, - "generateUploadUrl": { - "response": { - "$ref": "GenerateUploadUrlResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "location": "path", - "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", - "path": "v1beta2/{+parent}/functions:generateUploadUrl", - "id": "cloudfunctions.projects.locations.functions.generateUploadUrl", - "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-google-content-length-range: 0,104857600`", - "request": { - "$ref": "GenerateUploadUrlRequest" - } - }, - "generateDownloadUrl": { - "response": { - "$ref": "GenerateDownloadUrlResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl", - "path": "v1beta2/{+name}:generateDownloadUrl", - "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl", - "request": { - "$ref": "GenerateDownloadUrlRequest" - }, - "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls" + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "id": "cloudfunctions.projects.locations.functions.delete", + "path": "v1beta2/{+name}", + "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function." } } } @@ -356,42 +863,21 @@ } }, "parameters": { - "quotaUser": { - "type": "string", - "location": "query", - "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." - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { + "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", - "location": "query", - "description": "Returns response with indentations and line breaks." + "location": "query" }, "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." + "location": "query" }, "fields": { "location": "query", @@ -399,27 +885,24 @@ "type": "string" }, "$.xgafv": { - "location": "query", - "enum": [ - "1", - "2" - ], "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" ] }, "callback": { + "description": "JSONP", "type": "string", - "location": "query", - "description": "JSONP" + "location": "query" }, "alt": { - "location": "query", - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -430,525 +913,42 @@ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" - ] + ], + "location": "query", + "description": "Data format for response.", + "default": "json" }, "key": { - "type": "string", "location": "query", - "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." + "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.", + "type": "string" }, "access_token": { - "type": "string", "location": "query", - "description": "OAuth access token." + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" } }, - "version": "v1beta2", - "baseUrl": "https://cloudfunctions.googleapis.com/", - "kind": "discovery#restDescription", - "description": "API for managing lightweight user-provided functions executed in response to events.", - "servicePath": "", - "basePath": "", - "revision": "20180102", - "documentationLink": "https://cloud.google.com/functions", - "id": "cloudfunctions:v1beta2", - "discoveryVersion": "v1", - "version_module": true, - "schemas": { - "ListLocationsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The standard List next-page token." - }, - "locations": { - "type": "array", - "items": { - "$ref": "Location" - }, - "description": "A list of locations that matches the specified filter in the request." - } - }, - "id": "ListLocationsResponse", - "description": "The response message for Locations.ListLocations." - }, - "CallFunctionResponse": { - "type": "object", - "properties": { - "executionId": { - "type": "string", - "description": "Execution id of function invocation." - }, - "result": { - "type": "string", - "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context." - }, - "error": { - "description": "Either system or user-function generated error. Set if execution\nwas not successful.", - "type": "string" - } - }, - "id": "CallFunctionResponse", - "description": "Response of `CallFunction` method." - }, - "EventTrigger": { - "description": "Describes EventTrigger, used to request events be sent from another\nservice.", - "type": "object", - "properties": { - "eventType": { - "type": "string", - "description": "`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`.\n\nHandle an object changing in Google Cloud Storage:\n`providers/cloud.storage/eventTypes/object.change`\n\nHandle a write to the Firebase Realtime Database:\n`providers/google.firebase.database/eventTypes/ref.write`" - }, - "resource": { - "type": "string", - "description": "Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)" - }, - "service": { - "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.", - "type": "string" - }, - "failurePolicy": { - "$ref": "FailurePolicy", - "description": "Specifies policy for failed executions." - } - }, - "id": "EventTrigger" - }, - "HTTPSTrigger": { - "type": "object", - "properties": { - "url": { - "description": "Output only. The deployed url for the function.", - "type": "string" - } - }, - "id": "HTTPSTrigger", - "description": "Describes HTTPSTrigger, could be used to connect web hooks to function." - }, - "FailurePolicy": { - "type": "object", - "properties": { - "retry": { - "$ref": "Retry", - "description": "If specified, then the function will be retried in case of a failure." - } - }, - "id": "FailurePolicy", - "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them)." - }, - "OperationMetadataV1": { - "type": "object", - "properties": { - "updateTime": { - "description": "The last update timestamp of the operation.", - "format": "google-datetime", - "type": "string" - }, - "target": { - "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", - "type": "string" - }, - "request": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "versionId": { - "type": "string", - "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", - "format": "int64" - }, - "type": { - "type": "string", - "enumDescriptions": [ - "Unknown operation type.", - "Triggered by CreateFunction call", - "Triggered by UpdateFunction call", - "Triggered by DeleteFunction call." - ], - "enum": [ - "OPERATION_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION" - ], - "description": "Type of operation." - } - }, - "id": "OperationMetadataV1", - "description": "Metadata describing an Operation" - }, - "GenerateDownloadUrlRequest": { - "type": "object", - "properties": { - "versionId": { - "type": "string", - "description": "The optional version of function.", - "format": "uint64" - } - }, - "id": "GenerateDownloadUrlRequest", - "description": "Request of `GenerateDownloadUrl` method." - }, - "Operation": { - "type": "object", - "properties": { - "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" - }, - "done": { - "type": "boolean", - "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." - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." - }, - "OperationMetadataV1Beta2": { - "type": "object", - "properties": { - "type": { - "enum": [ - "OPERATION_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION" - ], - "description": "Type of operation.", - "type": "string", - "enumDescriptions": [ - "Unknown operation type.", - "Triggered by CreateFunction call", - "Triggered by UpdateFunction call", - "Triggered by DeleteFunction call." - ] - }, - "updateTime": { - "type": "string", - "description": "The last update timestamp of the operation.", - "format": "google-datetime" - }, - "target": { - "type": "string", - "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1" - }, - "request": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation." - }, - "versionId": { - "type": "string", - "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", - "format": "int64" - } - }, - "id": "OperationMetadataV1Beta2", - "description": "Metadata describing an Operation" - }, - "Status": { - "type": "object", - "properties": { - "code": { - "type": "integer", - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" - }, - "message": { - "type": "string", - "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." - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - } - }, - "id": "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." - }, - "CallFunctionRequest": { - "description": "Request for the `CallFunction` method.", - "type": "object", - "properties": { - "data": { - "description": "Input to be passed to the function.", - "type": "string" - } - }, - "id": "CallFunctionRequest" - }, - "SourceRepository": { - "type": "object", - "properties": { - "branch": { - "description": "The name of the branch from which the function should be fetched.", - "type": "string" - }, - "sourcePath": { - "description": "The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.", - "type": "string" - }, - "deployedRevision": { - "description": "Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.", - "type": "string" - }, - "revision": { - "description": "The id of the revision that captures the state of the repository from\nwhich the function should be fetched.", - "type": "string" - }, - "repositoryUrl": { - "type": "string", - "description": "URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository." - }, - "tag": { - "type": "string", - "description": "The name of the tag that captures the state of the repository from\nwhich the function should be fetched." - } - }, - "id": "SourceRepository", - "description": "Describes the location of the function source in a remote repository." - }, - "CloudFunction": { - "type": "object", - "properties": { - "entryPoint": { - "type": "string", - "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`." - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels associated with this Cloud Function.", - "type": "object" - }, - "sourceRepositoryUrl": { - "type": "string", - "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory." - }, - "updateTime": { - "description": "Output only. The last update timestamp of a Cloud Function.", - "format": "google-datetime", - "type": "string" - }, - "latestOperation": { - "type": "string", - "description": "Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation." - }, - "httpsTrigger": { - "$ref": "HTTPSTrigger", - "description": "An HTTPS endpoint type of source that can be triggered via URL." - }, - "timeout": { - "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.", - "format": "google-duration", - "type": "string" - }, - "status": { - "type": "string", - "enumDescriptions": [ - "Status not specified.", - "Successfully deployed.", - "Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.", - "Creation or update in progress.", - "Deletion in progress." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "READY", - "FAILED", - "DEPLOYING", - "DELETING" - ], - "description": "Output only. Status of the function deployment." - }, - "eventTrigger": { - "$ref": "EventTrigger", - "description": "A source that fires events in response to a condition in another service." - }, - "sourceUploadUrl": { - "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl", - "type": "string" - }, - "availableMemoryMb": { - "type": "integer", - "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.", - "format": "int32" - }, - "name": { - "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", - "type": "string" - }, - "versionId": { - "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.", - "format": "int64", - "type": "string" - }, - "serviceAccount": { - "description": "Output only. The service account of the function.", - "type": "string" - }, - "sourceArchiveUrl": { - "type": "string", - "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function." - }, - "sourceRepository": { - "$ref": "SourceRepository", - "description": "The hosted repository where the function is defined." - } - }, - "id": "CloudFunction", - "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations." - }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`" - }, - "locationId": { - "type": "string", - "description": "The canonical id for this location. For example: `\"us-east1\"`." - }, - "metadata": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", - "type": "object" - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}" - } - }, - "id": "Location" - }, - "GenerateDownloadUrlResponse": { - "description": "Response of `GenerateDownloadUrl` method.", - "type": "object", - "properties": { - "downloadUrl": { - "type": "string", - "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download." - } - }, - "id": "GenerateDownloadUrlResponse" - }, - "Retry": { - "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.", - "type": "object", - "properties": {}, - "id": "Retry" - }, - "GenerateUploadUrlRequest": { - "description": "Request of `GenerateUploadUrl` method.", - "type": "object", - "properties": {}, - "id": "GenerateUploadUrlRequest" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Operation" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListOperationsResponse" - }, - "GenerateUploadUrlResponse": { - "description": "Response of `GenerateUploadUrl` method.", - "type": "object", - "properties": { - "uploadUrl": { - "type": "string", - "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function." - } - }, - "id": "GenerateUploadUrlResponse" - }, - "ListFunctionsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1beta2.ListFunctionsRequest\nto get more functions." - }, - "functions": { - "type": "array", - "items": { - "$ref": "CloudFunction" - }, - "description": "The functions that match the request." - } - }, - "id": "ListFunctionsResponse", - "description": "Response for the `ListFunctions` method." - } - }, - "protocol": "rest", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "canonicalName": "Cloud Functions", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - } + "version": "v1beta2" }
diff --git a/cloudiot/v1/cloudiot-api.json b/cloudiot/v1/cloudiot-api.json index 951e731..35f7742 100644 --- a/cloudiot/v1/cloudiot-api.json +++ b/cloudiot/v1/cloudiot-api.json
@@ -1,4 +1,6 @@ { + "version": "v1", + "baseUrl": "https://cloudiot.googleapis.com/", "kind": "discovery#restDescription", "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n", "servicePath": "", @@ -9,95 +11,26 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { - "RegistryCredential": { - "description": "A server-stored registry credential used to validate device credentials.", - "type": "object", - "properties": { - "publicKeyCertificate": { - "$ref": "PublicKeyCertificate", - "description": "A public key certificate used to verify the device credentials." - } - }, - "id": "RegistryCredential" - }, - "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", - "type": "object", - "properties": { - "iamOwned": { - "type": "boolean" - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Deprecated.", - "format": "int32", - "type": "integer" - }, - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "type": "array", - "items": { - "$ref": "AuditConfig" - } - }, - "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - } - }, - "id": "Policy" - }, - "ListDeviceRegistriesResponse": { - "properties": { - "deviceRegistries": { - "description": "The registries that matched the query.", - "type": "array", - "items": { - "$ref": "DeviceRegistry" - } - }, - "nextPageToken": { - "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.", - "type": "string" - } - }, - "id": "ListDeviceRegistriesResponse", - "description": "Response for `ListDeviceRegistries`.", - "type": "object" - }, "DeviceRegistry": { + "id": "DeviceRegistry", "description": "A container for a group of devices.", "type": "object", "properties": { - "eventNotificationConfigs": { - "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used. If you\ntry to publish a device telemetry event using MQTT without specifying a\nCloud Pub/Sub topic for the device's registry, the connection closes\nautomatically. If you try to do so using an HTTP connection, an error\nis returned.", - "type": "array", - "items": { - "$ref": "EventNotificationConfig" - } - }, - "httpConfig": { - "$ref": "HttpConfig", - "description": "The DeviceService (HTTP) configuration for this device registry." - }, "id": { "description": "The identifier of this device registry. For example, `myRegistry`.", "type": "string" }, "mqttConfig": { - "description": "The MQTT configuration for this device registry.", - "$ref": "MqttConfig" + "$ref": "MqttConfig", + "description": "The MQTT configuration for this device registry." }, "stateNotificationConfig": { - "$ref": "StateNotificationConfig", - "description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core." + "description": "The configuration for notification of new states received from the device.\nState updates are guaranteed to be stored in the state history, but\nnotifications to Cloud Pub/Sub are not guaranteed. For example, if\npermissions are misconfigured or the specified topic doesn't exist, no\nnotification will be published but the state will still be stored in Cloud\nIoT Core.", + "$ref": "StateNotificationConfig" + }, + "name": { + "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", + "type": "string" }, "credentials": { "description": "The credentials used to verify the device credentials. No more than 10\ncredentials can be bound to a single registry at a time. The verification\nprocess occurs at the time of device creation or update. If this field is\nempty, no verification is performed. Otherwise, the credentials of a newly\ncreated device or added credentials of an updated device should be signed\nwith one of these registry credentials.\n\nNote, however, that existing devices will never be affected by\nmodifications to this list of credentials: after a device has been\nsuccessfully created in a registry, it should be able to connect even if\nits registry credentials are revoked, deleted, or modified.", @@ -106,62 +39,65 @@ "$ref": "RegistryCredential" } }, - "name": { - "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "type": "string" + "eventNotificationConfigs": { + "description": "The configuration for notification of telemetry events received from the\ndevice. All telemetry events that were successfully published by the\ndevice and acknowledged by Cloud IoT Core are guaranteed to be\ndelivered to Cloud Pub/Sub. Only the first configuration is used. If you\ntry to publish a device telemetry event using MQTT without specifying a\nCloud Pub/Sub topic for the device's registry, the connection closes\nautomatically. If you try to do so using an HTTP connection, an error\nis returned.", + "type": "array", + "items": { + "$ref": "EventNotificationConfig" + } + }, + "httpConfig": { + "description": "The DeviceService (HTTP) configuration for this device registry.", + "$ref": "HttpConfig" } - }, - "id": "DeviceRegistry" + } }, "ListDevicesResponse": { "description": "Response for `ListDevices`.", "type": "object", "properties": { - "devices": { - "description": "The devices that match the request.", - "type": "array", - "items": { - "$ref": "Device" - } - }, "nextPageToken": { "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.", "type": "string" + }, + "devices": { + "type": "array", + "items": { + "$ref": "Device" + }, + "description": "The devices that match the request." } }, "id": "ListDevicesResponse" }, "AuditConfig": { + "id": "AuditConfig", "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", "type": "object", "properties": { + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + }, "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.\nNext ID: 4", "type": "array", "items": { "$ref": "AuditLogConfig" - } + }, + "description": "The configuration for logging of each type of permission.\nNext ID: 4" }, "exemptedMembers": { "type": "array", "items": { "type": "string" } - }, - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" } - }, - "id": "AuditConfig" + } }, "HttpConfig": { - "description": "The configuration of the HTTP bridge for a device registry.", "type": "object", "properties": { "httpEnabledState": { - "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.", - "type": "string", "enumDescriptions": [ "No HTTP state specified. If not specified, DeviceService will be\nenabled by default.", "Enables DeviceService (HTTP) service for the registry.", @@ -171,28 +107,33 @@ "HTTP_STATE_UNSPECIFIED", "HTTP_ENABLED", "HTTP_DISABLED" - ] + ], + "description": "If enabled, allows devices to use DeviceService via the HTTP protocol.\nOtherwise, any requests to DeviceService will fail for this registry.", + "type": "string" } }, - "id": "HttpConfig" + "id": "HttpConfig", + "description": "The configuration of the HTTP bridge for a device registry." }, "DeviceCredential": { + "id": "DeviceCredential", "description": "A server-stored device credential used for authentication.", "type": "object", "properties": { + "publicKey": { + "$ref": "PublicKeyCredential", + "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate." + }, "expirationTime": { "description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.", "format": "google-datetime", "type": "string" - }, - "publicKey": { - "$ref": "PublicKeyCredential", - "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).\nWhen adding a new device credential, either via device creation or via\nmodifications, this public key credential may be required to be signed by\none of the registry level certificates. More specifically, if the\nregistry contains at least one certificate, any new device credential\nmust be signed by one of the registry certificates. As a result,\nwhen the registry contains certificates, only X.509 certificates are\naccepted as device credentials. However, if the registry does\nnot contain a certificate, self-signed certificates and public keys will\nbe accepted. New device credentials must be different from every\nregistry-level certificate." } - }, - "id": "DeviceCredential" + } }, "DeviceConfig": { + "description": "The device configuration. Eventually delivered to devices.", + "type": "object", "properties": { "version": { "description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than 0 after device creation. The\nversion must be 0 on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of 1.", @@ -215,11 +156,11 @@ "type": "string" } }, - "id": "DeviceConfig", - "description": "The device configuration. Eventually delivered to devices.", - "type": "object" + "id": "DeviceConfig" }, "MqttConfig": { + "description": "The configuration of MQTT for a device registry.", + "type": "object", "properties": { "mqttEnabledState": { "description": "If enabled, allows connections using the MQTT protocol. Otherwise, MQTT\nconnections to this registry will fail.", @@ -236,14 +177,16 @@ ] } }, - "id": "MqttConfig", - "description": "The configuration of MQTT for a device registry.", - "type": "object" + "id": "MqttConfig" }, "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.", "type": "object", "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" @@ -258,16 +201,14 @@ }, "type": "object" } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" } }, - "id": "Status" + "id": "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." }, "Binding": { + "description": "Associates `members` with a `role`.", + "type": "object", "properties": { "condition": { "$ref": "Expr", @@ -285,12 +226,9 @@ "type": "string" } }, - "id": "Binding", - "description": "Associates `members` with a `role`.", - "type": "object" + "id": "Binding" }, "Expr": { - "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", "type": "object", "properties": { "title": { @@ -310,9 +248,11 @@ "type": "string" } }, - "id": "Expr" + "id": "Expr", + "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"" }, "ModifyCloudToDeviceConfigRequest": { + "type": "object", "properties": { "versionToUpdate": { "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.", @@ -326,10 +266,12 @@ } }, "id": "ModifyCloudToDeviceConfigRequest", - "description": "Request for `ModifyCloudToDeviceConfig`.", - "type": "object" + "description": "Request for `ModifyCloudToDeviceConfig`." }, "ListDeviceStatesResponse": { + "id": "ListDeviceStatesResponse", + "description": "Response for `ListDeviceStates`.", + "type": "object", "properties": { "deviceStates": { "description": "The last few device states. States are listed in descending order of server\nupdate time, starting from the most recent one.", @@ -338,10 +280,21 @@ "$ref": "DeviceState" } } + } + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed." + } }, - "id": "ListDeviceStatesResponse", - "description": "Response for `ListDeviceStates`.", - "type": "object" + "id": "TestIamPermissionsResponse" }, "GetIamPolicyRequest": { "description": "Request message for `GetIamPolicy` method.", @@ -349,22 +302,50 @@ "properties": {}, "id": "GetIamPolicyRequest" }, - "TestIamPermissionsResponse": { + "Device": { + "description": "The device resource.", + "type": "object", "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "lastStateTime": { + "description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present.", + "$ref": "DeviceState" + }, + "config": { + "$ref": "DeviceConfig", + "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method." + }, + "name": { + "type": "string", + "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID." + }, + "credentials": { + "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.", "type": "array", "items": { - "type": "string" + "$ref": "DeviceCredential" } - } - }, - "id": "TestIamPermissionsResponse", - "description": "Response message for `TestIamPermissions` method.", - "type": "object" - }, - "Device": { - "properties": { + }, + "lastErrorTime": { + "description": "[Output only] The time the most recent error occurred, such as a failure to\npublish to Cloud Pub/Sub. This field is the timestamp of\n'last_error_status'.", + "format": "google-datetime", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "The metadata key-value pairs assigned to the device. This metadata is not\ninterpreted or indexed by Cloud IoT Core. It can be used to add contextual\ninformation for the device.\n\nKeys must conform to the regular expression [a-zA-Z0-9-_]+ and be less than\n128 bytes in length.\n\nValues are free-form strings. Each value must be less than or equal to 32\nKB in size.\n\nThe total size of all keys and values must be less than 256 KB, and the\nmaximum number of key-value pairs is 500.", + "type": "object" + }, + "id": { + "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.", + "type": "string" + }, "lastConfigAckTime": { "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device. This field is only for configurations\nsent through MQTT.", "format": "google-datetime", @@ -397,51 +378,9 @@ "lastErrorStatus": { "$ref": "Status", "description": "[Output only] The error message of the most recent error, such as a failure\nto publish to Cloud Pub/Sub. 'last_error_time' is the timestamp of this\nfield. If no errors have occurred, this field has an empty message\nand the status code 0 == OK. Otherwise, this field is expected to have a\nstatus code other than OK." - }, - "lastStateTime": { - "description": "[Output only] The last time a state event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "$ref": "DeviceState", - "description": "[Output only] The state most recently received from the device. If no state\nhas been reported, this field is not present." - }, - "config": { - "description": "The most recent device configuration, which is eventually sent from\nCloud IoT Core to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method.", - "$ref": "DeviceConfig" - }, - "name": { - "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.", - "type": "string" - }, - "credentials": { - "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time. When new credentials are added to a device, they are verified\nagainst the registry credentials. For details, see the description of the\n`DeviceRegistry.credentials` field.", - "type": "array", - "items": { - "$ref": "DeviceCredential" - } - }, - "lastErrorTime": { - "description": "[Output only] The time the most recent error occurred, such as a failure to\npublish to Cloud Pub/Sub. This field is the timestamp of\n'last_error_status'.", - "format": "google-datetime", - "type": "string" - }, - "metadata": { - "description": "The metadata key-value pairs assigned to the device. This metadata is not\ninterpreted or indexed by Cloud IoT Core. It can be used to add contextual\ninformation for the device.\n\nKeys must conform to the regular expression [a-zA-Z0-9-_]+ and be less than\n128 bytes in length.\n\nValues are free-form strings. Each value must be less than or equal to 32\nKB in size.\n\nThe total size of all keys and values must be less than 256 KB, and the\nmaximum number of key-value pairs is 500.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "id": { - "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.", - "type": "string" } }, - "id": "Device", - "description": "The device resource.", - "type": "object" + "id": "Device" }, "ListDeviceConfigVersionsResponse": { "description": "Response for `ListDeviceConfigVersions`.", @@ -458,21 +397,8 @@ "id": "ListDeviceConfigVersionsResponse" }, "X509CertificateDetails": { - "description": "Details of an X.509 certificate. For informational purposes only.", "type": "object", "properties": { - "subject": { - "description": "The entity the certificate and public key belong to.", - "type": "string" - }, - "issuer": { - "description": "The entity that signed the certificate.", - "type": "string" - }, - "publicKeyType": { - "description": "The type of public key in the certificate.", - "type": "string" - }, "signatureAlgorithm": { "description": "The algorithm used to sign the certificate.", "type": "string" @@ -486,51 +412,59 @@ "description": "The time the certificate becomes invalid.", "format": "google-datetime", "type": "string" + }, + "subject": { + "description": "The entity the certificate and public key belong to.", + "type": "string" + }, + "issuer": { + "description": "The entity that signed the certificate.", + "type": "string" + }, + "publicKeyType": { + "description": "The type of public key in the certificate.", + "type": "string" } }, - "id": "X509CertificateDetails" + "id": "X509CertificateDetails", + "description": "Details of an X.509 certificate. For informational purposes only." }, "EventNotificationConfig": { + "id": "EventNotificationConfig", + "description": "The configuration to forward telemetry events.", + "type": "object", "properties": { "pubsubTopicName": { "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.", "type": "string" } - }, - "id": "EventNotificationConfig", - "description": "The configuration to forward telemetry events.", - "type": "object" + } }, "SetIamPolicyRequest": { "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { "updateMask": { + "type": "string", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" + "format": "google-fieldmask" }, "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." } }, "id": "SetIamPolicyRequest" }, "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 `{}`.", - "type": "object", "properties": {}, - "id": "Empty" + "id": "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 `{}`.", + "type": "object" }, "PublicKeyCredential": { "properties": { - "key": { - "description": "The key data.", - "type": "string" - }, "format": { - "description": "The format of the key.", "type": "string", "enumDescriptions": [ "The format has not been specified. This is an invalid default value and\nmust not be used.", @@ -545,7 +479,12 @@ "RSA_X509_PEM", "ES256_PEM", "ES256_X509_PEM" - ] + ], + "description": "The format of the key." + }, + "key": { + "description": "The key data.", + "type": "string" } }, "id": "PublicKeyCredential", @@ -553,18 +492,17 @@ "type": "object" }, "PublicKeyCertificate": { + "id": "PublicKeyCertificate", "description": "A public key certificate format and data.", "type": "object", "properties": { - "certificate": { - "description": "The certificate data.", - "type": "string" - }, "x509Details": { "$ref": "X509CertificateDetails", "description": "[Output only] The certificate details. Used only for X.509 certificates." }, "format": { + "description": "The certificate format.", + "type": "string", "enumDescriptions": [ "The format has not been specified. This is an invalid default value and\nmust not be used.", "An X.509v3 certificate ([RFC5280](https://www.ietf.org/rfc/rfc5280.txt)),\nencoded in base64, and wrapped by `-----BEGIN CERTIFICATE-----` and\n`-----END CERTIFICATE-----`." @@ -572,14 +510,16 @@ "enum": [ "UNSPECIFIED_PUBLIC_KEY_CERTIFICATE_FORMAT", "X509_CERTIFICATE_PEM" - ], - "description": "The certificate format.", + ] + }, + "certificate": { + "description": "The certificate data.", "type": "string" } - }, - "id": "PublicKeyCertificate" + } }, "DeviceState": { + "id": "DeviceState", "description": "The device state, as reported by the device.", "type": "object", "properties": { @@ -589,22 +529,24 @@ "type": "string" }, "updateTime": { + "type": "string", "description": "[Output only] The time at which this state version was updated in Cloud\nIoT Core.", - "format": "google-datetime", - "type": "string" + "format": "google-datetime" } - }, - "id": "DeviceState" + } }, "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", + "type": "object", "properties": { + "exemptedMembers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members." + }, "logType": { - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", @@ -612,35 +554,19 @@ "DATA_READ" ], "description": "The log type that this config enables.", - "type": "string" - }, - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", - "type": "array", - "items": { - "type": "string" - } + "type": "string", + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ] } }, - "id": "AuditLogConfig", - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", - "type": "object" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" + "id": "AuditLogConfig" }, "StateNotificationConfig": { + "type": "object", "properties": { "pubsubTopicName": { "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.", @@ -648,24 +574,100 @@ } }, "id": "StateNotificationConfig", - "description": "The configuration for notification of new states received from the device.", - "type": "object" + "description": "The configuration for notification of new states received from the device." + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions)." + } + }, + "id": "TestIamPermissionsRequest" + }, + "Policy": { + "id": "Policy", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", + "type": "object", + "properties": { + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Deprecated.", + "format": "int32", + "type": "integer" + }, + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "type": "array", + "items": { + "$ref": "AuditConfig" + } + }, + "bindings": { + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + }, + "iamOwned": { + "type": "boolean" + } + } + }, + "RegistryCredential": { + "description": "A server-stored registry credential used to validate device credentials.", + "type": "object", + "properties": { + "publicKeyCertificate": { + "$ref": "PublicKeyCertificate", + "description": "A public key certificate used to verify the device credentials." + } + }, + "id": "RegistryCredential" + }, + "ListDeviceRegistriesResponse": { + "description": "Response for `ListDeviceRegistries`.", + "type": "object", + "properties": { + "deviceRegistries": { + "description": "The registries that matched the query.", + "type": "array", + "items": { + "$ref": "DeviceRegistry" + } + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.", + "type": "string" + } + }, + "id": "ListDeviceRegistriesResponse" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Cloud Iot", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloudiot": { - "description": "Register and manage devices in the Google Cloud IoT service" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloudiot": { + "description": "Register and manage devices in the Google Cloud IoT service" } } } @@ -685,35 +687,37 @@ "registries": { "methods": { "testIamPermissions": { - "path": "v1/{+resource}:testIamPermissions", "id": "cloudiot.projects.locations.registries.testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", + "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", + "httpMethod": "POST", "parameterOrder": [ "resource" ], - "httpMethod": "POST", + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameters": { + "resource": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field." + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudiot" ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" - } - }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions" }, "delete": { + "path": "v1/{+name}", + "id": "cloudiot.projects.locations.registries.delete", "description": "Deletes a device registry configuration.", "response": { "$ref": "Empty" @@ -722,100 +726,43 @@ "name" ], "httpMethod": "DELETE", + "parameters": { + "name": { + "location": "path", + "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudiot" ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path", - "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", - "path": "v1/{+name}", - "id": "cloudiot.projects.locations.registries.delete" + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}" }, "list": { + "httpMethod": "GET", "response": { "$ref": "ListDeviceRegistriesResponse" }, "parameterOrder": [ "parent" ], - "httpMethod": "GET", "parameters": { - "pageSize": { - "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "location": "path", - "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - }, "pageToken": { "description": "The value returned by the last `ListDeviceRegistriesResponse`; indicates\nthat this is a continuation of a prior `ListDeviceRegistries` call, and\nthat the system should return the next page of data.", "type": "string", "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries", - "path": "v1/{+parent}/registries", - "id": "cloudiot.projects.locations.registries.list", - "description": "Lists device registries." - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "cloudiot.projects.locations.registries.setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy." - }, - "create": { - "response": { - "$ref": "DeviceRegistry" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { + }, + "pageSize": { + "location": "query", + "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.", + "format": "int32", + "type": "integer" + }, "parent": { - "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.", + "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$", @@ -827,19 +774,49 @@ "https://www.googleapis.com/auth/cloudiot" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries", + "id": "cloudiot.projects.locations.registries.list", "path": "v1/{+parent}/registries", - "id": "cloudiot.projects.locations.registries.create", - "request": { - "$ref": "DeviceRegistry" - }, - "description": "Creates a device registry that contains devices." + "description": "Lists device registries." }, - "getIamPolicy": { + "setIamPolicy": { + "id": "cloudiot.projects.locations.registries.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], "response": { "$ref": "Policy" }, + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy" + }, + "create": { + "description": "Creates a device registry that contains devices.", + "request": { + "$ref": "DeviceRegistry" + }, + "response": { + "$ref": "DeviceRegistry" + }, "parameterOrder": [ - "resource" + "parent" ], "httpMethod": "POST", "scopes": [ @@ -847,72 +824,98 @@ "https://www.googleapis.com/auth/cloudiot" ], "parameters": { + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries", + "path": "v1/{+parent}/registries", + "id": "cloudiot.projects.locations.registries.create" + }, + "getIamPolicy": { + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { "resource": { + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", "location": "path", "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" + "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", "id": "cloudiot.projects.locations.registries.getIamPolicy", - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "path": "v1/{+resource}:getIamPolicy", "request": { "$ref": "GetIamPolicyRequest" - } + }, + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." }, "patch": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", - "id": "cloudiot.projects.locations.registries.patch", - "path": "v1/{+name}", - "request": { - "$ref": "DeviceRegistry" - }, - "description": "Updates a device registry configuration.", - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], "response": { "$ref": "DeviceRegistry" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], "parameters": { "updateMask": { - "location": "query", "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config`, `http_config`,\n`mqtt_config`, and `state_notification_config`.", "format": "google-fieldmask", - "type": "string" + "type": "string", + "location": "query" }, "name": { - "location": "path", "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", + "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ] + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", + "path": "v1/{+name}", + "id": "cloudiot.projects.locations.registries.patch", + "description": "Updates a device registry configuration.", + "request": { + "$ref": "DeviceRegistry" + } }, "get": { + "description": "Gets a device registry configuration.", + "httpMethod": "GET", "response": { "$ref": "DeviceRegistry" }, "parameterOrder": [ "name" ], - "httpMethod": "GET", "parameters": { "name": { + "required": true, + "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", "location": "path", - "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string" + "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`." } }, "scopes": [ @@ -920,44 +923,129 @@ "https://www.googleapis.com/auth/cloudiot" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", - "path": "v1/{+name}", "id": "cloudiot.projects.locations.registries.get", - "description": "Gets a device registry configuration." + "path": "v1/{+name}" } }, "resources": { "devices": { "methods": { + "get": { + "response": { + "$ref": "Device" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", + "location": "path", + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", + "required": true, + "type": "string" + }, + "fieldMask": { + "description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", + "path": "v1/{+name}", + "id": "cloudiot.projects.locations.registries.devices.get", + "description": "Gets details about a device." + }, + "patch": { + "request": { + "$ref": "Device" + }, + "description": "Updates a device.", + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Device" + }, + "parameters": { + "name": { + "location": "path", + "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$" + }, + "updateMask": { + "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", + "id": "cloudiot.projects.locations.registries.devices.patch", + "path": "v1/{+name}" + }, + "delete": { + "description": "Deletes a device.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "parameters": { + "name": { + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", + "path": "v1/{+name}", + "id": "cloudiot.projects.locations.registries.devices.delete" + }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices", - "path": "v1/{+parent}/devices", "id": "cloudiot.projects.locations.registries.devices.list", + "path": "v1/{+parent}/devices", "description": "List devices in a device registry.", + "httpMethod": "GET", "response": { "$ref": "ListDevicesResponse" }, "parameterOrder": [ "parent" ], - "httpMethod": "GET", "parameters": { - "deviceNumIds": { - "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.", - "format": "uint64", - "type": "string", - "repeated": true, - "location": "query" - }, "pageToken": { "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.", "type": "string", "location": "query" }, "fieldMask": { + "location": "query", "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.", @@ -965,18 +1053,25 @@ "type": "integer", "location": "query" }, - "parent": { - "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path" - }, "deviceIds": { "location": "query", "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.", "type": "string", "repeated": true + }, + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", + "location": "path", + "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.", + "required": true, + "type": "string" + }, + "deviceNumIds": { + "type": "string", + "repeated": true, + "location": "query", + "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.", + "format": "uint64" } }, "scopes": [ @@ -985,6 +1080,9 @@ ] }, "create": { + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices", + "path": "v1/{+parent}/devices", + "id": "cloudiot.projects.locations.registries.devices.create", "description": "Creates a device in a device registry.", "request": { "$ref": "Device" @@ -1002,24 +1100,15 @@ ], "parameters": { "parent": { + "location": "path", "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices", - "path": "v1/{+parent}/devices", - "id": "cloudiot.projects.locations.registries.devices.create" + } }, "modifyCloudToDeviceConfig": { - "path": "v1/{+name}:modifyCloudToDeviceConfig", - "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig", - "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata.", - "request": { - "$ref": "ModifyCloudToDeviceConfigRequest" - }, "response": { "$ref": "DeviceConfig" }, @@ -1027,123 +1116,32 @@ "name" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], "parameters": { "name": { - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig" - }, - "get": { - "description": "Gets details about a device.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Device" - }, - "parameters": { - "name": { - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - }, - "fieldMask": { - "description": "The fields of the `Device` resource to be returned in the response. If the\nfield mask is unset or empty, all fields are returned.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", - "id": "cloudiot.projects.locations.registries.devices.get", - "path": "v1/{+name}" - }, - "patch": { - "response": { - "$ref": "Device" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "parameters": { - "updateMask": { - "location": "query", - "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials`, `enabled_state`, and `metadata`", - "format": "google-fieldmask", - "type": "string" - }, - "name": { - "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", - "path": "v1/{+name}", - "id": "cloudiot.projects.locations.registries.devices.patch", - "description": "Updates a device.", - "request": { - "$ref": "Device" - } - }, - "delete": { - "path": "v1/{+name}", - "id": "cloudiot.projects.locations.registries.devices.delete", - "description": "Deletes a device.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { "location": "path", - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$" + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudiot" ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}" + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig", + "path": "v1/{+name}:modifyCloudToDeviceConfig", + "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig", + "request": { + "$ref": "ModifyCloudToDeviceConfigRequest" + }, + "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT Core servers. Returns the modified configuration version and\nits metadata." } }, "resources": { "configVersions": { "methods": { "list": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions", - "path": "v1/{+name}/configVersions", - "id": "cloudiot.projects.locations.registries.devices.configVersions.list", - "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).", "response": { "$ref": "ListDeviceConfigVersionsResponse" }, @@ -1152,16 +1150,55 @@ ], "httpMethod": "GET", "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path", - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string" - }, "numVersions": { + "type": "integer", "location": "query", "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.", + "format": "int32" + }, + "name": { + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions", + "path": "v1/{+name}/configVersions", + "id": "cloudiot.projects.locations.registries.devices.configVersions.list", + "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)." + } + } + }, + "states": { + "methods": { + "list": { + "id": "cloudiot.projects.locations.registries.devices.states.list", + "path": "v1/{+name}/states", + "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first).", + "httpMethod": "GET", + "response": { + "$ref": "ListDeviceStatesResponse" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", + "location": "path", + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`." + }, + "numStates": { + "location": "query", + "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.", "format": "int32", "type": "integer" } @@ -1169,43 +1206,8 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudiot" - ] - } - } - }, - "states": { - "methods": { - "list": { - "httpMethod": "GET", - "parameterOrder": [ - "name" ], - "response": { - "$ref": "ListDeviceStatesResponse" - }, - "parameters": { - "name": { - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - }, - "numStates": { - "description": "The number of states to list. States are listed in descending order of\nupdate time. The maximum number of states retained is 10. If this\nvalue is zero, it will return all the states available.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states", - "id": "cloudiot.projects.locations.registries.devices.states.list", - "path": "v1/{+name}/states", - "description": "Lists the last few versions of the device state in descending order (i.e.:\nnewest first)." + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/states" } } } @@ -1219,6 +1221,22 @@ } }, "parameters": { + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", @@ -1236,16 +1254,12 @@ "location": "query" }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" + "type": "string" }, "$.xgafv": { + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -1255,10 +1269,17 @@ "1", "2" ], - "description": "V1 error format.", - "type": "string" + "description": "V1 error format." + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "alt": { + "location": "query", + "description": "Data format for response.", + "default": "json", "enum": [ "json", "media", @@ -1269,43 +1290,22 @@ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" - ], - "location": "query", - "description": "Data format for response.", - "default": "json" - }, - "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.", - "type": "string", - "location": "query" + ] }, "access_token": { + "type": "string", "location": "query", - "description": "OAuth access token.", + "description": "OAuth access token." + }, + "key": { + "location": "query", + "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.", "type": "string" }, "quotaUser": { "location": "query", "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.", "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" } - }, - "version": "v1", - "baseUrl": "https://cloudiot.googleapis.com/" + } }
diff --git a/cloudiot/v1beta1/cloudiot-api.json b/cloudiot/v1beta1/cloudiot-api.json index 9cd0391..a4980e8 100644 --- a/cloudiot/v1beta1/cloudiot-api.json +++ b/cloudiot/v1beta1/cloudiot-api.json
@@ -1,100 +1,19 @@ { + "version": "v1beta1", + "baseUrl": "https://cloudiot.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n", + "servicePath": "", + "basePath": "", + "id": "cloudiot:v1beta1", + "documentationLink": "https://cloud.google.com/iot", + "revision": "20171227", "discoveryVersion": "v1", "version_module": true, "schemas": { - "Device": { - "properties": { - "numId": { - "description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique.", - "format": "uint64", - "type": "string" - }, - "config": { - "$ref": "DeviceConfig", - "description": "The most recent device configuration, which is eventually sent from the\nCloud IoT Core service to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method." - }, - "credentials": { - "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time.", - "type": "array", - "items": { - "$ref": "DeviceCredential" - } - }, - "name": { - "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.", - "type": "string" - }, - "lastErrorTime": { - "description": "[Output only] The last time an error happened, e.g., failed to publish to\nCloud Pub/Sub. This field is the timestamp of 'last_error_status'.", - "format": "google-datetime", - "type": "string" - }, - "id": { - "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.", - "type": "string" - }, - "enabledState": { - "enumDescriptions": [ - "No enabled state specified. If not specified, defaults to enabled\n(communication to Cloud IoT Core allowed).", - "Enables a device. By default, devices are enabled, allowing communication\nfrom the device to Cloud IoT Core. When a device is disabled, it is blocked\nfrom communicating with Cloud IoT Core.", - "Disables a device, blocking all communication from it to Cloud IoT Core." - ], - "enum": [ - "UNSPECIFIED_ENABLED_STATE", - "DEVICE_ENABLED", - "DEVICE_DISABLED" - ], - "description": "If a device is disabled, communication from it will be blocked. Can be used\nto temporarily prevent the device from connecting if, for example, the\nsensor is generating bad data and needs maintenance.", - "type": "string" - }, - "lastHeartbeatTime": { - "description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.", - "format": "google-datetime", - "type": "string" - }, - "lastEventTime": { - "description": "[Output only] The last time an event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.", - "format": "google-datetime", - "type": "string" - }, - "lastErrorStatus": { - "description": "[Output only] The error message of the last error, e.g., failed to publish\nto Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no\nerrors are present, this will have an empty message (whose status code is\n0 == OK), otherwise this field is expected to have a not-OK status code.", - "$ref": "Status" - }, - "lastConfigAckTime": { - "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "Device", - "description": "The device resource.", - "type": "object" - }, - "DeviceRegistry": { - "properties": { - "id": { - "description": "The identifier of this device registry. For example, `myRegistry`.", - "type": "string" - }, - "mqttConfig": { - "description": "The configuration of the MQTT broker associated with this device registry,\nincluding enablement, payload data format type, etc.", - "$ref": "MqttConfig" - }, - "name": { - "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "type": "string" - }, - "eventNotificationConfig": { - "description": "Configuration to notify events received from the device.", - "$ref": "NotificationConfig" - } - }, - "id": "DeviceRegistry", - "description": "A container for a group of devices.", - "type": "object" - }, "ListDeviceConfigVersionsResponse": { + "description": "Response for `ListDeviceConfigVersions`.", + "type": "object", "properties": { "deviceConfigs": { "description": "The device configuration for the last few versions. Versions are listed\nin decreasing order, starting from the most recent one.", @@ -104,56 +23,55 @@ } } }, - "id": "ListDeviceConfigVersionsResponse", - "description": "Response for `ListDeviceConfigVersions`.", - "type": "object" + "id": "ListDeviceConfigVersionsResponse" }, "ListDevicesResponse": { "description": "Response for `ListDevices`.", "type": "object", "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`.", - "type": "string" - }, "devices": { - "description": "The devices that match the request.", "type": "array", "items": { "$ref": "Device" - } + }, + "description": "The devices that match the request." + }, + "nextPageToken": { + "type": "string", + "description": "If not empty, indicates that there may be more devices that match the\nrequest; this value should be passed in a new `ListDevicesRequest`." } }, "id": "ListDevicesResponse" }, "DeviceCredential": { - "description": "A server-stored device credential used for authentication.", "type": "object", "properties": { "expirationTime": { + "type": "string", "description": "[Optional] The time at which this credential becomes invalid. This\ncredential will be ignored for new client authentication requests after\nthis timestamp; however, it will not be automatically deleted.", - "format": "google-datetime", - "type": "string" + "format": "google-datetime" }, "publicKey": { - "description": "A public key used to verify the signature of JSON Web Tokens (JWTs).", - "$ref": "PublicKeyCredential" + "$ref": "PublicKeyCredential", + "description": "A public key used to verify the signature of JSON Web Tokens (JWTs)." } }, - "id": "DeviceCredential" + "id": "DeviceCredential", + "description": "A server-stored device credential used for authentication." }, "AuditConfig": { + "type": "object", "properties": { "service": { "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", "type": "string" }, "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.\nNext ID: 4", "type": "array", "items": { "$ref": "AuditLogConfig" - } + }, + "description": "The configuration for logging of each type of permission.\nNext ID: 4" }, "exemptedMembers": { "type": "array", @@ -163,22 +81,21 @@ } }, "id": "AuditConfig", - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", - "type": "object" + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging." }, "DeviceConfig": { "description": "The device configuration and its metadata. Eventually delivered to devices.", "type": "object", "properties": { "version": { + "type": "string", "description": "[Output only] The version of this update. The version number is assigned by\nthe server, and is always greater than zero after device creation. The\nversion must be zero on the `CreateDevice` request if a `config` is\nspecified; the response of `CreateDevice` will always have a value of one.", - "format": "int64", - "type": "string" + "format": "int64" }, "cloudUpdateTime": { + "type": "string", "description": "[Output only] The time when this version state was updated in the Cloud IoT\nCore service. This timestamp is set by the server.", - "format": "google-datetime", - "type": "string" + "format": "google-datetime" }, "deviceAckTime": { "description": "[Output only] The time when the Cloud IoT Core server received the\nacknowledgment from the device, indicating that the device has received\nthis configuration version. If this field is not present, the device has\nnot yet acknowledged that it received this version. Note that when sending\nthe config to the device, there may have been many config versions on the\nCloud IoT Core service while the device was disconnected; and on\nconnection, only the latest version is sent to the device. Some of the\nversions may never be sent to the device, and therefore are never\nacknowledged. This timestamp is set by the Cloud IoT Core service.", @@ -193,6 +110,7 @@ "id": "DeviceConfig" }, "MqttConfig": { + "type": "object", "properties": { "mqttConfigState": { "enum": [ @@ -210,54 +128,52 @@ } }, "id": "MqttConfig", - "description": "The configuration of MQTT for a device registry.", - "type": "object" + "description": "The configuration of MQTT for a device registry." }, "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", "properties": { - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" - }, "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + }, + "updateMask": { + "type": "string", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "format": "google-fieldmask" } }, - "id": "SetIamPolicyRequest", - "description": "Request message for `SetIamPolicy` method.", - "type": "object" + "id": "SetIamPolicyRequest" }, "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.", "type": "object", "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 is a common set of\nmessage types for APIs to use.", "type": "array", "items": { "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "type": "any", + "description": "Properties of the object. Contains field @type with type URL." }, "type": "object" } }, "code": { + "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" + "format": "int32" + }, + "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" } }, "id": "Status" }, "Binding": { - "description": "Associates `members` with a `role`.", "type": "object", "properties": { "condition": { @@ -276,16 +192,23 @@ "type": "string" } }, - "id": "Binding" + "id": "Binding", + "description": "Associates `members` with a `role`." }, "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 `{}`.", "type": "object", "properties": {}, - "id": "Empty" + "id": "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 `{}`." }, "Expr": { + "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", + "type": "object", "properties": { + "expression": { + "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", + "type": "string" + }, "title": { "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", "type": "string" @@ -297,17 +220,12 @@ "description": { "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", - "type": "string" } }, - "id": "Expr", - "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", - "type": "object" + "id": "Expr" }, "DeviceConfigData": { + "type": "object", "properties": { "binaryData": { "description": "The configuration sent to the device, as bytes.", @@ -316,41 +234,39 @@ } }, "id": "DeviceConfigData", - "description": "The data for a device configuration. Only binary data is currently supported.", - "type": "object" + "description": "The data for a device configuration. Only binary data is currently supported." }, "PublicKeyCredential": { + "description": "A public key format and data.", + "type": "object", "properties": { "key": { - "description": "The key data.", - "type": "string" + "type": "string", + "description": "The key data." }, "format": { - "enumDescriptions": [ - "The format has not been specified. This is an invalid default value and\nmust not be used.", - "An RSA public key wrapped in a X.509v3 certificate\n[RFC5280](https://www.ietf.org/rfc/rfc5280.txt), encoded in base64, and\nwrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.\nThis can be used to verify `RS256` signatures in JWT tokens\n[RFC7518](https://www.ietf.org/rfc/rfc7518.txt).", - "Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm [RFC7518](https://www.ietf.org/rfc/rfc7518.txt). This curve is\ndefined in [openssl](https://www.openssl.org/) as the `prime256v1` curve." - ], "enum": [ "UNSPECIFIED_PUBLIC_KEY_FORMAT", "RSA_X509_PEM", "ES256_PEM" ], "description": "The format of the key.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "The format has not been specified. This is an invalid default value and\nmust not be used.", + "An RSA public key wrapped in a X.509v3 certificate\n[RFC5280](https://www.ietf.org/rfc/rfc5280.txt), encoded in base64, and\nwrapped by `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----`.\nThis can be used to verify `RS256` signatures in JWT tokens\n[RFC7518](https://www.ietf.org/rfc/rfc7518.txt).", + "Public key for the ECDSA algorithm using P-256 and SHA-256, encoded in\nbase64, and wrapped by `-----BEGIN PUBLIC KEY-----` and `-----END\nPUBLIC KEY-----`. This can be used to verify JWT tokens with the `ES256`\nalgorithm [RFC7518](https://www.ietf.org/rfc/rfc7518.txt). This curve is\ndefined in [openssl](https://www.openssl.org/) as the `prime256v1` curve." + ] } }, - "id": "PublicKeyCredential", - "description": "A public key format and data.", - "type": "object" + "id": "PublicKeyCredential" }, "ModifyCloudToDeviceConfigRequest": { - "description": "Request for `ModifyCloudToDeviceConfig`.", "type": "object", "properties": { "data": { - "description": "The configuration data for the device.", - "$ref": "DeviceConfigData" + "$ref": "DeviceConfigData", + "description": "The configuration data for the device." }, "versionToUpdate": { "description": "The version number to update. If this value is zero, it will not check the\nversion number of the server and will always update the current version;\notherwise, this update will fail if the version number found on the server\ndoes not match this version number. This is used to support multiple\nsimultaneous updates without losing data.", @@ -358,7 +274,8 @@ "type": "string" } }, - "id": "ModifyCloudToDeviceConfigRequest" + "id": "ModifyCloudToDeviceConfigRequest", + "description": "Request for `ModifyCloudToDeviceConfig`." }, "GetIamPolicyRequest": { "description": "Request message for `GetIamPolicy` method.", @@ -367,35 +284,31 @@ "id": "GetIamPolicyRequest" }, "TestIamPermissionsResponse": { + "type": "object", "properties": { "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", "type": "array", "items": { "type": "string" - } + }, + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed." } }, "id": "TestIamPermissionsResponse", - "description": "Response message for `TestIamPermissions` method.", - "type": "object" + "description": "Response message for `TestIamPermissions` method." }, "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", + "type": "object", "properties": { "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", "type": "array", "items": { "type": "string" - } + }, + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members." }, "logType": { - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", @@ -403,14 +316,19 @@ "DATA_READ" ], "description": "The log type that this config enables.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ] } }, - "id": "AuditLogConfig", - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", - "type": "object" + "id": "AuditLogConfig" }, "NotificationConfig": { + "type": "object", "properties": { "pubsubTopicName": { "description": "A Cloud Pub/Sub topic name. For example,\n`projects/myProject/topics/deviceEvents`.", @@ -418,10 +336,10 @@ } }, "id": "NotificationConfig", - "description": "Configuration to forward messages such as telemetry events.", - "type": "object" + "description": "Configuration to forward messages such as telemetry events." }, "TestIamPermissionsRequest": { + "type": "object", "properties": { "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", @@ -432,20 +350,20 @@ } }, "id": "TestIamPermissionsRequest", - "description": "Request message for `TestIamPermissions` method.", - "type": "object" + "description": "Request message for `TestIamPermissions` method." }, "Policy": { + "type": "object", "properties": { "etag": { + "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" + "format": "byte" }, "version": { + "type": "integer", "description": "Deprecated.", - "format": "int32", - "type": "integer" + "format": "int32" }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", @@ -455,37 +373,128 @@ } }, "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", "type": "array", "items": { "$ref": "Binding" - } + }, + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error." }, "iamOwned": { "type": "boolean" } }, "id": "Policy", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", - "type": "object" + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs)." }, "ListDeviceRegistriesResponse": { + "description": "Response for `ListDeviceRegistries`.", + "type": "object", "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.", - "type": "string" - }, "deviceRegistries": { "description": "The registries that matched the query.", "type": "array", "items": { "$ref": "DeviceRegistry" } + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more registries that match the\nrequest; this value should be passed in a new\n`ListDeviceRegistriesRequest`.", + "type": "string" } }, - "id": "ListDeviceRegistriesResponse", - "description": "Response for `ListDeviceRegistries`.", - "type": "object" + "id": "ListDeviceRegistriesResponse" + }, + "Device": { + "description": "The device resource.", + "type": "object", + "properties": { + "id": { + "description": "The user-defined device identifier. The device ID must be unique\nwithin a device registry.", + "type": "string" + }, + "enabledState": { + "type": "string", + "enumDescriptions": [ + "No enabled state specified. If not specified, defaults to enabled\n(communication to Cloud IoT Core allowed).", + "Enables a device. By default, devices are enabled, allowing communication\nfrom the device to Cloud IoT Core. When a device is disabled, it is blocked\nfrom communicating with Cloud IoT Core.", + "Disables a device, blocking all communication from it to Cloud IoT Core." + ], + "enum": [ + "UNSPECIFIED_ENABLED_STATE", + "DEVICE_ENABLED", + "DEVICE_DISABLED" + ], + "description": "If a device is disabled, communication from it will be blocked. Can be used\nto temporarily prevent the device from connecting if, for example, the\nsensor is generating bad data and needs maintenance." + }, + "lastHeartbeatTime": { + "type": "string", + "description": "[Output only] The last time a heartbeat was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.", + "format": "google-datetime" + }, + "lastEventTime": { + "description": "[Output only] The last time an event was received. Timestamps are\nperiodically collected and written to storage; they may be stale by a few\nminutes.", + "format": "google-datetime", + "type": "string" + }, + "lastErrorStatus": { + "$ref": "Status", + "description": "[Output only] The error message of the last error, e.g., failed to publish\nto Cloud Pub/Sub. 'last_error_time' is the timestamp of this field. If no\nerrors are present, this will have an empty message (whose status code is\n0 == OK), otherwise this field is expected to have a not-OK status code." + }, + "lastConfigAckTime": { + "description": "[Output only] The last time a cloud-to-device config version acknowledgment\nwas received from the device.", + "format": "google-datetime", + "type": "string" + }, + "numId": { + "description": "[Output only] A server-defined unique numeric ID for the device. This is a\nmore compact way to identify devices, and it is globally unique.", + "format": "uint64", + "type": "string" + }, + "config": { + "$ref": "DeviceConfig", + "description": "The most recent device configuration, which is eventually sent from the\nCloud IoT Core service to the device. If not present on creation, the\nconfiguration will be initialized with an empty payload and version value\nof `1`. To update this field after creation, use the\n`DeviceManager.ModifyCloudToDeviceConfig` method." + }, + "credentials": { + "type": "array", + "items": { + "$ref": "DeviceCredential" + }, + "description": "The credentials used to authenticate this device. To allow credential\nrotation without interruption, multiple device credentials can be bound to\nthis device. No more than 3 credentials can be bound to a single device at\na time." + }, + "name": { + "type": "string", + "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID." + }, + "lastErrorTime": { + "type": "string", + "description": "[Output only] The last time an error happened, e.g., failed to publish to\nCloud Pub/Sub. This field is the timestamp of 'last_error_status'.", + "format": "google-datetime" + } + }, + "id": "Device" + }, + "DeviceRegistry": { + "type": "object", + "properties": { + "mqttConfig": { + "$ref": "MqttConfig", + "description": "The configuration of the MQTT broker associated with this device registry,\nincluding enablement, payload data format type, etc." + }, + "name": { + "type": "string", + "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`." + }, + "eventNotificationConfig": { + "$ref": "NotificationConfig", + "description": "Configuration to notify events received from the device." + }, + "id": { + "type": "string", + "description": "The identifier of this device registry. For example, `myRegistry`." + } + }, + "id": "DeviceRegistry", + "description": "A container for a group of devices." } }, "protocol": "rest", @@ -519,371 +528,7 @@ "locations": { "resources": { "registries": { - "resources": { - "devices": { - "methods": { - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "Device" - }, - "parameters": { - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path", - "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices", - "id": "cloudiot.projects.locations.registries.devices.create", - "path": "v1beta1/{+parent}/devices", - "request": { - "$ref": "Device" - }, - "description": "Creates a device in a device registry." - }, - "modifyCloudToDeviceConfig": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "DeviceConfig" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path", - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig", - "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig", - "path": "v1beta1/{+name}:modifyCloudToDeviceConfig", - "request": { - "$ref": "ModifyCloudToDeviceConfigRequest" - }, - "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT servers. Returns the modified configuration version and its\nmeta-data." - }, - "get": { - "description": "Gets details about a device.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Device" - }, - "parameters": { - "name": { - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", - "id": "cloudiot.projects.locations.registries.devices.get", - "path": "v1beta1/{+name}" - }, - "patch": { - "response": { - "$ref": "Device" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path", - "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials` and `enabled_state`", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", - "path": "v1beta1/{+name}", - "id": "cloudiot.projects.locations.registries.devices.patch", - "description": "Updates a device.", - "request": { - "$ref": "Device" - } - }, - "delete": { - "id": "cloudiot.projects.locations.registries.devices.delete", - "path": "v1beta1/{+name}", - "description": "Deletes a device.", - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}" - }, - "list": { - "path": "v1beta1/{+parent}/devices", - "id": "cloudiot.projects.locations.registries.devices.list", - "description": "List devices in a device registry.", - "response": { - "$ref": "ListDevicesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "location": "query", - "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.", - "type": "string" - }, - "fieldMask": { - "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path" - }, - "deviceIds": { - "repeated": true, - "location": "query", - "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.", - "type": "string" - }, - "deviceNumIds": { - "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.", - "format": "uint64", - "type": "string", - "repeated": true, - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices" - } - }, - "resources": { - "configVersions": { - "methods": { - "list": { - "response": { - "$ref": "ListDeviceConfigVersionsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "parameters": { - "name": { - "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", - "location": "path" - }, - "numVersions": { - "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions", - "path": "v1beta1/{+name}/configVersions", - "id": "cloudiot.projects.locations.registries.devices.configVersions.list", - "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first)." - } - } - } - } - } - }, "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy", - "path": "v1beta1/{+resource}:getIamPolicy", - "id": "cloudiot.projects.locations.registries.getIamPolicy" - }, - "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "DeviceRegistry" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path", - "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", - "id": "cloudiot.projects.locations.registries.get", - "path": "v1beta1/{+name}", - "description": "Gets a device registry configuration." - }, - "patch": { - "request": { - "$ref": "DeviceRegistry" - }, - "description": "Updates a device registry configuration.", - "response": { - "$ref": "DeviceRegistry" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path", - "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config` and `mqtt_config`", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", - "path": "v1beta1/{+name}", - "id": "cloudiot.projects.locations.registries.patch" - }, - "testIamPermissions": { - "id": "cloudiot.projects.locations.registries.testIamPermissions", - "path": "v1beta1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions" - }, "delete": { "response": { "$ref": "Empty" @@ -898,11 +543,11 @@ ], "parameters": { "name": { + "location": "path", "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" } }, "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", @@ -925,17 +570,17 @@ "type": "string" }, "pageSize": { + "type": "integer", "location": "query", "description": "The maximum number of registries to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.", - "format": "int32", - "type": "integer" + "format": "int32" }, "parent": { + "location": "path", "description": "The project and cloud region path. For example,\n`projects/example-project/locations/us-central1`.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ @@ -948,6 +593,9 @@ "description": "Lists device registries." }, "create": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries", + "path": "v1beta1/{+parent}/registries", + "id": "cloudiot.projects.locations.registries.create", "request": { "$ref": "DeviceRegistry" }, @@ -961,22 +609,26 @@ "httpMethod": "POST", "parameters": { "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "The project and cloud region where this device registry must be created.\nFor example, `projects/example-project/locations/us-central1`.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudiot" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries", - "path": "v1beta1/{+parent}/registries", - "id": "cloudiot.projects.locations.registries.create" + ] }, "setIamPolicy": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy", + "id": "cloudiot.projects.locations.registries.setIamPolicy", + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "httpMethod": "POST", "parameterOrder": [ "resource" @@ -986,24 +638,381 @@ }, "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", - "location": "path" + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ] + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "parameters": { + "resource": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field." + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:getIamPolicy", + "path": "v1beta1/{+resource}:getIamPolicy", + "id": "cloudiot.projects.locations.registries.getIamPolicy" + }, + "get": { + "description": "Gets a device registry configuration.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "DeviceRegistry" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name of the device registry. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudiot" ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:setIamPolicy", - "id": "cloudiot.projects.locations.registries.setIamPolicy", - "path": "v1beta1/{+resource}:setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", + "id": "cloudiot.projects.locations.registries.get", + "path": "v1beta1/{+name}" + }, + "patch": { + "response": { + "$ref": "DeviceRegistry" }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy." + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "updateMask": { + "location": "query", + "description": "Only updates the `device_registry` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `event_notification_config` and `mqtt_config`", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "location": "path", + "description": "The resource path name. For example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}", + "path": "v1beta1/{+name}", + "id": "cloudiot.projects.locations.registries.patch", + "request": { + "$ref": "DeviceRegistry" + }, + "description": "Updates a device registry configuration." + }, + "testIamPermissions": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}:testIamPermissions", + "id": "cloudiot.projects.locations.registries.testIamPermissions", + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameters": { + "resource": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ] + } + }, + "resources": { + "devices": { + "methods": { + "list": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices", + "path": "v1beta1/{+parent}/devices", + "id": "cloudiot.projects.locations.registries.devices.list", + "description": "List devices in a device registry.", + "response": { + "$ref": "ListDevicesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "location": "query", + "description": "The value returned by the last `ListDevicesResponse`; indicates\nthat this is a continuation of a prior `ListDevices` call, and\nthat the system should return the next page of data.", + "type": "string" + }, + "fieldMask": { + "location": "query", + "description": "The fields of the `Device` resource to be returned in the response. The\nfields `id`, and `num_id` are always returned by default, along with any\nother fields specified.", + "format": "google-fieldmask", + "type": "string" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "The maximum number of devices to return in the response. If this value\nis zero, the service will select a default size. A call may return fewer\nobjects than requested, but if there is a non-empty `page_token`, it\nindicates that more entries are available.", + "format": "int32" + }, + "parent": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$", + "location": "path", + "description": "The device registry path. Required. For example,\n`projects/my-project/locations/us-central1/registries/my-registry`." + }, + "deviceIds": { + "location": "query", + "description": "A list of device string identifiers. If empty, it will ignore this field.\nFor example, `['device0', 'device12']`. This field cannot hold more than\n10,000 entries.", + "type": "string", + "repeated": true + }, + "deviceNumIds": { + "type": "string", + "repeated": true, + "location": "query", + "description": "A list of device numerical ids. If empty, it will ignore this field. This\nfield cannot hold more than 10,000 entries.", + "format": "uint64" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ] + }, + "create": { + "request": { + "$ref": "Device" + }, + "description": "Creates a device in a device registry.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Device" + }, + "parameters": { + "parent": { + "location": "path", + "description": "The name of the device registry where this device should be created.\nFor example,\n`projects/example-project/locations/us-central1/registries/my-registry`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices", + "id": "cloudiot.projects.locations.registries.devices.create", + "path": "v1beta1/{+parent}/devices" + }, + "modifyCloudToDeviceConfig": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}:modifyCloudToDeviceConfig", + "id": "cloudiot.projects.locations.registries.devices.modifyCloudToDeviceConfig", + "path": "v1beta1/{+name}:modifyCloudToDeviceConfig", + "request": { + "$ref": "ModifyCloudToDeviceConfigRequest" + }, + "description": "Modifies the configuration for the device, which is eventually sent from\nthe Cloud IoT servers. Returns the modified configuration version and its\nmeta-data.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "DeviceConfig" + }, + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", + "location": "path", + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ] + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Device" + }, + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$", + "location": "path", + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", + "id": "cloudiot.projects.locations.registries.devices.get", + "path": "v1beta1/{+name}", + "description": "Gets details about a device." + }, + "patch": { + "response": { + "$ref": "Device" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "parameters": { + "name": { + "location": "path", + "description": "The resource path name. For example,\n`projects/p1/locations/us-central1/registries/registry0/devices/dev0` or\n`projects/p1/locations/us-central1/registries/registry0/devices/{num_id}`.\nWhen `name` is populated as a response from the service, it always ends\nin the device numeric ID.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$" + }, + "updateMask": { + "type": "string", + "location": "query", + "description": "Only updates the `device` fields indicated by this mask.\nThe field mask must not be empty, and it must not contain fields that\nare immutable or only set by the server.\nMutable top-level fields: `credentials` and `enabled_state`", + "format": "google-fieldmask" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", + "path": "v1beta1/{+name}", + "id": "cloudiot.projects.locations.registries.devices.patch", + "description": "Updates a device.", + "request": { + "$ref": "Device" + } + }, + "delete": { + "description": "Deletes a device.", + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}", + "id": "cloudiot.projects.locations.registries.devices.delete", + "path": "v1beta1/{+name}" + } + }, + "resources": { + "configVersions": { + "methods": { + "list": { + "description": "Lists the last few versions of the device configuration in descending\norder (i.e.: newest first).", + "response": { + "$ref": "ListDeviceConfigVersionsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudiot" + ], + "parameters": { + "numVersions": { + "location": "query", + "description": "The number of versions to list. Versions are listed in decreasing order of\nthe version number. The maximum number of versions retained is 10. If this\nvalue is zero, it will return all the versions available.", + "format": "int32", + "type": "integer" + }, + "name": { + "location": "path", + "description": "The name of the device. For example,\n`projects/p0/locations/us-central1/registries/registry0/devices/device0` or\n`projects/p0/locations/us-central1/registries/registry0/devices/{num_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/registries/[^/]+/devices/[^/]+$" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/registries/{registriesId}/devices/{devicesId}/configVersions", + "path": "v1beta1/{+name}/configVersions", + "id": "cloudiot.projects.locations.registries.devices.configVersions.list" + } + } + } + } } } } @@ -1013,31 +1022,26 @@ } }, "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.", - "type": "string", - "location": "query" - }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "oauth_token": { + "type": "string", "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" + "description": "OAuth 2.0 token for the current user." }, "bearer_token": { + "location": "query", "description": "OAuth bearer token.", - "type": "string", - "location": "query" + "type": "string" }, "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", - "location": "query" + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { "location": "query", @@ -1046,34 +1050,35 @@ "default": "true" }, "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", - "location": "query" + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." }, "fields": { + "type": "string", "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "description": "Selector specifying which fields to include in a partial response." }, "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ] }, "callback": { - "description": "JSONP", "type": "string", - "location": "query" + "location": "query", + "description": "JSONP" }, "alt": { + "location": "query", "description": "Data format for response.", "default": "json", "enum": [ @@ -1086,27 +1091,22 @@ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" - ], - "location": "query" + ] }, "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.", "type": "string", - "location": "query" + "location": "query", + "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." }, "access_token": { + "location": "query", "description": "OAuth access token.", - "type": "string", - "location": "query" + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" } - }, - "version": "v1beta1", - "baseUrl": "https://cloudiot.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Registers and manages IoT (Internet of Things) devices that connect to the Google Cloud Platform.\n", - "servicePath": "", - "basePath": "", - "id": "cloudiot:v1beta1", - "documentationLink": "https://cloud.google.com/iot", - "revision": "20171227" + } }
diff --git a/cloudkms/v1/cloudkms-api.json b/cloudkms/v1/cloudkms-api.json index 70d83ed..f9321b8 100644 --- a/cloudkms/v1/cloudkms-api.json +++ b/cloudkms/v1/cloudkms-api.json
@@ -1,4 +1,523 @@ { + "servicePath": "", + "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.", + "kind": "discovery#restDescription", + "basePath": "", + "revision": "20171218", + "documentationLink": "https://cloud.google.com/kms/", + "id": "cloudkms:v1", + "discoveryVersion": "v1", + "version_module": true, + "schemas": { + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsResponse" + }, + "DestroyCryptoKeyVersionRequest": { + "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.", + "type": "object", + "properties": {}, + "id": "DestroyCryptoKeyVersionRequest" + }, + "AuditLogConfig": { + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", + "type": "array", + "items": { + "type": "string" + } + }, + "logType": { + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "description": "The log type that this config enables.", + "type": "string" + } + }, + "id": "AuditLogConfig", + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", + "type": "object" + }, + "CryptoKey": { + "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.", + "type": "object", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).", + "type": "object" + }, + "createTime": { + "description": "Output only. The time at which this CryptoKey was created.", + "format": "google-datetime", + "type": "string" + }, + "rotationPeriod": { + "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.", + "format": "google-duration", + "type": "string" + }, + "primary": { + "$ref": "CryptoKeyVersion", + "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion." + }, + "name": { + "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", + "type": "string" + }, + "purpose": { + "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt." + ], + "enum": [ + "CRYPTO_KEY_PURPOSE_UNSPECIFIED", + "ENCRYPT_DECRYPT" + ] + }, + "nextRotationTime": { + "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "CryptoKey" + }, + "DecryptResponse": { + "description": "Response message for KeyManagementService.Decrypt.", + "type": "object", + "properties": { + "plaintext": { + "description": "The decrypted data originally supplied in EncryptRequest.plaintext.", + "format": "byte", + "type": "string" + } + }, + "id": "DecryptResponse" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest" + }, + "EncryptResponse": { + "description": "Response message for KeyManagementService.Encrypt.", + "type": "object", + "properties": { + "name": { + "description": "The resource name of the CryptoKeyVersion used in encryption.", + "type": "string" + }, + "ciphertext": { + "description": "The encrypted data.", + "format": "byte", + "type": "string" + } + }, + "id": "EncryptResponse" + }, + "KeyRing": { + "properties": { + "createTime": { + "description": "Output only. The time at which this KeyRing was created.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.", + "type": "string" + } + }, + "id": "KeyRing", + "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.", + "type": "object" + }, + "Policy": { + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", + "type": "object", + "properties": { + "iamOwned": { + "type": "boolean" + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32", + "type": "integer" + }, + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "type": "array", + "items": { + "$ref": "AuditConfig" + } + }, + "bindings": { + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + } + }, + "id": "Policy" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "type": "object", + "properties": { + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Location" + } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "id": "ListLocationsResponse" + }, + "UpdateCryptoKeyPrimaryVersionRequest": { + "properties": { + "cryptoKeyVersionId": { + "description": "The id of the child CryptoKeyVersion to use as primary.", + "type": "string" + } + }, + "id": "UpdateCryptoKeyPrimaryVersionRequest", + "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.", + "type": "object" + }, + "RestoreCryptoKeyVersionRequest": { + "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.", + "type": "object", + "properties": {}, + "id": "RestoreCryptoKeyVersionRequest" + }, + "ListKeyRingsResponse": { + "description": "Response message for KeyManagementService.ListKeyRings.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.", + "type": "string" + }, + "totalSize": { + "description": "The total number of KeyRings that matched the query.", + "format": "int32", + "type": "integer" + }, + "keyRings": { + "description": "The list of KeyRings.", + "type": "array", + "items": { + "$ref": "KeyRing" + } + } + }, + "id": "ListKeyRingsResponse" + }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", + "type": "object", + "properties": { + "exemptedMembers": { + "type": "array", + "items": { + "type": "string" + } + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + }, + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.\nNext ID: 4", + "type": "array", + "items": { + "$ref": "AuditLogConfig" + } + } + }, + "id": "AuditConfig" + }, + "CryptoKeyVersion": { + "description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.", + "type": "object", + "properties": { + "destroyEventTime": { + "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.", + "format": "google-datetime", + "type": "string" + }, + "destroyTime": { + "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.", + "format": "google-datetime", + "type": "string" + }, + "createTime": { + "description": "Output only. The time at which this CryptoKeyVersion was created.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "enumDescriptions": [ + "Not specified.", + "This version may be used in Encrypt and\nDecrypt requests.", + "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.", + "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.", + "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state." + ], + "enum": [ + "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", + "ENABLED", + "DISABLED", + "DESTROYED", + "DESTROY_SCHEDULED" + ], + "description": "The current state of the CryptoKeyVersion.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", + "type": "string" + } + }, + "id": "CryptoKeyVersion" + }, + "SetIamPolicyRequest": { + "properties": { + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "format": "google-fieldmask", + "type": "string" + }, + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest", + "description": "Request message for `SetIamPolicy` method.", + "type": "object" + }, + "DecryptRequest": { + "properties": { + "ciphertext": { + "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.", + "format": "byte", + "type": "string" + }, + "additionalAuthenticatedData": { + "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.", + "format": "byte", + "type": "string" + } + }, + "id": "DecryptRequest", + "description": "Request message for KeyManagementService.Decrypt.", + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "type": "object", + "properties": { + "condition": { + "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.", + "$ref": "Expr" + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + } + }, + "id": "Binding" + }, + "Expr": { + "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", + "type": "object", + "properties": { + "title": { + "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", + "type": "string" + }, + "location": { + "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", + "type": "string" + }, + "description": { + "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", + "type": "string" + } + }, + "id": "Expr" + }, + "EncryptRequest": { + "description": "Request message for KeyManagementService.Encrypt.", + "type": "object", + "properties": { + "additionalAuthenticatedData": { + "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.", + "format": "byte", + "type": "string" + }, + "plaintext": { + "description": "Required. The data to encrypt. Must be no larger than 64KiB.", + "format": "byte", + "type": "string" + } + }, + "id": "EncryptRequest" + }, + "ListCryptoKeyVersionsResponse": { + "description": "Response message for KeyManagementService.ListCryptoKeyVersions.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.", + "type": "string" + }, + "totalSize": { + "description": "The total number of CryptoKeyVersions that matched the\nquery.", + "format": "int32", + "type": "integer" + }, + "cryptoKeyVersions": { + "description": "The list of CryptoKeyVersions.", + "type": "array", + "items": { + "$ref": "CryptoKeyVersion" + } + } + }, + "id": "ListCryptoKeyVersionsResponse" + }, + "Location": { + "properties": { + "labels": { + "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "name": { + "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", + "type": "object" + } + }, + "id": "Location", + "description": "A resource that represents Google Cloud Platform location.", + "type": "object" + }, + "ListCryptoKeysResponse": { + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.", + "type": "string" + }, + "cryptoKeys": { + "description": "The list of CryptoKeys.", + "type": "array", + "items": { + "$ref": "CryptoKey" + } + }, + "totalSize": { + "description": "The total number of CryptoKeys that matched the query.", + "format": "int32", + "type": "integer" + } + }, + "id": "ListCryptoKeysResponse", + "description": "Response message for KeyManagementService.ListCryptoKeys.", + "type": "object" + } + }, + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, + "protocol": "rest", + "canonicalName": "Cloud KMS", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "rootUrl": "https://cloudkms.googleapis.com/", + "ownerDomain": "google.com", + "name": "cloudkms", + "batchPath": "batch", + "title": "Google Cloud Key Management Service (KMS) API", "ownerName": "Google", "resources": { "projects": { @@ -6,390 +525,274 @@ "locations": { "methods": { "list": { + "description": "Lists information about the supported locations for this service.", + "httpMethod": "GET", "response": { "$ref": "ListLocationsResponse" }, "parameterOrder": [ "name" ], - "httpMethod": "GET", "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, "filter": { "description": "The standard list filter.", "type": "string", "location": "query" }, "name": { - "location": "path", "description": "The resource that owns the locations collection, if applicable.", "required": true, "type": "string", - "pattern": "^projects/[^/]+$" + "pattern": "^projects/[^/]+$", + "location": "path" }, "pageToken": { + "location": "query", "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations", - "path": "v1/{+name}/locations", "id": "cloudkms.projects.locations.list", - "description": "Lists information about the supported locations for this service." + "path": "v1/{+name}/locations" }, "get": { - "description": "Get information about a location.", - "httpMethod": "GET", "response": { "$ref": "Location" }, "parameterOrder": [ "name" ], + "httpMethod": "GET", "parameters": { "name": { - "location": "path", "description": "Resource name for the location.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", + "path": "v1/{+name}", "id": "cloudkms.projects.locations.get", - "path": "v1/{+name}" + "description": "Get information about a location." } }, "resources": { "keyRings": { - "methods": { - "getIamPolicy": { - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "cloudkms.projects.locations.keyRings.getIamPolicy" - }, - "get": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}", - "path": "v1/{+name}", - "id": "cloudkms.projects.locations.keyRings.get", - "description": "Returns metadata for a given KeyRing.", - "response": { - "$ref": "KeyRing" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the KeyRing to get.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$" - } - } - }, - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "cloudkms.projects.locations.keyRings.testIamPermissions" - }, - "list": { - "response": { - "$ref": "ListKeyRingsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "parent": { - "location": "path", - "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - }, - "pageToken": { - "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings", - "path": "v1/{+parent}/keyRings", - "id": "cloudkms.projects.locations.keyRings.list", - "description": "Lists KeyRings." - }, - "create": { - "response": { - "$ref": "KeyRing" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "location": "path", - "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - }, - "keyRingId": { - "location": "query", - "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings", - "path": "v1/{+parent}/keyRings", - "id": "cloudkms.projects.locations.keyRings.create", - "request": { - "$ref": "KeyRing" - }, - "description": "Create a new KeyRing in a given Project and Location." - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "cloudkms.projects.locations.keyRings.setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy." - } - }, "resources": { "cryptoKeys": { + "resources": { + "cryptoKeyVersions": { + "methods": { + "list": { + "description": "Lists CryptoKeyVersions.", + "response": { + "$ref": "ListCryptoKeyVersionsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions", + "path": "v1/{+parent}/cryptoKeyVersions", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list" + }, + "create": { + "response": { + "$ref": "CryptoKeyVersion" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "location": "path", + "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions", + "path": "v1/{+parent}/cryptoKeyVersions", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create", + "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.", + "request": { + "$ref": "CryptoKeyVersion" + } + }, + "destroy": { + "response": { + "$ref": "CryptoKeyVersion" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The resource name of the CryptoKeyVersion to destroy.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy", + "path": "v1/{+name}:destroy", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", + "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process.", + "request": { + "$ref": "DestroyCryptoKeyVersionRequest" + } + }, + "restore": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "CryptoKeyVersion" + }, + "parameters": { + "name": { + "location": "path", + "description": "The resource name of the CryptoKeyVersion to restore.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore", + "path": "v1/{+name}:restore", + "request": { + "$ref": "RestoreCryptoKeyVersionRequest" + }, + "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared." + }, + "patch": { + "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.", + "request": { + "$ref": "CryptoKeyVersion" + }, + "response": { + "$ref": "CryptoKeyVersion" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$" + }, + "updateMask": { + "description": "Required list of fields to be updated in this request.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}", + "path": "v1/{+name}", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch" + }, + "get": { + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get", + "path": "v1/{+name}", + "description": "Returns metadata for a given CryptoKeyVersion.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "CryptoKeyVersion" + }, + "parameters": { + "name": { + "description": "The name of the CryptoKeyVersion to get.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + } + }, "methods": { - "list": { - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list", - "path": "v1/{+parent}/cryptoKeys", - "description": "Lists CryptoKeys.", + "get": { + "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.", "httpMethod": "GET", "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ListCryptoKeysResponse" - }, - "parameters": { - "pageToken": { - "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys" - }, - "encrypt": { - "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.", - "request": { - "$ref": "EncryptRequest" - }, - "response": { - "$ref": "EncryptResponse" - }, - "parameterOrder": [ "name" ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], + "response": { + "$ref": "CryptoKey" + }, "parameters": { "name": { - "location": "path", - "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt", - "path": "v1/{+name}:encrypt", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt" - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy." - }, - "create": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys", - "path": "v1/{+parent}/cryptoKeys", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create", - "request": { - "$ref": "CryptoKey" - }, - "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.", - "response": { - "$ref": "CryptoKey" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "cryptoKeyId": { - "location": "query", - "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`", - "type": "string" - }, - "parent": { - "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "updatePrimaryVersion": { - "response": { - "$ref": "CryptoKey" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The resource name of the CryptoKey to update.", + "description": "The name of the CryptoKey to get.", "required": true, "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", @@ -399,41 +802,11 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion", - "path": "v1/{+name}:updatePrimaryVersion", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion", - "request": { - "$ref": "UpdateCryptoKeyPrimaryVersionRequest" - }, - "description": "Update the version of a CryptoKey that will be used in Encrypt" - }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "GET", - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy", - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get", + "path": "v1/{+name}" }, "patch": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}", "id": "cloudkms.projects.locations.keyRings.cryptoKeys.patch", "path": "v1/{+name}", "request": { @@ -464,40 +837,10 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.get", - "path": "v1/{+name}", - "description": "Returns metadata for a given CryptoKey, as well as its\nprimary CryptoKeyVersion.", - "httpMethod": "GET", - "parameterOrder": [ - "name" ], - "response": { - "$ref": "CryptoKey" - }, - "parameters": { - "name": { - "description": "The name of the CryptoKey to get.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}" }, "testIamPermissions": { - "path": "v1/{+resource}:testIamPermissions", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "response": { "$ref": "TestIamPermissionsResponse" }, @@ -507,31 +850,9 @@ "httpMethod": "POST", "parameters": { "resource": { - "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions" - }, - "decrypt": { - "response": { - "$ref": "DecryptResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.", - "required": true, - "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", "location": "path" } @@ -539,201 +860,399 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." + }, + "decrypt": { + "response": { + "$ref": "DecryptResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the CryptoKey to use for decryption.\nThe server will choose the appropriate version.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", + "location": "path" + } + }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:decrypt", "path": "v1/{+name}:decrypt", "id": "cloudkms.projects.locations.keyRings.cryptoKeys.decrypt", + "description": "Decrypts data that was protected by Encrypt.", "request": { "$ref": "DecryptRequest" - }, - "description": "Decrypts data that was protected by Encrypt." - } - }, - "resources": { - "cryptoKeyVersions": { - "methods": { - "list": { - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.list", - "path": "v1/{+parent}/cryptoKeyVersions", - "description": "Lists CryptoKeyVersions.", - "httpMethod": "GET", - "response": { - "$ref": "ListCryptoKeyVersionsResponse" - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional pagination token, returned earlier via\nListCryptoKeyVersionsResponse.next_page_token.", - "type": "string" - }, - "pageSize": { - "description": "Optional limit on the number of CryptoKeyVersions to\ninclude in the response. Further CryptoKeyVersions can\nsubsequently be obtained by including the\nListCryptoKeyVersionsResponse.next_page_token in a subsequent request.\nIf unspecified, the server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "location": "path", - "description": "Required. The resource name of the CryptoKey to list, in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions" - }, - "create": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions", - "path": "v1/{+parent}/cryptoKeyVersions", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.create", - "request": { - "$ref": "CryptoKeyVersion" - }, - "description": "Create a new CryptoKeyVersion in a CryptoKey.\n\nThe server will assign the next sequential id. If unset,\nstate will be set to\nENABLED.", - "response": { - "$ref": "CryptoKeyVersion" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the CryptoKey associated with\nthe CryptoKeyVersions.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "destroy": { - "response": { - "$ref": "CryptoKeyVersion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The resource name of the CryptoKeyVersion to destroy.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:destroy", - "path": "v1/{+name}:destroy", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.destroy", - "request": { - "$ref": "DestroyCryptoKeyVersionRequest" - }, - "description": "Schedule a CryptoKeyVersion for destruction.\n\nUpon calling this method, CryptoKeyVersion.state will be set to\nDESTROY_SCHEDULED\nand destroy_time will be set to a time 24\nhours in the future, at which point the state\nwill be changed to\nDESTROYED, and the key\nmaterial will be irrevocably destroyed.\n\nBefore the destroy_time is reached,\nRestoreCryptoKeyVersion may be called to reverse the process." - }, - "restore": { - "response": { - "$ref": "CryptoKeyVersion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", - "location": "path", - "description": "The resource name of the CryptoKeyVersion to restore.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}:restore", - "path": "v1/{+name}:restore", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.restore", - "request": { - "$ref": "RestoreCryptoKeyVersionRequest" - }, - "description": "Restore a CryptoKeyVersion in the\nDESTROY_SCHEDULED,\nstate.\n\nUpon restoration of the CryptoKeyVersion, state\nwill be set to DISABLED,\nand destroy_time will be cleared." - }, - "get": { - "path": "v1/{+name}", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.get", - "description": "Returns metadata for a given CryptoKeyVersion.", - "response": { - "$ref": "CryptoKeyVersion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name of the CryptoKeyVersion to get.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}" - }, - "patch": { - "description": "Update a CryptoKeyVersion's metadata.\n\nstate may be changed between\nENABLED and\nDISABLED using this\nmethod. See DestroyCryptoKeyVersion and RestoreCryptoKeyVersion to\nmove between other states.", - "request": { - "$ref": "CryptoKeyVersion" - }, - "response": { - "$ref": "CryptoKeyVersion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "updateMask": { - "description": "Required list of fields to be updated in this request.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+/cryptoKeyVersions/[^/]+$", - "location": "path", - "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}/cryptoKeyVersions/{cryptoKeyVersionsId}", - "path": "v1/{+name}", - "id": "cloudkms.projects.locations.keyRings.cryptoKeys.cryptoKeyVersions.patch" - } } + }, + "list": { + "description": "Lists CryptoKeys.", + "response": { + "$ref": "ListCryptoKeysResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "description": "Required. The resource name of the KeyRing to list, in the format\n`projects/*/locations/*/keyRings/*`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional pagination token, returned earlier via\nListCryptoKeysResponse.next_page_token.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional limit on the number of CryptoKeys to include in the\nresponse. Further CryptoKeys can subsequently be obtained by\nincluding the ListCryptoKeysResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys", + "path": "v1/{+parent}/cryptoKeys", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.list" + }, + "encrypt": { + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:encrypt", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.encrypt", + "path": "v1/{+name}:encrypt", + "request": { + "$ref": "EncryptRequest" + }, + "description": "Encrypts data, so that it can only be recovered by a call to Decrypt.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "EncryptResponse" + }, + "parameters": { + "name": { + "description": "Required. The resource name of the CryptoKey or CryptoKeyVersion\nto use for encryption.\n\nIf a CryptoKey is specified, the server will use its\nprimary version.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "response": { + "$ref": "CryptoKey" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "location": "path", + "description": "Required. The name of the KeyRing associated with the\nCryptoKeys.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$" + }, + "cryptoKeyId": { + "location": "query", + "description": "Required. It must be unique within a KeyRing and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`", + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys", + "path": "v1/{+parent}/cryptoKeys", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.create", + "description": "Create a new CryptoKey within a KeyRing.\n\nCryptoKey.purpose is required.", + "request": { + "$ref": "CryptoKey" + } + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.setIamPolicy" + }, + "updatePrimaryVersion": { + "response": { + "$ref": "CryptoKey" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "The resource name of the CryptoKey to update.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:updatePrimaryVersion", + "path": "v1/{+name}:updatePrimaryVersion", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.updatePrimaryVersion", + "description": "Update the version of a CryptoKey that will be used in Encrypt", + "request": { + "$ref": "UpdateCryptoKeyPrimaryVersionRequest" + } + }, + "getIamPolicy": { + "httpMethod": "GET", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+/cryptoKeys/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}/cryptoKeys/{cryptoKeysId}:getIamPolicy", + "id": "cloudkms.projects.locations.keyRings.cryptoKeys.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." } } } + }, + "methods": { + "getIamPolicy": { + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", + "id": "cloudkms.projects.locations.keyRings.getIamPolicy" + }, + "get": { + "path": "v1/{+name}", + "id": "cloudkms.projects.locations.keyRings.get", + "description": "Returns metadata for a given KeyRing.", + "response": { + "$ref": "KeyRing" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "location": "path", + "description": "The name of the KeyRing to get.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}" + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "cloudkms.projects.locations.keyRings.testIamPermissions" + }, + "list": { + "response": { + "$ref": "ListKeyRingsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "parent": { + "location": "path", + "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + }, + "pageToken": { + "location": "query", + "description": "Optional pagination token, returned earlier via\nListKeyRingsResponse.next_page_token.", + "type": "string" + }, + "pageSize": { + "description": "Optional limit on the number of KeyRings to include in the\nresponse. Further KeyRings can subsequently be obtained by\nincluding the ListKeyRingsResponse.next_page_token in a subsequent\nrequest. If unspecified, the server will pick an appropriate default.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings", + "path": "v1/{+parent}/keyRings", + "id": "cloudkms.projects.locations.keyRings.list", + "description": "Lists KeyRings." + }, + "setIamPolicy": { + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/locations/[^/]+/keyRings/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings/{keyRingsId}:setIamPolicy", + "id": "cloudkms.projects.locations.keyRings.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy" + }, + "create": { + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "KeyRing" + }, + "parameters": { + "parent": { + "location": "path", + "description": "Required. The resource name of the location associated with the\nKeyRings, in the format `projects/*/locations/*`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + }, + "keyRingId": { + "description": "Required. It must be unique within a location and match the regular\nexpression `[a-zA-Z0-9_-]{1,63}`", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/keyRings", + "id": "cloudkms.projects.locations.keyRings.create", + "path": "v1/{+parent}/keyRings", + "request": { + "$ref": "KeyRing" + }, + "description": "Create a new KeyRing in a given Project and Location." + } } } } @@ -742,43 +1261,37 @@ } }, "parameters": { - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, "bearer_token": { - "location": "query", "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", + "type": "string", "location": "query" }, - "uploadType": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, "$.xgafv": { "enumDescriptions": [ "v1 error format", @@ -813,541 +1326,28 @@ "description": "Data format for response.", "default": "json" }, - "key": { - "location": "query", - "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.", - "type": "string" - }, "access_token": { - "location": "query", "description": "OAuth access token.", - "type": "string" + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" }, "quotaUser": { - "location": "query", "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.", - "type": "string" + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" } }, "version": "v1", - "baseUrl": "https://cloudkms.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Manages encryption for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256 encryption keys.", - "servicePath": "", - "basePath": "", - "id": "cloudkms:v1", - "revision": "20171218", - "documentationLink": "https://cloud.google.com/kms/", - "discoveryVersion": "v1", - "version_module": true, - "schemas": { - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" - }, - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "SetIamPolicyRequest" - }, - "DecryptRequest": { - "description": "Request message for KeyManagementService.Decrypt.", - "type": "object", - "properties": { - "ciphertext": { - "description": "Required. The encrypted data originally returned in\nEncryptResponse.ciphertext.", - "format": "byte", - "type": "string" - }, - "additionalAuthenticatedData": { - "description": "Optional data that must match the data originally supplied in\nEncryptRequest.additional_authenticated_data.", - "format": "byte", - "type": "string" - } - }, - "id": "DecryptRequest" - }, - "Binding": { - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - }, - "condition": { - "$ref": "Expr", - "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL." - } - }, - "id": "Binding", - "description": "Associates `members` with a `role`.", - "type": "object" - }, - "Expr": { - "properties": { - "title": { - "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", - "type": "string" - }, - "location": { - "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", - "type": "string" - }, - "description": { - "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", - "type": "string" - } - }, - "id": "Expr", - "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", - "type": "object" - }, - "EncryptRequest": { - "description": "Request message for KeyManagementService.Encrypt.", - "type": "object", - "properties": { - "plaintext": { - "description": "Required. The data to encrypt. Must be no larger than 64KiB.", - "format": "byte", - "type": "string" - }, - "additionalAuthenticatedData": { - "description": "Optional data that, if specified, must also be provided during decryption\nthrough DecryptRequest.additional_authenticated_data. Must be no\nlarger than 64KiB.", - "format": "byte", - "type": "string" - } - }, - "id": "EncryptRequest" - }, - "ListCryptoKeyVersionsResponse": { - "properties": { - "cryptoKeyVersions": { - "description": "The list of CryptoKeyVersions.", - "type": "array", - "items": { - "$ref": "CryptoKeyVersion" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeyVersionsRequest.page_token to retrieve the next page of\nresults.", - "type": "string" - }, - "totalSize": { - "description": "The total number of CryptoKeyVersions that matched the\nquery.", - "format": "int32", - "type": "integer" - } - }, - "id": "ListCryptoKeyVersionsResponse", - "description": "Response message for KeyManagementService.ListCryptoKeyVersions.", - "type": "object" - }, - "Location": { - "properties": { - "name": { - "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", - "type": "object" - }, - "labels": { - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "id": "Location", - "description": "A resource that represents Google Cloud Platform location.", - "type": "object" - }, - "ListCryptoKeysResponse": { - "description": "Response message for KeyManagementService.ListCryptoKeys.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass this value in\nListCryptoKeysRequest.page_token to retrieve the next page of results.", - "type": "string" - }, - "cryptoKeys": { - "description": "The list of CryptoKeys.", - "type": "array", - "items": { - "$ref": "CryptoKey" - } - }, - "totalSize": { - "description": "The total number of CryptoKeys that matched the query.", - "format": "int32", - "type": "integer" - } - }, - "id": "ListCryptoKeysResponse" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsResponse" - }, - "DestroyCryptoKeyVersionRequest": { - "properties": {}, - "id": "DestroyCryptoKeyVersionRequest", - "description": "Request message for KeyManagementService.DestroyCryptoKeyVersion.", - "type": "object" - }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", - "type": "object", - "properties": { - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", - "type": "array", - "items": { - "type": "string" - } - }, - "logType": { - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ], - "description": "The log type that this config enables.", - "type": "string", - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ] - } - }, - "id": "AuditLogConfig" - }, - "CryptoKey": { - "properties": { - "primary": { - "description": "Output only. A copy of the \"primary\" CryptoKeyVersion that will be used\nby Encrypt when this CryptoKey is given\nin EncryptRequest.name.\n\nThe CryptoKey's primary version can be updated via\nUpdateCryptoKeyPrimaryVersion.", - "$ref": "CryptoKeyVersion" - }, - "name": { - "description": "Output only. The resource name for this CryptoKey in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*`.", - "type": "string" - }, - "purpose": { - "enum": [ - "CRYPTO_KEY_PURPOSE_UNSPECIFIED", - "ENCRYPT_DECRYPT" - ], - "description": "The immutable purpose of this CryptoKey. Currently, the only acceptable\npurpose is ENCRYPT_DECRYPT.", - "type": "string", - "enumDescriptions": [ - "Not specified.", - "CryptoKeys with this purpose may be used with\nEncrypt and\nDecrypt." - ] - }, - "nextRotationTime": { - "description": "At next_rotation_time, the Key Management Service will automatically:\n\n1. Create a new version of this CryptoKey.\n2. Mark the new version as primary.\n\nKey rotations performed manually via\nCreateCryptoKeyVersion and\nUpdateCryptoKeyPrimaryVersion\ndo not affect next_rotation_time.", - "format": "google-datetime", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels with user-defined metadata. For more information, see\n[Labeling Keys](/kms/docs/labeling-keys).", - "type": "object" - }, - "createTime": { - "description": "Output only. The time at which this CryptoKey was created.", - "format": "google-datetime", - "type": "string" - }, - "rotationPeriod": { - "description": "next_rotation_time will be advanced by this period when the service\nautomatically rotates a key. Must be at least one day.\n\nIf rotation_period is set, next_rotation_time must also be set.", - "format": "google-duration", - "type": "string" - } - }, - "id": "CryptoKey", - "description": "A CryptoKey represents a logical key that can be used for cryptographic\noperations.\n\nA CryptoKey is made up of one or more versions, which\nrepresent the actual key material used in cryptographic operations.", - "type": "object" - }, - "DecryptResponse": { - "properties": { - "plaintext": { - "description": "The decrypted data originally supplied in EncryptRequest.plaintext.", - "format": "byte", - "type": "string" - } - }, - "id": "DecryptResponse", - "description": "Response message for KeyManagementService.Decrypt.", - "type": "object" - }, - "TestIamPermissionsRequest": { - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest", - "description": "Request message for `TestIamPermissions` method.", - "type": "object" - }, - "EncryptResponse": { - "properties": { - "name": { - "description": "The resource name of the CryptoKeyVersion used in encryption.", - "type": "string" - }, - "ciphertext": { - "description": "The encrypted data.", - "format": "byte", - "type": "string" - } - }, - "id": "EncryptResponse", - "description": "Response message for KeyManagementService.Encrypt.", - "type": "object" - }, - "KeyRing": { - "description": "A KeyRing is a toplevel logical grouping of CryptoKeys.", - "type": "object", - "properties": { - "createTime": { - "description": "Output only. The time at which this KeyRing was created.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "Output only. The resource name for the KeyRing in the format\n`projects/*/locations/*/keyRings/*`.", - "type": "string" - } - }, - "id": "KeyRing" - }, - "ListLocationsResponse": { - "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Location" - } - } - }, - "id": "ListLocationsResponse", - "description": "The response message for Locations.ListLocations.", - "type": "object" - }, - "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", - "type": "object", - "properties": { - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Version of the `Policy`. The default version is 0.", - "format": "int32", - "type": "integer" - }, - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "type": "array", - "items": { - "$ref": "AuditConfig" - } - }, - "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - }, - "iamOwned": { - "type": "boolean" - } - }, - "id": "Policy" - }, - "UpdateCryptoKeyPrimaryVersionRequest": { - "description": "Request message for KeyManagementService.UpdateCryptoKeyPrimaryVersion.", - "type": "object", - "properties": { - "cryptoKeyVersionId": { - "description": "The id of the child CryptoKeyVersion to use as primary.", - "type": "string" - } - }, - "id": "UpdateCryptoKeyPrimaryVersionRequest" - }, - "RestoreCryptoKeyVersionRequest": { - "description": "Request message for KeyManagementService.RestoreCryptoKeyVersion.", - "type": "object", - "properties": {}, - "id": "RestoreCryptoKeyVersionRequest" - }, - "ListKeyRingsResponse": { - "description": "Response message for KeyManagementService.ListKeyRings.", - "type": "object", - "properties": { - "keyRings": { - "description": "The list of KeyRings.", - "type": "array", - "items": { - "$ref": "KeyRing" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results. Pass this value in\nListKeyRingsRequest.page_token to retrieve the next page of results.", - "type": "string" - }, - "totalSize": { - "description": "The total number of KeyRings that matched the query.", - "format": "int32", - "type": "integer" - } - }, - "id": "ListKeyRingsResponse" - }, - "AuditConfig": { - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", - "type": "object", - "properties": { - "exemptedMembers": { - "type": "array", - "items": { - "type": "string" - } - }, - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" - }, - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.\nNext ID: 4", - "type": "array", - "items": { - "$ref": "AuditLogConfig" - } - } - }, - "id": "AuditConfig" - }, - "CryptoKeyVersion": { - "description": "A CryptoKeyVersion represents an individual cryptographic key, and the\nassociated key material.\n\nIt can be used for cryptographic operations either directly, or via its\nparent CryptoKey, in which case the server will choose the appropriate\nversion for the operation.\n\nFor security reasons, the raw cryptographic key material represented by a\nCryptoKeyVersion can never be viewed or exported. It can only be used to\nencrypt or decrypt data when an authorized user or application invokes Cloud\nKMS.", - "type": "object", - "properties": { - "destroyTime": { - "description": "Output only. The time this CryptoKeyVersion's key material is scheduled\nfor destruction. Only present if state is\nDESTROY_SCHEDULED.", - "format": "google-datetime", - "type": "string" - }, - "createTime": { - "description": "Output only. The time at which this CryptoKeyVersion was created.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "enumDescriptions": [ - "Not specified.", - "This version may be used in Encrypt and\nDecrypt requests.", - "This version may not be used, but the key material is still available,\nand the version can be placed back into the ENABLED state.", - "This version is destroyed, and the key material is no longer stored.\nA version may not leave this state once entered.", - "This version is scheduled for destruction, and will be destroyed soon.\nCall\nRestoreCryptoKeyVersion\nto put it back into the DISABLED state." - ], - "enum": [ - "CRYPTO_KEY_VERSION_STATE_UNSPECIFIED", - "ENABLED", - "DISABLED", - "DESTROYED", - "DESTROY_SCHEDULED" - ], - "description": "The current state of the CryptoKeyVersion.", - "type": "string" - }, - "name": { - "description": "Output only. The resource name for this CryptoKeyVersion in the format\n`projects/*/locations/*/keyRings/*/cryptoKeys/*/cryptoKeyVersions/*`.", - "type": "string" - }, - "destroyEventTime": { - "description": "Output only. The time this CryptoKeyVersion's key material was\ndestroyed. Only present if state is\nDESTROYED.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "CryptoKeyVersion" - } - }, - "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" - }, - "protocol": "rest", - "canonicalName": "Cloud KMS", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "rootUrl": "https://cloudkms.googleapis.com/", - "ownerDomain": "google.com", - "name": "cloudkms", - "batchPath": "batch", - "title": "Google Cloud Key Management Service (KMS) API" + "baseUrl": "https://cloudkms.googleapis.com/" }
diff --git a/cloudresourcemanager/v1/cloudresourcemanager-api.json b/cloudresourcemanager/v1/cloudresourcemanager-api.json index 1b3cde1..4782e04 100644 --- a/cloudresourcemanager/v1/cloudresourcemanager-api.json +++ b/cloudresourcemanager/v1/cloudresourcemanager-api.json
@@ -1,1149 +1,513 @@ { - "ownerName": "Google", - "resources": { - "organizations": { - "methods": { - "listAvailableOrgPolicyConstraints": { - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "ListAvailableOrgPolicyConstraintsResponse" - }, - "parameters": { - "resource": { - "description": "Name of the resource to list `Constraints` for.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints", - "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints", - "path": "v1/{+resource}:listAvailableOrgPolicyConstraints", - "request": { - "$ref": "ListAvailableOrgPolicyConstraintsRequest" - }, - "description": "Lists `Constraints` that could be applied on the specified resource." - }, - "listOrgPolicies": { - "description": "Lists all the `Policies` set for a particular resource.", - "request": { - "$ref": "ListOrgPoliciesRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "ListOrgPoliciesResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "resource": { - "description": "Name of the resource to list Policies for.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies", - "id": "cloudresourcemanager.organizations.listOrgPolicies", - "path": "v1/{+resource}:listOrgPolicies" - }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$" - } - }, - "flatPath": "v1/organizations/{organizationsId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "cloudresourcemanager.organizations.getIamPolicy", - "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization", - "request": { - "$ref": "GetIamPolicyRequest" - } - }, - "getOrgPolicy": { - "request": { - "$ref": "GetOrgPolicyRequest" - }, - "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "OrgPolicy" - }, - "parameters": { - "resource": { - "description": "Name of the resource the `Policy` is set on.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy", - "id": "cloudresourcemanager.organizations.getOrgPolicy", - "path": "v1/{+resource}:getOrgPolicy" - }, - "search": { - "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`", - "request": { - "$ref": "SearchOrganizationsRequest" - }, - "response": { - "$ref": "SearchOrganizationsResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": {}, - "flatPath": "v1/organizations:search", - "path": "v1/organizations:search", - "id": "cloudresourcemanager.organizations.search" - }, - "getEffectiveOrgPolicy": { - "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy", - "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy", - "path": "v1/{+resource}:getEffectiveOrgPolicy", - "request": { - "$ref": "GetEffectiveOrgPolicyRequest" - }, - "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "OrgPolicy" - }, - "parameters": { - "resource": { - "description": "The name of the resource to start computing the effective `Policy`.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "get": { - "description": "Fetches an Organization resource identified by the specified resource name.", - "response": { - "$ref": "Organization" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "name": { - "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/organizations/{organizationsId}", - "path": "v1/{+name}", - "id": "cloudresourcemanager.organizations.get" - }, - "testIamPermissions": { - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/organizations/{organizationsId}:testIamPermissions", - "id": "cloudresourcemanager.organizations.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call." - }, - "clearOrgPolicy": { - "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy", - "id": "cloudresourcemanager.organizations.clearOrgPolicy", - "path": "v1/{+resource}:clearOrgPolicy", - "description": "Clears a `Policy` from a resource.", - "request": { - "$ref": "ClearOrgPolicyRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "description": "Name of the resource for the `Policy` to clear.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - } - }, - "setOrgPolicy": { - "response": { - "$ref": "OrgPolicy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "description": "Resource name of the resource to attach the `Policy`.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy", - "path": "v1/{+resource}:setOrgPolicy", - "id": "cloudresourcemanager.organizations.setOrgPolicy", - "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.", - "request": { - "$ref": "SetOrgPolicyRequest" - } - }, - "setIamPolicy": { - "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$" - } - }, - "flatPath": "v1/organizations/{organizationsId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "cloudresourcemanager.organizations.setIamPolicy" - } - } - }, - "liens": { - "methods": { - "delete": { - "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name/identifier of the Lien to delete.", - "required": true, - "type": "string", - "pattern": "^liens/.+$" - } - }, - "flatPath": "v1/liens/{liensId}", - "path": "v1/{+name}", - "id": "cloudresourcemanager.liens.delete" - }, - "list": { - "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.", - "response": { - "$ref": "ListLiensResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "The maximum number of items to return. This is a suggestion for the server.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "The `next_page_token` value returned from a previous List request, if any.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/liens", - "path": "v1/liens", - "id": "cloudresourcemanager.liens.list" - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "Lien" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/liens", - "id": "cloudresourcemanager.liens.create", - "path": "v1/liens", - "request": { - "$ref": "Lien" - }, - "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied." - } - } - }, - "operations": { - "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.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^operations/.+$" - } - }, - "flatPath": "v1/operations/{operationsId}", - "path": "v1/{+name}", - "id": "cloudresourcemanager.operations.get" - } - } - }, - "folders": { - "methods": { - "getOrgPolicy": { - "flatPath": "v1/folders/{foldersId}:getOrgPolicy", - "id": "cloudresourcemanager.folders.getOrgPolicy", - "path": "v1/{+resource}:getOrgPolicy", - "request": { - "$ref": "GetOrgPolicyRequest" - }, - "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "OrgPolicy" - }, - "parameters": { - "resource": { - "description": "Name of the resource the `Policy` is set on.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "getEffectiveOrgPolicy": { - "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy", - "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy", - "path": "v1/{+resource}:getEffectiveOrgPolicy", - "request": { - "$ref": "GetEffectiveOrgPolicyRequest" - }, - "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "OrgPolicy" - }, - "parameters": { - "resource": { - "location": "path", - "description": "The name of the resource to start computing the effective `Policy`.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "clearOrgPolicy": { - "request": { - "$ref": "ClearOrgPolicyRequest" - }, - "description": "Clears a `Policy` from a resource.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "resource": { - "location": "path", - "description": "Name of the resource for the `Policy` to clear.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/folders/{foldersId}:clearOrgPolicy", - "id": "cloudresourcemanager.folders.clearOrgPolicy", - "path": "v1/{+resource}:clearOrgPolicy" - }, - "setOrgPolicy": { - "request": { - "$ref": "SetOrgPolicyRequest" - }, - "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "OrgPolicy" - }, - "parameters": { - "resource": { - "location": "path", - "description": "Resource name of the resource to attach the `Policy`.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/folders/{foldersId}:setOrgPolicy", - "id": "cloudresourcemanager.folders.setOrgPolicy", - "path": "v1/{+resource}:setOrgPolicy" - }, - "listAvailableOrgPolicyConstraints": { - "request": { - "$ref": "ListAvailableOrgPolicyConstraintsRequest" - }, - "description": "Lists `Constraints` that could be applied on the specified resource.", - "response": { - "$ref": "ListAvailableOrgPolicyConstraintsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "Name of the resource to list `Constraints` for.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints", - "path": "v1/{+resource}:listAvailableOrgPolicyConstraints", - "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints" - }, - "listOrgPolicies": { - "request": { - "$ref": "ListOrgPoliciesRequest" - }, - "description": "Lists all the `Policies` set for a particular resource.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "ListOrgPoliciesResponse" - }, - "parameters": { - "resource": { - "location": "path", - "description": "Name of the resource to list Policies for.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/folders/{foldersId}:listOrgPolicies", - "id": "cloudresourcemanager.folders.listOrgPolicies", - "path": "v1/{+resource}:listOrgPolicies" - } - } - }, - "projects": { - "methods": { - "get": { - "response": { - "$ref": "Project" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "The Project ID (for example, `my-project-123`).\n\nRequired.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectId}", - "path": "v1/projects/{projectId}", - "id": "cloudresourcemanager.projects.get", - "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project." - }, - "getAncestry": { - "request": { - "$ref": "GetAncestryRequest" - }, - "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.", - "response": { - "$ref": "GetAncestryResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The Project ID (for example, `my-project-123`).\n\nRequired.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectId}:getAncestry", - "path": "v1/projects/{projectId}:getAncestry", - "id": "cloudresourcemanager.projects.getAncestry" - }, - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{resource}:testIamPermissions", - "id": "cloudresourcemanager.projects.testIamPermissions", - "path": "v1/projects/{resource}:testIamPermissions" - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}", - "path": "v1/projects/{projectId}", - "id": "cloudresourcemanager.projects.delete", - "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project." - }, - "clearOrgPolicy": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "Name of the resource for the `Policy` to clear.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}:clearOrgPolicy", - "path": "v1/{+resource}:clearOrgPolicy", - "id": "cloudresourcemanager.projects.clearOrgPolicy", - "request": { - "$ref": "ClearOrgPolicyRequest" - }, - "description": "Clears a `Policy` from a resource." - }, - "setIamPolicy": { - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{resource}:setIamPolicy", - "path": "v1/projects/{resource}:setIamPolicy", - "id": "cloudresourcemanager.projects.setIamPolicy" - }, - "listAvailableOrgPolicyConstraints": { - "request": { - "$ref": "ListAvailableOrgPolicyConstraintsRequest" - }, - "description": "Lists `Constraints` that could be applied on the specified resource.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "ListAvailableOrgPolicyConstraintsResponse" - }, - "parameters": { - "resource": { - "description": "Name of the resource to list `Constraints` for.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints", - "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints", - "path": "v1/{+resource}:listAvailableOrgPolicyConstraints" - }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{resource}:getIamPolicy", - "path": "v1/projects/{resource}:getIamPolicy", - "id": "cloudresourcemanager.projects.getIamPolicy", - "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).", - "request": { - "$ref": "GetIamPolicyRequest" - } - }, - "getOrgPolicy": { - "flatPath": "v1/projects/{projectsId}:getOrgPolicy", - "path": "v1/{+resource}:getOrgPolicy", - "id": "cloudresourcemanager.projects.getOrgPolicy", - "request": { - "$ref": "GetOrgPolicyRequest" - }, - "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.", - "response": { - "$ref": "OrgPolicy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "Name of the resource the `Policy` is set on.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - }, - "undelete": { - "request": { - "$ref": "UndeleteProjectRequest" - }, - "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}:undelete", - "id": "cloudresourcemanager.projects.undelete", - "path": "v1/projects/{projectId}:undelete" - }, - "getEffectiveOrgPolicy": { - "request": { - "$ref": "GetEffectiveOrgPolicyRequest" - }, - "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "OrgPolicy" - }, - "parameters": { - "resource": { - "location": "path", - "description": "The name of the resource to start computing the effective `Policy`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy", - "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy", - "path": "v1/{+resource}:getEffectiveOrgPolicy" - }, - "update": { - "response": { - "$ref": "Project" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The project ID (for example, `my-project-123`).\n\nRequired.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}", - "path": "v1/projects/{projectId}", - "id": "cloudresourcemanager.projects.update", - "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.", - "request": { - "$ref": "Project" - } - }, - "list": { - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListProjectsResponse" - }, - "parameters": { - "filter": { - "location": "query", - "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects", - "id": "cloudresourcemanager.projects.list", - "path": "v1/projects", - "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method." - }, - "setOrgPolicy": { - "response": { - "$ref": "OrgPolicy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "Resource name of the resource to attach the `Policy`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}:setOrgPolicy", - "path": "v1/{+resource}:setOrgPolicy", - "id": "cloudresourcemanager.projects.setOrgPolicy", - "request": { - "$ref": "SetOrgPolicyRequest" - }, - "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`." - }, - "create": { - "flatPath": "v1/projects", - "path": "v1/projects", - "id": "cloudresourcemanager.projects.create", - "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.", - "request": { - "$ref": "Project" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {} - }, - "listOrgPolicies": { - "flatPath": "v1/projects/{projectsId}:listOrgPolicies", - "path": "v1/{+resource}:listOrgPolicies", - "id": "cloudresourcemanager.projects.listOrgPolicies", - "request": { - "$ref": "ListOrgPoliciesRequest" - }, - "description": "Lists all the `Policies` set for a particular resource.", - "response": { - "$ref": "ListOrgPoliciesResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "Name of the resource to list Policies for.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ] - } - } - } - }, - "parameters": { - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - } - }, - "version": "v1", - "baseUrl": "https://cloudresourcemanager.googleapis.com/", - "servicePath": "", - "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.", - "kind": "discovery#restDescription", - "basePath": "", "revision": "20180103", "documentationLink": "https://cloud.google.com/resource-manager", "id": "cloudresourcemanager:v1", "discoveryVersion": "v1", "schemas": { + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest" + }, + "FolderOperation": { + "type": "object", + "properties": { + "displayName": { + "type": "string", + "description": "The display name of the folder." + }, + "sourceParent": { + "type": "string", + "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE." + }, + "destinationParent": { + "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.", + "type": "string" + }, + "operationType": { + "enumDescriptions": [ + "Operation type not specified.", + "A create folder operation.", + "A move folder operation." + ], + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "CREATE", + "MOVE" + ], + "description": "The type of this operation.", + "type": "string" + } + }, + "id": "FolderOperation", + "description": "Metadata describing a long running folder operation" + }, + "Policy": { + "type": "object", + "properties": { + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "type": "array", + "items": { + "$ref": "AuditConfig" + } + }, + "bindings": { + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "type": "integer", + "description": "Deprecated.", + "format": "int32" + } + }, + "id": "Policy", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs)." + }, + "ListAvailableOrgPolicyConstraintsRequest": { + "type": "object", + "properties": { + "pageToken": { + "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.", + "type": "string" + }, + "pageSize": { + "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.", + "format": "int32", + "type": "integer" + } + }, + "id": "ListAvailableOrgPolicyConstraintsRequest", + "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method." + }, + "ResourceId": { + "id": "ResourceId", + "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.", + "type": "object", + "properties": { + "type": { + "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"", + "type": "string" + }, + "id": { + "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.", + "type": "string" + } + } + }, + "GetEffectiveOrgPolicyRequest": { + "properties": { + "constraint": { + "description": "The name of the `Constraint` to compute the effective `Policy`.", + "type": "string" + } + }, + "id": "GetEffectiveOrgPolicyRequest", + "description": "The request sent to the GetEffectiveOrgPolicy method.", + "type": "object" + }, + "ListOrgPoliciesRequest": { + "description": "The request sent to the ListOrgPolicies method.", + "type": "object", + "properties": { + "pageToken": { + "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.", + "type": "string" + }, + "pageSize": { + "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.", + "format": "int32", + "type": "integer" + } + }, + "id": "ListOrgPoliciesRequest" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "properties": { + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "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" + } + }, + "id": "Operation" + }, + "AuditConfig": { + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", + "type": "object", + "properties": { + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.\nNext ID: 4", + "type": "array", + "items": { + "$ref": "AuditLogConfig" + } + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + } + }, + "id": "AuditConfig" + }, + "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.", + "type": "object", + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "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" + } + }, + "id": "Status" + }, + "ListLiensResponse": { + "id": "ListLiensResponse", + "description": "The response message for Liens.ListLiens.", + "type": "object", + "properties": { + "nextPageToken": { + "type": "string", + "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list." + }, + "liens": { + "description": "A list of Liens.", + "type": "array", + "items": { + "$ref": "Lien" + } + } + } + }, + "Constraint": { + "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.", + "type": "object", + "properties": { + "listConstraint": { + "$ref": "ListConstraint", + "description": "Defines this constraint as being a ListConstraint." + }, + "version": { + "description": "Version of the `Constraint`. Default version is 0;", + "format": "int32", + "type": "integer" + }, + "description": { + "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.", + "type": "string" + }, + "displayName": { + "description": "The human readable name.\n\nMutable.", + "type": "string" + }, + "booleanConstraint": { + "description": "Defines this constraint as being a BooleanConstraint.", + "$ref": "BooleanConstraint" + }, + "constraintDefault": { + "enumDescriptions": [ + "This is only used for distinguishing unset values and should never be\nused.", + "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.", + "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints." + ], + "enum": [ + "CONSTRAINT_DEFAULT_UNSPECIFIED", + "ALLOW", + "DENY" + ], + "description": "The evaluation behavior of this constraint in the absense of 'Policy'.", + "type": "string" + }, + "name": { + "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`", + "type": "string" + } + }, + "id": "Constraint" + }, + "Binding": { + "type": "object", + "properties": { + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + } + }, + "id": "Binding", + "description": "Associates `members` with a `role`." + }, + "GetOrgPolicyRequest": { + "description": "The request sent to the GetOrgPolicy method.", + "type": "object", + "properties": { + "constraint": { + "description": "Name of the `Constraint` to get the `Policy`.", + "type": "string" + } + }, + "id": "GetOrgPolicyRequest" + }, + "RestoreDefault": { + "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.", + "type": "object", + "properties": {}, + "id": "RestoreDefault" + }, + "ClearOrgPolicyRequest": { + "type": "object", + "properties": { + "etag": { + "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.", + "format": "byte", + "type": "string" + }, + "constraint": { + "description": "Name of the `Constraint` of the `Policy` to clear.", + "type": "string" + } + }, + "id": "ClearOrgPolicyRequest", + "description": "The request sent to the ClearOrgPolicy method." + }, + "UndeleteProjectRequest": { + "description": "The request sent to the UndeleteProject\nmethod.", + "type": "object", + "properties": {}, + "id": "UndeleteProjectRequest" + }, + "ProjectCreationStatus": { + "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.", + "type": "object", + "properties": { + "createTime": { + "description": "Creation time of the project creation workflow.", + "format": "google-datetime", + "type": "string" + }, + "gettable": { + "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.", + "type": "boolean" + }, + "ready": { + "description": "True if the project creation process is complete.", + "type": "boolean" + } + }, + "id": "ProjectCreationStatus" + }, + "BooleanConstraint": { + "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.", + "type": "object", + "properties": {}, + "id": "BooleanConstraint" + }, + "GetIamPolicyRequest": { + "description": "Request message for `GetIamPolicy` method.", + "type": "object", + "properties": {}, + "id": "GetIamPolicyRequest" + }, + "TestIamPermissionsResponse": { + "type": "object", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsResponse", + "description": "Response message for `TestIamPermissions` method." + }, + "OrganizationOwner": { + "id": "OrganizationOwner", + "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.", + "type": "object", + "properties": { + "directoryCustomerId": { + "description": "The Google for Work customer id used in the Directory API.", + "type": "string" + } + } + }, + "ListProjectsResponse": { + "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.", + "type": "object", + "properties": { + "projects": { + "description": "The list of Projects that matched the list filter. This list can\nbe paginated.", + "type": "array", + "items": { + "$ref": "Project" + } + }, + "nextPageToken": { + "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.", + "type": "string" + } + }, + "id": "ListProjectsResponse" + }, + "Project": { + "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.", + "type": "object", + "properties": { + "lifecycleState": { + "description": "The Project lifecycle state.\n\nRead-only.", + "type": "string", + "enumDescriptions": [ + "Unspecified state. This is only used/useful for distinguishing\nunset values.", + "The normal and active state.", + "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.", + "This lifecycle state is no longer used and not returned by the API." + ], + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "ACTIVE", + "DELETE_REQUESTED", + "DELETE_IN_PROGRESS" + ] + }, + "projectNumber": { + "type": "string", + "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.", + "format": "int64" + }, + "parent": { + "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write.", + "$ref": "ResourceId" + }, + "labels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write." + }, + "createTime": { + "description": "Creation time.\n\nRead-only.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.", + "type": "string" + }, + "projectId": { + "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.", + "type": "string" + } + }, + "id": "Project" + }, + "SearchOrganizationsResponse": { + "properties": { + "nextPageToken": { + "type": "string", + "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results." + }, + "organizations": { + "description": "The list of Organizations that matched the search query, possibly\npaginated.", + "type": "array", + "items": { + "$ref": "Organization" + } + } + }, + "id": "SearchOrganizationsResponse", + "description": "The response returned from the `SearchOrganizations` method.", + "type": "object" + }, + "ListOrgPoliciesResponse": { + "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.", + "type": "object", + "properties": { + "policies": { + "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.", + "type": "array", + "items": { + "$ref": "OrgPolicy" + } + }, + "nextPageToken": { + "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.", + "type": "string" + } + }, + "id": "ListOrgPoliciesResponse" + }, "FolderOperationError": { - "description": "A classification of the Folder Operation error.", "type": "object", "properties": { "errorMessageId": { - "description": "The type of operation error experienced.", - "type": "string", "enumDescriptions": [ "The error type was unrecognized or unspecified.", "The attempted action would violate the max folder depth constraint.", @@ -1167,10 +531,13 @@ "FOLDER_BEING_MOVED_VIOLATION", "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION", "DELETED_FOLDER_HEIGHT_VIOLATION" - ] + ], + "description": "The type of operation error experienced.", + "type": "string" } }, - "id": "FolderOperationError" + "id": "FolderOperationError", + "description": "A classification of the Folder Operation error." }, "OrgPolicy": { "description": "Defines a Cloud Organization `Policy` which is used to specify `Constraints`\nfor configurations of Cloud Platform resources.", @@ -1190,8 +557,8 @@ "type": "string" }, "booleanPolicy": { - "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not.", - "$ref": "BooleanPolicy" + "$ref": "BooleanPolicy", + "description": "For boolean `Constraints`, whether to enforce the `Constraint` or not." }, "updateTime": { "description": "The time stamp the `Policy` was previously updated. This is set by the\nserver, not specified by the caller, and represents the last time a call to\n`SetOrgPolicy` was made for that `Policy`. Any value set by the client will\nbe ignored.", @@ -1204,8 +571,8 @@ "type": "integer" }, "restoreDefault": { - "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type.", - "$ref": "RestoreDefault" + "$ref": "RestoreDefault", + "description": "Restores the default behavior of the constraint; independent of\n`Constraint` type." } }, "id": "OrgPolicy" @@ -1225,10 +592,6 @@ "description": "A Lien represents an encumbrance on the actions that can be performed on a\nresource.", "type": "object", "properties": { - "parent": { - "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`", - "type": "string" - }, "createTime": { "description": "The creation time of this Lien.", "format": "google-datetime", @@ -1243,40 +606,44 @@ "type": "string" }, "origin": { - "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'", - "type": "string" + "type": "string", + "description": "A stable, user-visible/meaningful string identifying the origin of the\nLien, intended to be inspected programmatically. Maximum length of 200\ncharacters.\n\nExample: 'compute.googleapis.com'" }, "restrictions": { - "description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']", "type": "array", "items": { "type": "string" - } + }, + "description": "The types of operations which should be blocked as a result of this Lien.\nEach value should correspond to an IAM permission. The server will\nvalidate the permissions against those for which Liens are supported.\n\nAn empty list is meaningless and will be rejected.\n\nExample: ['resourcemanager.projects.delete']" + }, + "parent": { + "description": "A reference to the resource this Lien is attached to. The server will\nvalidate the parent against those for which Liens are supported.\n\nExample: `projects/1234`", + "type": "string" } }, "id": "Lien" }, "Ancestor": { - "description": "Identifying information for a single ancestor of a project.", - "type": "object", "properties": { "resourceId": { "description": "Resource id of the ancestor.", "$ref": "ResourceId" } }, - "id": "Ancestor" + "id": "Ancestor", + "description": "Identifying information for a single ancestor of a project.", + "type": "object" }, "ListConstraint": { - "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.", - "type": "object", "properties": { "suggestedValue": { "description": "Optional. The Google Cloud Console will try to default to a configuration\nthat matches the value specified in this `Constraint`.", "type": "string" } }, - "id": "ListConstraint" + "id": "ListConstraint", + "description": "A `Constraint` that allows or disallows a list of string values, which are\nconfigured by an Organization's policy administrator with a `Policy`.", + "type": "object" }, "SetOrgPolicyRequest": { "description": "The request sent to the SetOrgPolicyRequest method.", @@ -1293,14 +660,14 @@ "description": "Request message for `SetIamPolicy` method.", "type": "object", "properties": { - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" - }, "updateMask": { "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", "format": "google-fieldmask", "type": "string" + }, + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." } }, "id": "SetIamPolicyRequest" @@ -1312,44 +679,45 @@ "id": "Empty" }, "Organization": { - "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.", - "type": "object", "properties": { - "displayName": { - "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly", - "type": "string" - }, "creationTime": { "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly", "format": "google-datetime", "type": "string" }, "owner": { - "$ref": "OrganizationOwner", - "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required." + "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.", + "$ref": "OrganizationOwner" }, "lifecycleState": { - "enumDescriptions": [ - "Unspecified state. This is only useful for distinguishing unset values.", - "The normal and active state.", - "The organization has been marked for deletion by the user." - ], "enum": [ "LIFECYCLE_STATE_UNSPECIFIED", "ACTIVE", "DELETE_REQUESTED" ], "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified state. This is only useful for distinguishing unset values.", + "The normal and active state.", + "The organization has been marked for deletion by the user." + ] }, "name": { - "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".", + "type": "string", + "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\"." + }, + "displayName": { + "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly", "type": "string" } }, - "id": "Organization" + "id": "Organization", + "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.", + "type": "object" }, "ListAvailableOrgPolicyConstraintsResponse": { + "id": "ListAvailableOrgPolicyConstraintsResponse", "description": "The response returned from the ListAvailableOrgPolicyConstraints method.\nReturns all `Constraints` that could be set at this level of the hierarchy\n(contrast with the response from `ListPolicies`, which returns all policies\nwhich are set).", "type": "object", "properties": { @@ -1364,13 +732,25 @@ "$ref": "Constraint" } } - }, - "id": "ListAvailableOrgPolicyConstraintsResponse" + } }, "ListPolicy": { - "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset.", "type": "object", "properties": { + "allValues": { + "enumDescriptions": [ + "Indicates that either allowed_values or denied_values must be set.", + "A policy with this set allows all values.", + "A policy with this set denies all values." + ], + "enum": [ + "ALL_VALUES_UNSPECIFIED", + "ALLOW", + "DENY" + ], + "description": "The policy all_values state.", + "type": "string" + }, "allowedValues": { "description": "List of values allowed at this resource. Can only be set if no values\nare set for `denied_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.", "type": "array", @@ -1387,28 +767,15 @@ "type": "boolean" }, "deniedValues": { - "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`.", "type": "array", "items": { "type": "string" - } - }, - "allValues": { - "enumDescriptions": [ - "Indicates that either allowed_values or denied_values must be set.", - "A policy with this set allows all values.", - "A policy with this set denies all values." - ], - "enum": [ - "ALL_VALUES_UNSPECIFIED", - "ALLOW", - "DENY" - ], - "description": "The policy all_values state.", - "type": "string" + }, + "description": "List of values denied at this resource. Can only be set if no values are\nset for `allowed_values` and `all_values` is set to\n`ALL_VALUES_UNSPECIFIED`." } }, - "id": "ListPolicy" + "id": "ListPolicy", + "description": "Used in `policy_type` to specify how `list_policy` behaves at this\nresource.\n\nA `ListPolicy` can define specific values that are allowed or denied by\nsetting either the `allowed_values` or `denied_values` fields. It can also\nbe used to allow or deny all values, by setting the `all_values` field. If\n`all_values` is `ALL_VALUES_UNSPECIFIED`, exactly one of `allowed_values`\nor `denied_values` must be set (attempting to set both or neither will\nresult in a failed request). If `all_values` is set to either `ALLOW` or\n`DENY`, `allowed_values` and `denied_values` must be unset." }, "GetAncestryResponse": { "description": "Response from the GetAncestry method.", @@ -1436,12 +803,6 @@ } }, "logType": { - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], "enum": [ "LOG_TYPE_UNSPECIFIED", "ADMIN_READ", @@ -1449,7 +810,13 @@ "DATA_READ" ], "description": "The log type that this config enables.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ] } }, "id": "AuditLogConfig" @@ -1458,11 +825,6 @@ "description": "The request sent to the `SearchOrganizations` method.", "type": "object", "properties": { - "pageSize": { - "description": "The maximum number of Organizations to return in the response.\nThis field is optional.", - "format": "int32", - "type": "integer" - }, "filter": { "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with\n`owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.", "type": "string" @@ -1470,6 +832,11 @@ "pageToken": { "description": "A pagination token returned from a previous call to `SearchOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.", "type": "string" + }, + "pageSize": { + "description": "The maximum number of Organizations to return in the response.\nThis field is optional.", + "format": "int32", + "type": "integer" } }, "id": "SearchOrganizationsRequest" @@ -1479,506 +846,6 @@ "type": "object", "properties": {}, "id": "GetAncestryRequest" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" - }, - "ListAvailableOrgPolicyConstraintsRequest": { - "description": "The request sent to the [ListAvailableOrgPolicyConstraints]\ngoogle.cloud.OrgPolicy.v1.ListAvailableOrgPolicyConstraints] method.", - "type": "object", - "properties": { - "pageToken": { - "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.", - "type": "string" - }, - "pageSize": { - "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.", - "format": "int32", - "type": "integer" - } - }, - "id": "ListAvailableOrgPolicyConstraintsRequest" - }, - "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", - "type": "object", - "properties": { - "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", - "type": "array", - "items": { - "$ref": "AuditConfig" - } - }, - "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Deprecated.", - "format": "int32", - "type": "integer" - } - }, - "id": "Policy" - }, - "FolderOperation": { - "description": "Metadata describing a long running folder operation", - "type": "object", - "properties": { - "operationType": { - "description": "The type of this operation.", - "type": "string", - "enumDescriptions": [ - "Operation type not specified.", - "A create folder operation.", - "A move folder operation." - ], - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "CREATE", - "MOVE" - ] - }, - "displayName": { - "description": "The display name of the folder.", - "type": "string" - }, - "sourceParent": { - "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.", - "type": "string" - }, - "destinationParent": { - "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.", - "type": "string" - } - }, - "id": "FolderOperation" - }, - "ResourceId": { - "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.", - "type": "object", - "properties": { - "type": { - "description": "Required field representing the resource type this id is for.\nAt present, the valid types are: \"organization\"", - "type": "string" - }, - "id": { - "description": "Required field for the type-specific id. This should correspond to the id\nused in the type-specific API's.", - "type": "string" - } - }, - "id": "ResourceId" - }, - "GetEffectiveOrgPolicyRequest": { - "description": "The request sent to the GetEffectiveOrgPolicy method.", - "type": "object", - "properties": { - "constraint": { - "description": "The name of the `Constraint` to compute the effective `Policy`.", - "type": "string" - } - }, - "id": "GetEffectiveOrgPolicyRequest" - }, - "ListOrgPoliciesRequest": { - "description": "The request sent to the ListOrgPolicies method.", - "type": "object", - "properties": { - "pageSize": { - "description": "Size of the pages to be returned. This is currently unsupported and will\nbe ignored. The server may at any point start using this field to limit\npage size.", - "format": "int32", - "type": "integer" - }, - "pageToken": { - "description": "Page token used to retrieve the next page. This is currently unsupported\nand will be ignored. The server may at any point start using this field.", - "type": "string" - } - }, - "id": "ListOrgPoliciesRequest" - }, - "AuditConfig": { - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", - "type": "object", - "properties": { - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" - }, - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.\nNext ID: 4", - "type": "array", - "items": { - "$ref": "AuditLogConfig" - } - } - }, - "id": "AuditConfig" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "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": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - } - }, - "id": "Operation" - }, - "Constraint": { - "description": "A `Constraint` describes a way in which a resource's configuration can be\nrestricted. For example, it controls which cloud services can be activated\nacross an organization, or whether a Compute Engine instance can have\nserial port connections established. `Constraints` can be configured by the\norganization's policy adminstrator to fit the needs of the organzation by\nsetting Policies for `Constraints` at different locations in the\norganization's resource hierarchy. Policies are inherited down the resource\nhierarchy from higher levels, but can also be overridden. For details about\nthe inheritance rules please read about\nPolicies.\n\n`Constraints` have a default behavior determined by the `constraint_default`\nfield, which is the enforcement behavior that is used in the absence of a\n`Policy` being defined or inherited for the resource in question.", - "type": "object", - "properties": { - "displayName": { - "description": "The human readable name.\n\nMutable.", - "type": "string" - }, - "description": { - "description": "Detailed description of what this `Constraint` controls as well as how and\nwhere it is enforced.\n\nMutable.", - "type": "string" - }, - "booleanConstraint": { - "description": "Defines this constraint as being a BooleanConstraint.", - "$ref": "BooleanConstraint" - }, - "constraintDefault": { - "description": "The evaluation behavior of this constraint in the absense of 'Policy'.", - "type": "string", - "enumDescriptions": [ - "This is only used for distinguishing unset values and should never be\nused.", - "Indicate that all values are allowed for list constraints.\nIndicate that enforcement is off for boolean constraints.", - "Indicate that all values are denied for list constraints.\nIndicate that enforcement is on for boolean constraints." - ], - "enum": [ - "CONSTRAINT_DEFAULT_UNSPECIFIED", - "ALLOW", - "DENY" - ] - }, - "name": { - "description": "Immutable value, required to globally be unique. For example,\n`constraints/serviceuser.services`", - "type": "string" - }, - "listConstraint": { - "description": "Defines this constraint as being a ListConstraint.", - "$ref": "ListConstraint" - }, - "version": { - "description": "Version of the `Constraint`. Default version is 0;", - "format": "int32", - "type": "integer" - } - }, - "id": "Constraint" - }, - "ListLiensResponse": { - "description": "The response message for Liens.ListLiens.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no more\nresults in the list.", - "type": "string" - }, - "liens": { - "description": "A list of Liens.", - "type": "array", - "items": { - "$ref": "Lien" - } - } - }, - "id": "ListLiensResponse" - }, - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "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" - } - }, - "id": "Status" - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - } - }, - "id": "Binding" - }, - "GetOrgPolicyRequest": { - "description": "The request sent to the GetOrgPolicy method.", - "type": "object", - "properties": { - "constraint": { - "description": "Name of the `Constraint` to get the `Policy`.", - "type": "string" - } - }, - "id": "GetOrgPolicyRequest" - }, - "RestoreDefault": { - "description": "Ignores policies set above this resource and restores the\n`constraint_default` enforcement behavior of the specific `Constraint` at\nthis resource.\n\nSuppose that `constraint_default` is set to `ALLOW` for the\n`Constraint` `constraints/serviceuser.services`. Suppose that organization\nfoo.com sets a `Policy` at their Organization resource node that restricts\nthe allowed service activations to deny all service activations. They\ncould then set a `Policy` with the `policy_type` `restore_default` on\nseveral experimental projects, restoring the `constraint_default`\nenforcement of the `Constraint` for only those projects, allowing those\nprojects to have all services activated.", - "type": "object", - "properties": {}, - "id": "RestoreDefault" - }, - "ClearOrgPolicyRequest": { - "description": "The request sent to the ClearOrgPolicy method.", - "type": "object", - "properties": { - "constraint": { - "description": "Name of the `Constraint` of the `Policy` to clear.", - "type": "string" - }, - "etag": { - "description": "The current version, for concurrency control. Not sending an `etag`\nwill cause the `Policy` to be cleared blindly.", - "format": "byte", - "type": "string" - } - }, - "id": "ClearOrgPolicyRequest" - }, - "UndeleteProjectRequest": { - "description": "The request sent to the UndeleteProject\nmethod.", - "type": "object", - "properties": {}, - "id": "UndeleteProjectRequest" - }, - "ProjectCreationStatus": { - "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.", - "type": "object", - "properties": { - "ready": { - "description": "True if the project creation process is complete.", - "type": "boolean" - }, - "createTime": { - "description": "Creation time of the project creation workflow.", - "format": "google-datetime", - "type": "string" - }, - "gettable": { - "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.", - "type": "boolean" - } - }, - "id": "ProjectCreationStatus" - }, - "BooleanConstraint": { - "description": "A `Constraint` that is either enforced or not.\n\nFor example a constraint `constraints/compute.disableSerialPortAccess`.\nIf it is enforced on a VM instance, serial port connections will not be\nopened to that instance.", - "type": "object", - "properties": {}, - "id": "BooleanConstraint" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsResponse" - }, - "GetIamPolicyRequest": { - "description": "Request message for `GetIamPolicy` method.", - "type": "object", - "properties": {}, - "id": "GetIamPolicyRequest" - }, - "OrganizationOwner": { - "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.", - "type": "object", - "properties": { - "directoryCustomerId": { - "description": "The Google for Work customer id used in the Directory API.", - "type": "string" - } - }, - "id": "OrganizationOwner" - }, - "ListProjectsResponse": { - "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.", - "type": "object", - "properties": { - "projects": { - "description": "The list of Projects that matched the list filter. This list can\nbe paginated.", - "type": "array", - "items": { - "$ref": "Project" - } - }, - "nextPageToken": { - "description": "Pagination token.\n\nIf the result set is too large to fit in a single response, this token\nis returned. It encodes the position of the current result cursor.\nFeeding this value into a new list request with the `page_token` parameter\ngives the next page of the results.\n\nWhen `next_page_token` is not filled in, there is no next page and\nthe list returned is the last page in the result set.\n\nPagination tokens have a limited lifetime.", - "type": "string" - } - }, - "id": "ListProjectsResponse" - }, - "Project": { - "description": "A Project is a high-level Google Cloud Platform entity. It is a\ncontainer for ACLs, APIs, App Engine Apps, VMs, and other\nGoogle Cloud Platform resources.", - "type": "object", - "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.", - "type": "object" - }, - "createTime": { - "description": "Creation time.\n\nRead-only.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.", - "type": "string" - }, - "projectId": { - "description": "The unique, user-assigned ID of the Project.\nIt must be 6 to 30 lowercase letters, digits, or hyphens.\nIt must start with a letter.\nTrailing hyphens are prohibited.\n\nExample: \u003ccode\u003etokyo-rain-123\u003c/code\u003e\nRead-only after creation.", - "type": "string" - }, - "lifecycleState": { - "enumDescriptions": [ - "Unspecified state. This is only used/useful for distinguishing\nunset values.", - "The normal and active state.", - "The project has been marked for deletion by the user\n(by invoking\nDeleteProject)\nor by the system (Google Cloud Platform).\nThis can generally be reversed by invoking UndeleteProject.", - "This lifecycle state is no longer used and not returned by the API." - ], - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "ACTIVE", - "DELETE_REQUESTED", - "DELETE_IN_PROGRESS" - ], - "description": "The Project lifecycle state.\n\nRead-only.", - "type": "string" - }, - "projectNumber": { - "description": "The number uniquely identifying the project.\n\nExample: \u003ccode\u003e415104041262\u003c/code\u003e\nRead-only.", - "format": "int64", - "type": "string" - }, - "parent": { - "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write.", - "$ref": "ResourceId" - } - }, - "id": "Project" - }, - "ListOrgPoliciesResponse": { - "description": "The response returned from the ListOrgPolicies method. It will be empty\nif no `Policies` are set on the resource.", - "type": "object", - "properties": { - "policies": { - "description": "The `Policies` that are set on the resource. It will be empty if no\n`Policies` are set.", - "type": "array", - "items": { - "$ref": "OrgPolicy" - } - }, - "nextPageToken": { - "description": "Page token used to retrieve the next page. This is currently not used, but\nthe server may at any point start supplying a valid token.", - "type": "string" - } - }, - "id": "ListOrgPoliciesResponse" - }, - "SearchOrganizationsResponse": { - "description": "The response returned from the `SearchOrganizations` method.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.", - "type": "string" - }, - "organizations": { - "description": "The list of Organizations that matched the search query, possibly\npaginated.", - "type": "array", - "items": { - "$ref": "Organization" - } - } - }, - "id": "SearchOrganizationsResponse" } }, "icons": { @@ -2004,5 +871,1138 @@ "name": "cloudresourcemanager", "batchPath": "batch", "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Resource Manager API" + "title": "Google Cloud Resource Manager API", + "ownerName": "Google", + "resources": { + "organizations": { + "methods": { + "getOrgPolicy": { + "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.", + "request": { + "$ref": "GetOrgPolicyRequest" + }, + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "Name of the resource the `Policy` is set on.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/organizations/{organizationsId}:getOrgPolicy", + "path": "v1/{+resource}:getOrgPolicy", + "id": "cloudresourcemanager.organizations.getOrgPolicy" + }, + "search": { + "response": { + "$ref": "SearchOrganizationsResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/organizations:search", + "path": "v1/organizations:search", + "id": "cloudresourcemanager.organizations.search", + "request": { + "$ref": "SearchOrganizationsRequest" + }, + "description": "Searches Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the\nresults.\n\nSearch will only return organizations on which the user has the permission\n`resourcemanager.organizations.get`" + }, + "getEffectiveOrgPolicy": { + "path": "v1/{+resource}:getEffectiveOrgPolicy", + "id": "cloudresourcemanager.organizations.getEffectiveOrgPolicy", + "request": { + "$ref": "GetEffectiveOrgPolicyRequest" + }, + "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.", + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "The name of the resource to start computing the effective `Policy`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/organizations/{organizationsId}:getEffectiveOrgPolicy" + }, + "get": { + "path": "v1/{+name}", + "id": "cloudresourcemanager.organizations.get", + "description": "Fetches an Organization resource identified by the specified resource name.", + "response": { + "$ref": "Organization" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/organizations/{organizationsId}" + }, + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/organizations/{organizationsId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "cloudresourcemanager.organizations.testIamPermissions", + "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".\n\nThere are no permissions required for making this API call.", + "request": { + "$ref": "TestIamPermissionsRequest" + } + }, + "clearOrgPolicy": { + "description": "Clears a `Policy` from a resource.", + "request": { + "$ref": "ClearOrgPolicyRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "description": "Name of the resource for the `Policy` to clear.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/organizations/{organizationsId}:clearOrgPolicy", + "path": "v1/{+resource}:clearOrgPolicy", + "id": "cloudresourcemanager.organizations.clearOrgPolicy" + }, + "setOrgPolicy": { + "id": "cloudresourcemanager.organizations.setOrgPolicy", + "path": "v1/{+resource}:setOrgPolicy", + "request": { + "$ref": "SetOrgPolicyRequest" + }, + "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "OrgPolicy" + }, + "parameters": { + "resource": { + "description": "Resource name of the resource to attach the `Policy`.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/organizations/{organizationsId}:setOrgPolicy" + }, + "setIamPolicy": { + "path": "v1/{+resource}:setIamPolicy", + "id": "cloudresourcemanager.organizations.setIamPolicy", + "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.setIamPolicy` on the specified organization", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/organizations/{organizationsId}:setIamPolicy" + }, + "listOrgPolicies": { + "path": "v1/{+resource}:listOrgPolicies", + "id": "cloudresourcemanager.organizations.listOrgPolicies", + "description": "Lists all the `Policies` set for a particular resource.", + "request": { + "$ref": "ListOrgPoliciesRequest" + }, + "response": { + "$ref": "ListOrgPoliciesResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "Name of the resource to list Policies for.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/organizations/{organizationsId}:listOrgPolicies" + }, + "listAvailableOrgPolicyConstraints": { + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "ListAvailableOrgPolicyConstraintsResponse" + }, + "parameters": { + "resource": { + "location": "path", + "description": "Name of the resource to list `Constraints` for.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/organizations/{organizationsId}:listAvailableOrgPolicyConstraints", + "id": "cloudresourcemanager.organizations.listAvailableOrgPolicyConstraints", + "path": "v1/{+resource}:listAvailableOrgPolicyConstraints", + "request": { + "$ref": "ListAvailableOrgPolicyConstraintsRequest" + }, + "description": "Lists `Constraints` that could be applied on the specified resource." + }, + "getIamPolicy": { + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".\n\nAuthorization requires the Google IAM permission\n`resourcemanager.organizations.getIamPolicy` on the specified organization", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/organizations/{organizationsId}:getIamPolicy", + "id": "cloudresourcemanager.organizations.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy" + } + } + }, + "liens": { + "methods": { + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "description": "The name/identifier of the Lien to delete.", + "required": true, + "type": "string", + "pattern": "^liens/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/liens/{liensId}", + "id": "cloudresourcemanager.liens.delete", + "path": "v1/{+name}", + "description": "Delete a Lien by `name`.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`." + }, + "list": { + "flatPath": "v1/liens", + "id": "cloudresourcemanager.liens.list", + "path": "v1/liens", + "description": "List all Liens applied to the `parent` resource.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, a Lien with a `parent` of `projects/1234` requires permission\n`resourcemanager.projects.get`.", + "httpMethod": "GET", + "response": { + "$ref": "ListLiensResponse" + }, + "parameterOrder": [], + "parameters": { + "parent": { + "location": "query", + "description": "The name of the resource to list all attached Liens.\nFor example, `projects/1234`.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The `next_page_token` value returned from a previous List request, if any.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of items to return. This is a suggestion for the server.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "create": { + "description": "Create a Lien which applies to the resource denoted by the `parent` field.\n\nCallers of this method will require permission on the `parent` resource.\nFor example, applying to `projects/1234` requires permission\n`resourcemanager.projects.updateLiens`.\n\nNOTE: Some resources may limit the number of Liens which may be applied.", + "request": { + "$ref": "Lien" + }, + "response": { + "$ref": "Lien" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": {}, + "flatPath": "v1/liens", + "path": "v1/liens", + "id": "cloudresourcemanager.liens.create" + } + } + }, + "operations": { + "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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^operations/.+$", + "location": "path" + } + }, + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "cloudresourcemanager.operations.get" + } + } + }, + "folders": { + "methods": { + "clearOrgPolicy": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "description": "Name of the resource for the `Policy` to clear.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/folders/{foldersId}:clearOrgPolicy", + "path": "v1/{+resource}:clearOrgPolicy", + "id": "cloudresourcemanager.folders.clearOrgPolicy", + "request": { + "$ref": "ClearOrgPolicyRequest" + }, + "description": "Clears a `Policy` from a resource." + }, + "setOrgPolicy": { + "flatPath": "v1/folders/{foldersId}:setOrgPolicy", + "path": "v1/{+resource}:setOrgPolicy", + "id": "cloudresourcemanager.folders.setOrgPolicy", + "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.", + "request": { + "$ref": "SetOrgPolicyRequest" + }, + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "description": "Resource name of the resource to attach the `Policy`.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + } + }, + "listAvailableOrgPolicyConstraints": { + "request": { + "$ref": "ListAvailableOrgPolicyConstraintsRequest" + }, + "description": "Lists `Constraints` that could be applied on the specified resource.", + "response": { + "$ref": "ListAvailableOrgPolicyConstraintsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "Name of the resource to list `Constraints` for.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/folders/{foldersId}:listAvailableOrgPolicyConstraints", + "path": "v1/{+resource}:listAvailableOrgPolicyConstraints", + "id": "cloudresourcemanager.folders.listAvailableOrgPolicyConstraints" + }, + "listOrgPolicies": { + "request": { + "$ref": "ListOrgPoliciesRequest" + }, + "description": "Lists all the `Policies` set for a particular resource.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "ListOrgPoliciesResponse" + }, + "parameters": { + "resource": { + "description": "Name of the resource to list Policies for.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/folders/{foldersId}:listOrgPolicies", + "id": "cloudresourcemanager.folders.listOrgPolicies", + "path": "v1/{+resource}:listOrgPolicies" + }, + "getOrgPolicy": { + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "description": "Name of the resource the `Policy` is set on.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/folders/{foldersId}:getOrgPolicy", + "path": "v1/{+resource}:getOrgPolicy", + "id": "cloudresourcemanager.folders.getOrgPolicy", + "request": { + "$ref": "GetOrgPolicyRequest" + }, + "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write." + }, + "getEffectiveOrgPolicy": { + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "location": "path", + "description": "The name of the resource to start computing the effective `Policy`.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$" + } + }, + "flatPath": "v1/folders/{foldersId}:getEffectiveOrgPolicy", + "path": "v1/{+resource}:getEffectiveOrgPolicy", + "id": "cloudresourcemanager.folders.getEffectiveOrgPolicy", + "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.", + "request": { + "$ref": "GetEffectiveOrgPolicyRequest" + } + } + } + }, + "projects": { + "methods": { + "listOrgPolicies": { + "description": "Lists all the `Policies` set for a particular resource.", + "request": { + "$ref": "ListOrgPoliciesRequest" + }, + "response": { + "$ref": "ListOrgPoliciesResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "location": "path", + "description": "Name of the resource to list Policies for.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}:listOrgPolicies", + "path": "v1/{+resource}:listOrgPolicies", + "id": "cloudresourcemanager.projects.listOrgPolicies" + }, + "get": { + "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.", + "response": { + "$ref": "Project" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "projectId": { + "required": true, + "type": "string", + "location": "path", + "description": "The Project ID (for example, `my-project-123`).\n\nRequired." + } + }, + "flatPath": "v1/projects/{projectId}", + "path": "v1/projects/{projectId}", + "id": "cloudresourcemanager.projects.get" + }, + "getAncestry": { + "response": { + "$ref": "GetAncestryResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The Project ID (for example, `my-project-123`).\n\nRequired.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectId}:getAncestry", + "path": "v1/projects/{projectId}:getAncestry", + "id": "cloudresourcemanager.projects.getAncestry", + "request": { + "$ref": "GetAncestryRequest" + }, + "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project." + }, + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{resource}:testIamPermissions", + "path": "v1/projects/{resource}:testIamPermissions", + "id": "cloudresourcemanager.projects.testIamPermissions", + "description": "Returns permissions that a caller has on the specified Project.\n\nThere are no permissions required for making this API call.", + "request": { + "$ref": "TestIamPermissionsRequest" + } + }, + "delete": { + "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time,\nat which point the Project is no longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}", + "path": "v1/projects/{projectId}", + "id": "cloudresourcemanager.projects.delete" + }, + "clearOrgPolicy": { + "request": { + "$ref": "ClearOrgPolicyRequest" + }, + "description": "Clears a `Policy` from a resource.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "resource": { + "location": "path", + "description": "Name of the resource for the `Policy` to clear.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}:clearOrgPolicy", + "id": "cloudresourcemanager.projects.clearOrgPolicy", + "path": "v1/{+resource}:clearOrgPolicy" + }, + "setIamPolicy": { + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{resource}:setIamPolicy", + "id": "cloudresourcemanager.projects.setIamPolicy", + "path": "v1/projects/{resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`;\nthey must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.setIamPolicy` on the project" + }, + "listAvailableOrgPolicyConstraints": { + "response": { + "$ref": "ListAvailableOrgPolicyConstraintsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "description": "Name of the resource to list `Constraints` for.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}:listAvailableOrgPolicyConstraints", + "path": "v1/{+resource}:listAvailableOrgPolicyConstraints", + "id": "cloudresourcemanager.projects.listAvailableOrgPolicyConstraints", + "description": "Lists `Constraints` that could be applied on the specified resource.", + "request": { + "$ref": "ListAvailableOrgPolicyConstraintsRequest" + } + }, + "getIamPolicy": { + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{resource}:getIamPolicy", + "path": "v1/projects/{resource}:getIamPolicy", + "id": "cloudresourcemanager.projects.getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.getIamPolicy` on the project.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names)." + }, + "getOrgPolicy": { + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "resource": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Name of the resource the `Policy` is set on.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}:getOrgPolicy", + "path": "v1/{+resource}:getOrgPolicy", + "id": "cloudresourcemanager.projects.getOrgPolicy", + "description": "Gets a `Policy` on a resource.\n\nIf no `Policy` is set on the resource, a `Policy` is returned with default\nvalues including `POLICY_TYPE_NOT_SET` for the `policy_type oneof`. The\n`etag` value can be used with `SetOrgPolicy()` to create or update a\n`Policy` during read-modify-write.", + "request": { + "$ref": "GetOrgPolicyRequest" + } + }, + "getEffectiveOrgPolicy": { + "parameters": { + "resource": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The name of the resource to start computing the effective `Policy`." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/projects/{projectsId}:getEffectiveOrgPolicy", + "id": "cloudresourcemanager.projects.getEffectiveOrgPolicy", + "path": "v1/{+resource}:getEffectiveOrgPolicy", + "request": { + "$ref": "GetEffectiveOrgPolicyRequest" + }, + "description": "Gets the effective `Policy` on a resource. This is the result of merging\n`Policies` in the resource hierarchy. The returned `Policy` will not have\nan `etag`set because it is a computed `Policy` across multiple resources.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "OrgPolicy" + } + }, + "undelete": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "projectId": { + "description": "The project ID (for example, `foo-bar-123`).\n\nRequired.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}:undelete", + "id": "cloudresourcemanager.projects.undelete", + "path": "v1/projects/{projectId}:undelete", + "request": { + "$ref": "UndeleteProjectRequest" + }, + "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project." + }, + "update": { + "flatPath": "v1/projects/{projectId}", + "id": "cloudresourcemanager.projects.update", + "path": "v1/projects/{projectId}", + "request": { + "$ref": "Project" + }, + "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.", + "httpMethod": "PUT", + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "Project" + }, + "parameters": { + "projectId": { + "description": "The project ID (for example, `my-project-123`).\n\nRequired.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "response": { + "$ref": "ListProjectsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "filter": { + "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v1/projects", + "path": "v1/projects", + "id": "cloudresourcemanager.projects.list", + "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the\nGetProject method." + }, + "setOrgPolicy": { + "flatPath": "v1/projects/{projectsId}:setOrgPolicy", + "path": "v1/{+resource}:setOrgPolicy", + "id": "cloudresourcemanager.projects.setOrgPolicy", + "request": { + "$ref": "SetOrgPolicyRequest" + }, + "description": "Updates the specified `Policy` on the resource. Creates a new `Policy` for\nthat `Constraint` on the resource if one does not exist.\n\nNot supplying an `etag` on the request `Policy` results in an unconditional\nwrite of the `Policy`.", + "response": { + "$ref": "OrgPolicy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Resource name of the resource to attach the `Policy`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "description": "Request that a new Project be created. The result is an Operation which\ncan be used to track the creation process. It is automatically deleted\nafter a few hours, so there is no need to call DeleteOperation.\n\nOur SLO permits Project creation to take up to 30 seconds at the 90th\npercentile. As of 2016-08-29, we are observing 6 seconds 50th percentile\nlatency. 95th percentile latency is around 11 seconds. We recommend\npolling at the 5th second with an exponential backoff.\n\nAuthorization requires the Google IAM permission\n`resourcemanager.projects.create` on the specified parent for the new\nproject.", + "request": { + "$ref": "Project" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v1/projects", + "path": "v1/projects", + "id": "cloudresourcemanager.projects.create" + } + } + } + }, + "parameters": { + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "type": "string", + "location": "query", + "description": "OAuth bearer token." + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format." + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "type": "string", + "location": "query", + "description": "OAuth access token." + }, + "key": { + "location": "query", + "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.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://cloudresourcemanager.googleapis.com/", + "kind": "discovery#restDescription", + "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.", + "servicePath": "", + "basePath": "" }
diff --git a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json index 3bea0d1..1c86087 100644 --- a/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json +++ b/cloudresourcemanager/v1beta1/cloudresourcemanager-api.json
@@ -1,129 +1,6 @@ { - "revision": "20180103", - "documentationLink": "https://cloud.google.com/resource-manager", - "id": "cloudresourcemanager:v1beta1", - "discoveryVersion": "v1", "schemas": { - "Ancestor": { - "description": "Identifying information for a single ancestor of a project.", - "type": "object", - "properties": { - "resourceId": { - "$ref": "ResourceId", - "description": "Resource id of the ancestor." - } - }, - "id": "Ancestor" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." - }, - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "SetIamPolicyRequest" - }, - "ListOrganizationsResponse": { - "description": "The response returned from the `ListOrganizations` method.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.", - "type": "string" - }, - "organizations": { - "description": "The list of Organizations that matched the list query, possibly paginated.", - "type": "array", - "items": { - "$ref": "Organization" - } - } - }, - "id": "ListOrganizationsResponse" - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - } - }, - "id": "Binding" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "UndeleteProjectRequest": { - "description": "The request sent to the UndeleteProject\nmethod.", - "type": "object", - "properties": {}, - "id": "UndeleteProjectRequest" - }, - "Organization": { - "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong.", - "type": "object", - "properties": { - "organizationId": { - "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.", - "type": "string" - }, - "lifecycleState": { - "enumDescriptions": [ - "Unspecified state. This is only useful for distinguishing unset values.", - "The normal and active state.", - "The organization has been marked for deletion by the user." - ], - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "ACTIVE", - "DELETE_REQUESTED" - ], - "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly", - "type": "string" - }, - "displayName": { - "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly", - "type": "string" - }, - "creationTime": { - "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "owner": { - "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.", - "$ref": "OrganizationOwner" - }, - "name": { - "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".", - "type": "string" - } - }, - "id": "Organization" - }, "ProjectCreationStatus": { - "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.", - "type": "object", "properties": { "ready": { "description": "True if the project creation process is complete.", @@ -139,15 +16,12 @@ "type": "boolean" } }, - "id": "ProjectCreationStatus" - }, - "GetIamPolicyRequest": { - "description": "Request message for `GetIamPolicy` method.", - "type": "object", - "properties": {}, - "id": "GetIamPolicyRequest" + "id": "ProjectCreationStatus", + "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.", + "type": "object" }, "TestIamPermissionsResponse": { + "id": "TestIamPermissionsResponse", "description": "Response message for `TestIamPermissions` method.", "type": "object", "properties": { @@ -158,22 +32,15 @@ "type": "string" } } - }, - "id": "TestIamPermissionsResponse" + } }, - "OrganizationOwner": { - "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.", + "GetIamPolicyRequest": { "type": "object", - "properties": { - "directoryCustomerId": { - "description": "The Google for Work customer id used in the Directory API.", - "type": "string" - } - }, - "id": "OrganizationOwner" + "properties": {}, + "id": "GetIamPolicyRequest", + "description": "Request message for `GetIamPolicy` method." }, "GetAncestryResponse": { - "description": "Response from the GetAncestry method.", "type": "object", "properties": { "ancestor": { @@ -184,37 +51,19 @@ } } }, - "id": "GetAncestryResponse" + "id": "GetAncestryResponse", + "description": "Response from the GetAncestry method." }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", - "type": "object", + "OrganizationOwner": { "properties": { - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", - "type": "array", - "items": { - "type": "string" - } - }, - "logType": { - "description": "The log type that this config enables.", - "type": "string", - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ] + "directoryCustomerId": { + "description": "The Google for Work customer id used in the Directory API.", + "type": "string" } }, - "id": "AuditLogConfig" + "id": "OrganizationOwner", + "description": "The entity that owns an Organization. The lifetime of the Organization and\nall of its descendants are bound to the `OrganizationOwner`. If the\n`OrganizationOwner` is deleted, the Organization and all its descendants will\nbe deleted.", + "type": "object" }, "ListProjectsResponse": { "description": "A page of the response received from the\nListProjects\nmethod.\n\nA paginated response where more pages are available has\n`next_page_token` set. This token can be used in a subsequent request to\nretrieve the next request page.", @@ -234,6 +83,36 @@ }, "id": "ListProjectsResponse" }, + "AuditLogConfig": { + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", + "type": "object", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", + "type": "array", + "items": { + "type": "string" + } + }, + "logType": { + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "description": "The log type that this config enables.", + "type": "string" + } + }, + "id": "AuditLogConfig" + }, "GetAncestryRequest": { "description": "The request sent to the\nGetAncestry\nmethod.", "type": "object", @@ -253,18 +132,18 @@ "$ref": "ResourceId", "description": "An optional reference to a parent Resource.\n\nSupported parent types include \"organization\" and \"folder\". Once set, the\nparent cannot be cleared. The `parent` can be set on creation or using the\n`UpdateProject` method; the end user must have the\n`resourcemanager.projects.create` permission on the parent.\n\nRead-write." }, - "labels": { - "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, "createTime": { "description": "Creation time.\n\nRead-only.", "format": "google-datetime", "type": "string" }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels associated with this Project.\n\nLabel keys must be between 1 and 63 characters long and must conform\nto the following regular expression: \\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?.\n\nLabel values must be between 0 and 63 characters long and must conform\nto the regular expression (\\[a-z\\](\\[-a-z0-9\\]*\\[a-z0-9\\])?)?.\n\nNo more than 256 labels can be associated with a given resource.\n\nClients should store labels in a representation such as JSON that does not\ndepend on specific characters being disallowed.\n\nExample: \u003ccode\u003e\"environment\" : \"dev\"\u003c/code\u003e\nRead-write.", + "type": "object" + }, "name": { "description": "The user-assigned display name of the Project.\nIt must be 4 to 30 characters.\nAllowed characters are: lowercase and uppercase letters, numbers,\nhyphen, single-quote, double-quote, space, and exclamation point.\n\nExample: \u003ccode\u003eMy Project\u003c/code\u003e\nRead-write.", "type": "string" @@ -274,6 +153,8 @@ "type": "string" }, "lifecycleState": { + "description": "The Project lifecycle state.\n\nRead-only.", + "type": "string", "enumDescriptions": [ "Unspecified state. This is only used/useful for distinguishing\nunset values.", "The normal and active state.", @@ -285,14 +166,13 @@ "ACTIVE", "DELETE_REQUESTED", "DELETE_IN_PROGRESS" - ], - "description": "The Project lifecycle state.\n\nRead-only.", - "type": "string" + ] } }, "id": "Project" }, "TestIamPermissionsRequest": { + "id": "TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { @@ -303,17 +183,15 @@ "type": "string" } } - }, - "id": "TestIamPermissionsRequest" + } }, "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", "type": "object", "properties": { "etag": { + "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" + "format": "byte" }, "version": { "description": "Deprecated.", @@ -321,11 +199,11 @@ "type": "integer" }, "auditConfigs": { - "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", "items": { "$ref": "AuditConfig" - } + }, + "description": "Specifies cloud audit logging configuration for this policy." }, "bindings": { "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", @@ -335,24 +213,13 @@ } } }, - "id": "Policy" + "id": "Policy", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs)." }, "FolderOperation": { "description": "Metadata describing a long running folder operation", "type": "object", "properties": { - "displayName": { - "description": "The display name of the folder.", - "type": "string" - }, - "sourceParent": { - "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.", - "type": "string" - }, - "destinationParent": { - "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.", - "type": "string" - }, "operationType": { "enumDescriptions": [ "Operation type not specified.", @@ -366,12 +233,23 @@ ], "description": "The type of this operation.", "type": "string" + }, + "displayName": { + "description": "The display name of the folder.", + "type": "string" + }, + "sourceParent": { + "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.", + "type": "string" + }, + "destinationParent": { + "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.", + "type": "string" } }, "id": "FolderOperation" }, "FolderOperationError": { - "description": "A classification of the Folder Operation error.", "type": "object", "properties": { "errorMessageId": { @@ -403,7 +281,8 @@ "type": "string" } }, - "id": "FolderOperationError" + "id": "FolderOperationError", + "description": "A classification of the Folder Operation error." }, "ResourceId": { "description": "A container to reference an id for any resource type. A `resource` in Google\nCloud Platform is a generic term for something you (a developer) may want to\ninteract with through one of our API's. Some examples are an App Engine app,\na Compute Engine instance, a Cloud SQL database, and so on.", @@ -424,24 +303,141 @@ "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", "type": "object", "properties": { - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" - }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.\nNext ID: 4", "type": "array", "items": { "$ref": "AuditLogConfig" } + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" } }, "id": "AuditConfig" + }, + "Ancestor": { + "type": "object", + "properties": { + "resourceId": { + "description": "Resource id of the ancestor.", + "$ref": "ResourceId" + } + }, + "id": "Ancestor", + "description": "Identifying information for a single ancestor of a project." + }, + "SetIamPolicyRequest": { + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + }, + "updateMask": { + "type": "string", + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "format": "google-fieldmask" + } + }, + "id": "SetIamPolicyRequest", + "description": "Request message for `SetIamPolicy` method.", + "type": "object" + }, + "ListOrganizationsResponse": { + "id": "ListOrganizationsResponse", + "description": "The response returned from the `ListOrganizations` method.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A pagination token to be used to retrieve the next page of results. If the\nresult is too large to fit within the page size specified in the request,\nthis field will be set with a token that can be used to fetch the next page\nof results. If this field is empty, it indicates that this response\ncontains the last page of results.", + "type": "string" + }, + "organizations": { + "description": "The list of Organizations that matched the list query, possibly paginated.", + "type": "array", + "items": { + "$ref": "Organization" + } + } + } + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "type": "object", + "properties": { + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + } + }, + "id": "Binding" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "Organization": { + "type": "object", + "properties": { + "creationTime": { + "description": "Timestamp when the Organization was created. Assigned by the server.\n@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "owner": { + "description": "The owner of this Organization. The owner should be specified on\ncreation. Once set, it cannot be changed.\nThis field is required.", + "$ref": "OrganizationOwner" + }, + "name": { + "type": "string", + "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\"." + }, + "organizationId": { + "description": "An immutable id for the Organization that is assigned on creation. This\nshould be omitted when creating a new Organization.\nThis field is read-only.\nThis field is deprecated and will be removed in v1. Use name instead.", + "type": "string" + }, + "lifecycleState": { + "enumDescriptions": [ + "Unspecified state. This is only useful for distinguishing unset values.", + "The normal and active state.", + "The organization has been marked for deletion by the user." + ], + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "ACTIVE", + "DELETE_REQUESTED" + ], + "description": "The organization's current lifecycle state. Assigned by the server.\n@OutputOnly", + "type": "string" + }, + "displayName": { + "description": "A friendly string to be used to refer to the Organization in the UI.\nAssigned by the server, set to the primary domain of the G Suite\ncustomer that owns the organization.\n@OutputOnly", + "type": "string" + } + }, + "id": "Organization", + "description": "The root node in the resource hierarchy to which a particular entity's\n(e.g., company) resources belong." + }, + "UndeleteProjectRequest": { + "description": "The request sent to the UndeleteProject\nmethod.", + "type": "object", + "properties": {}, + "id": "UndeleteProjectRequest" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "canonicalName": "Cloud Resource Manager", @@ -465,191 +461,124 @@ "title": "Google Cloud Resource Manager API", "ownerName": "Google", "resources": { - "organizations": { + "projects": { "methods": { - "list": { - "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.", - "response": { - "$ref": "ListOrganizationsResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "description": "The maximum number of Organizations to return in the response.\nThis field is optional.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.", - "type": "string" - }, - "pageToken": { - "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta1/organizations", - "path": "v1beta1/organizations", - "id": "cloudresourcemanager.organizations.list" - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy", - "path": "v1beta1/{+resource}:setIamPolicy", - "id": "cloudresourcemanager.organizations.setIamPolicy", - "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\".", - "request": { - "$ref": "SetIamPolicyRequest" - } - }, - "getIamPolicy": { - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy", - "path": "v1beta1/{+resource}:getIamPolicy", - "id": "cloudresourcemanager.organizations.getIamPolicy" - }, - "get": { - "description": "Fetches an Organization resource identified by the specified resource name.", - "response": { - "$ref": "Organization" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$" - }, - "organizationId": { - "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta1/organizations/{organizationsId}", - "path": "v1beta1/{+name}", - "id": "cloudresourcemanager.organizations.get" - }, - "update": { - "request": { - "$ref": "Organization" - }, - "description": "Updates an Organization resource identified by the specified resource name.", - "response": { - "$ref": "Organization" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PUT", - "parameters": { - "name": { - "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/organizations/{organizationsId}", - "path": "v1beta1/{+name}", - "id": "cloudresourcemanager.organizations.update" - }, "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\".", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], "response": { "$ref": "TestIamPermissionsResponse" }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", - "pattern": "^organizations/[^/]+$", "location": "path" } }, + "flatPath": "v1beta1/projects/{resource}:testIamPermissions", + "path": "v1beta1/projects/{resource}:testIamPermissions", + "id": "cloudresourcemanager.projects.testIamPermissions", + "description": "Returns permissions that a caller has on the specified Project.", + "request": { + "$ref": "TestIamPermissionsRequest" + } + }, + "delete": { + "id": "cloudresourcemanager.projects.delete", + "path": "v1beta1/projects/{projectId}", + "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.", + "httpMethod": "DELETE", + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectId}" + }, + "list": { + "path": "v1beta1/projects", + "id": "cloudresourcemanager.projects.list", + "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.", + "response": { + "$ref": "ListProjectsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], - "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions", - "id": "cloudresourcemanager.organizations.testIamPermissions", - "path": "v1beta1/{+resource}:testIamPermissions" - } - } - }, - "projects": { - "methods": { - "getIamPolicy": { + "parameters": { + "filter": { + "location": "query", + "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v1beta1/projects" + }, + "create": { + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "Project" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "useLegacyStack": { + "description": "A safety hatch to opt out of the new reliable project creation process.", + "type": "boolean", + "location": "query" + } + }, + "flatPath": "v1beta1/projects", + "id": "cloudresourcemanager.projects.create", + "path": "v1beta1/projects", + "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.", + "request": { + "$ref": "Project" + } + }, + "setIamPolicy": { + "path": "v1beta1/projects/{resource}:setIamPolicy", + "id": "cloudresourcemanager.projects.setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.", "response": { "$ref": "Policy" }, @@ -660,56 +589,45 @@ "parameters": { "resource": { "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string" } }, "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{resource}:setIamPolicy" + }, + "getIamPolicy": { + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names).", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only" ], "flatPath": "v1beta1/projects/{resource}:getIamPolicy", - "path": "v1beta1/projects/{resource}:getIamPolicy", "id": "cloudresourcemanager.projects.getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Returns the IAM access control policy for the specified Project.\nPermission is denied if the policy or the resource does not exist.\n\nFor additional information about resource structure and identification,\nsee [Resource Names](/apis/design/resource_names)." - }, - "get": { - "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.", - "response": { - "$ref": "Project" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "location": "path", - "description": "The Project ID (for example, `my-project-123`).\n\nRequired.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1beta1/projects/{projectId}", - "path": "v1beta1/projects/{projectId}", - "id": "cloudresourcemanager.projects.get" + "path": "v1beta1/projects/{resource}:getIamPolicy" }, "undelete": { - "flatPath": "v1beta1/projects/{projectId}:undelete", - "id": "cloudresourcemanager.projects.undelete", - "path": "v1beta1/projects/{projectId}:undelete", - "request": { - "$ref": "UndeleteProjectRequest" - }, - "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project.", "httpMethod": "POST", "parameterOrder": [ "projectId" @@ -727,6 +645,38 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}:undelete", + "id": "cloudresourcemanager.projects.undelete", + "path": "v1beta1/projects/{projectId}:undelete", + "request": { + "$ref": "UndeleteProjectRequest" + }, + "description": "Restores the Project identified by the specified\n`project_id` (for example, `my-project-123`).\nYou can only use this method for a Project that has a lifecycle state of\nDELETE_REQUESTED.\nAfter deletion starts, the Project cannot be restored.\n\nThe caller must have modify permissions for this Project." + }, + "get": { + "flatPath": "v1beta1/projects/{projectId}", + "id": "cloudresourcemanager.projects.get", + "path": "v1beta1/projects/{projectId}", + "description": "Retrieves the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project.", + "httpMethod": "GET", + "response": { + "$ref": "Project" + }, + "parameterOrder": [ + "projectId" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Project ID (for example, `my-project-123`).\n\nRequired.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" ] }, "getAncestry": { @@ -758,39 +708,39 @@ "description": "Gets a list of ancestors in the resource hierarchy for the Project\nidentified by the specified `project_id` (for example, `my-project-123`).\n\nThe caller must have read permissions for this Project." }, "update": { - "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project.", - "request": { - "$ref": "Project" - }, - "response": { - "$ref": "Project" - }, + "httpMethod": "PUT", "parameterOrder": [ "projectId" ], - "httpMethod": "PUT", + "response": { + "$ref": "Project" + }, + "parameters": { + "projectId": { + "required": true, + "type": "string", + "location": "path", + "description": "The project ID (for example, `my-project-123`).\n\nRequired." + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "parameters": { - "projectId": { - "description": "The project ID (for example, `my-project-123`).\n\nRequired.", - "required": true, - "type": "string", - "location": "path" - } - }, "flatPath": "v1beta1/projects/{projectId}", + "id": "cloudresourcemanager.projects.update", "path": "v1beta1/projects/{projectId}", - "id": "cloudresourcemanager.projects.update" - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified Project.", "request": { - "$ref": "TestIamPermissionsRequest" + "$ref": "Project" }, + "description": "Updates the attributes of the Project identified by the specified\n`project_id` (for example, `my-project-123`).\n\nThe caller must have modify permissions for this Project." + } + } + }, + "organizations": { + "methods": { + "getIamPolicy": { "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "Policy" }, "parameterOrder": [ "resource" @@ -802,44 +752,113 @@ ], "parameters": { "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{resource}:testIamPermissions", - "path": "v1beta1/projects/{resource}:testIamPermissions", - "id": "cloudresourcemanager.projects.testIamPermissions" - }, - "delete": { - "description": "Marks the Project identified by the specified\n`project_id` (for example, `my-project-123`) for deletion.\nThis method will only affect the Project if the following criteria are met:\n\n+ The Project does not have a billing account associated with it.\n+ The Project has a lifecycle state of\nACTIVE.\n\nThis method changes the Project's lifecycle state from\nACTIVE\nto DELETE_REQUESTED.\nThe deletion starts at an unspecified time, at which point the project is\nno longer accessible.\n\nUntil the deletion completes, you can check the lifecycle state\nchecked by retrieving the Project with GetProject,\nand the Project remains visible to ListProjects.\nHowever, you cannot update the project.\n\nAfter the deletion completes, the Project is not retrievable by\nthe GetProject and\nListProjects methods.\n\nThe caller must have modify permissions for this Project.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "DELETE", - "parameters": { - "projectId": { + "pattern": "^organizations/[^/]+$", "location": "path", - "description": "The Project ID (for example, `foo-bar-123`).\n\nRequired.", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string" } }, + "flatPath": "v1beta1/organizations/{organizationsId}:getIamPolicy", + "path": "v1beta1/{+resource}:getIamPolicy", + "id": "cloudresourcemanager.organizations.getIamPolicy", + "description": "Gets the access control policy for an Organization resource. May be empty\nif no such policy or resource exists. The `resource` field should be the\norganization's resource name, e.g. \"organizations/123\".", + "request": { + "$ref": "GetIamPolicyRequest" + } + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Organization" + }, + "parameters": { + "organizationId": { + "description": "The id of the Organization resource to fetch.\nThis field is deprecated and will be removed in v1. Use name instead.", + "type": "string", + "location": "query" + }, + "name": { + "description": "The resource name of the Organization to fetch, e.g. \"organizations/1234\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta1/organizations/{organizationsId}", + "id": "cloudresourcemanager.organizations.get", + "path": "v1beta1/{+name}", + "description": "Fetches an Organization resource identified by the specified resource name." + }, + "update": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1beta1/projects/{projectId}", - "path": "v1beta1/projects/{projectId}", - "id": "cloudresourcemanager.projects.delete" + "parameters": { + "name": { + "location": "path", + "description": "Output Only. The resource name of the organization. This is the\norganization's relative path in the API. Its format is\n\"organizations/[organization_id]\". For example, \"organizations/1234\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$" + } + }, + "flatPath": "v1beta1/organizations/{organizationsId}", + "path": "v1beta1/{+name}", + "id": "cloudresourcemanager.organizations.update", + "description": "Updates an Organization resource identified by the specified resource name.", + "request": { + "$ref": "Organization" + }, + "response": { + "$ref": "Organization" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PUT" + }, + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1beta1/organizations/{organizationsId}:testIamPermissions", + "path": "v1beta1/{+resource}:testIamPermissions", + "id": "cloudresourcemanager.organizations.testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified Organization.\nThe `resource` field should be the organization's resource name,\ne.g. \"organizations/123\"." }, "list": { - "description": "Lists Projects that are visible to the user and satisfy the\nspecified filter. This method returns Projects in an unspecified order.\nThis method is eventually consistent with project mutations; this means\nthat a newly created project may not appear in the results or recent\nupdates to an existing project may not be reflected in the results. To\nretrieve the latest state of a project, use the GetProjectmethod.", + "description": "Lists Organization resources that are visible to the user and satisfy\nthe specified filter. This method returns Organizations in an unspecified\norder. New Organizations do not necessarily appear at the end of the list.", "response": { - "$ref": "ListProjectsResponse" + "$ref": "ListOrganizationsResponse" }, "parameterOrder": [], "httpMethod": "GET", @@ -848,56 +867,28 @@ "https://www.googleapis.com/auth/cloud-platform.read-only" ], "parameters": { - "filter": { - "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n+ `name`\n+ `id`\n+ \u003ccode\u003elabels.\u003cem\u003ekey\u003c/em\u003e\u003c/code\u003e where *key* is the name of a label\n\nSome examples of using labels as filters:\n\n|Filter|Description|\n|------|-----------|\n|name:how*|The project's name starts with \"how\".|\n|name:Howl|The project's name is `Howl` or `howl`.|\n|name:HOWL|Equivalent to above.|\n|NAME:howl|Equivalent to above.|\n|labels.color:*|The project has the label `color`.|\n|labels.color:red|The project's label `color` has the value `red`.|\n|labels.color:red labels.size:big|The project's label `color` has the value `red` and its label `size` has the value `big`.\n\nIf you specify a filter that has both `parent.type` and `parent.id`, then\nthe `resourcemanager.projects.list` permission is checked on the parent.\nIf the user has this permission, all projects under the parent will be\nreturned after remaining filters have been applied. If the user lacks this\npermission, then all projects for which the user has the\n`resourcemanager.projects.get` permission will be returned after remaining\nfilters have been applied. If no filter is specified, the call will return\nprojects for which the user has `resourcemanager.projects.get` permissions.\n\nOptional.", - "type": "string", - "location": "query" - }, "pageToken": { "location": "query", - "description": "A pagination token returned from a previous call to ListProjects\nthat indicates from where listing should continue.\n\nOptional.", + "description": "A pagination token returned from a previous call to `ListOrganizations`\nthat indicates from where listing should continue.\nThis field is optional.", "type": "string" }, "pageSize": { + "type": "integer", "location": "query", - "description": "The maximum number of Projects to return in the response.\nThe server can return fewer Projects than requested.\nIf unspecified, server picks an appropriate default.\n\nOptional.", - "format": "int32", - "type": "integer" + "description": "The maximum number of Organizations to return in the response.\nThis field is optional.", + "format": "int32" + }, + "filter": { + "location": "query", + "description": "An optional query string used to filter the Organizations to return in\nthe response. Filter rules are case-insensitive.\n\n\nOrganizations may be filtered by `owner.directoryCustomerId` or by\n`domain`, where the domain is a Google for Work domain, for example:\n\n|Filter|Description|\n|------|-----------|\n|owner.directorycustomerid:123456789|Organizations with `owner.directory_customer_id` equal to `123456789`.|\n|domain:google.com|Organizations corresponding to the domain `google.com`.|\n\nThis field is optional.", + "type": "string" } }, - "flatPath": "v1beta1/projects", - "path": "v1beta1/projects", - "id": "cloudresourcemanager.projects.list" - }, - "create": { - "request": { - "$ref": "Project" - }, - "description": "Creates a Project resource.\n\nInitially, the Project resource is owned by its creator exclusively.\nThe creator can later grant permission to others to read or update the\nProject.\n\nSeveral APIs are activated automatically for the Project, including\nGoogle Cloud Storage.", - "response": { - "$ref": "Project" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": { - "useLegacyStack": { - "description": "A safety hatch to opt out of the new reliable project creation process.", - "type": "boolean", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects", - "path": "v1beta1/projects", - "id": "cloudresourcemanager.projects.create" + "flatPath": "v1beta1/organizations", + "path": "v1beta1/organizations", + "id": "cloudresourcemanager.organizations.list" }, "setIamPolicy": { - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the IAM access control policy for the specified Project. Overwrites\nany existing policy.\n\nThe following constraints apply when using `setIamPolicy()`:\n\n+ Project does not support `allUsers` and `allAuthenticatedUsers` as\n`members` in a `Binding` of a `Policy`.\n\n+ The owner role can be granted only to `user` and `serviceAccount`.\n\n+ Service accounts can be made owners of a project directly\nwithout any restrictions. However, to be added as an owner, a user must be\ninvited via Cloud Platform console and must accept the invitation.\n\n+ A user cannot be granted the owner role using `setIamPolicy()`. The user\nmust be granted the owner role using the Cloud Platform Console and must\nexplicitly accept the invitation.\n\n+ Invitations to grant the owner role cannot be sent using\n`setIamPolicy()`; they must be sent only using the Cloud Platform Console.\n\n+ Membership changes that leave the project without any owners that have\naccepted the Terms of Service (ToS) will be rejected.\n\n+ If the project is not part of an organization, there must be at least\none owner who has accepted the Terms of Service (ToS) agreement in the\npolicy. Calling `setIamPolicy()` to remove the last ToS-accepted owner\nfrom the policy will fail. This restriction also applies to legacy\nprojects that no longer have owners who have accepted the ToS. Edits to\nIAM policies will be rejected until the lack of a ToS-accepting owner is\nrectified.\n\n+ This method will replace the existing policy, and cannot be used to\nappend additional IAM settings.\n\nNote: Removing service accounts from policies or changing their roles\ncan render services completely inoperable. It is important to understand\nhow the service account is being used before removing or updating its\nroles.", "httpMethod": "POST", "parameterOrder": [ "resource" @@ -910,41 +901,39 @@ "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", + "pattern": "^organizations/[^/]+$", "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1beta1/projects/{resource}:setIamPolicy", - "id": "cloudresourcemanager.projects.setIamPolicy", - "path": "v1beta1/projects/{resource}:setIamPolicy" + "flatPath": "v1beta1/organizations/{organizationsId}:setIamPolicy", + "id": "cloudresourcemanager.organizations.setIamPolicy", + "path": "v1beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on an Organization resource. Replaces any\nexisting policy. The `resource` field should be the organization's resource\nname, e.g. \"organizations/123\"." } } } }, "parameters": { - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" }, "fields": { - "description": "Selector specifying which fields to include in a partial response.", "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", + "description": "Selector specifying which fields to include in a partial response." + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "callback": { @@ -952,7 +941,21 @@ "description": "JSONP", "type": "string" }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, "alt": { + "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -965,13 +968,12 @@ "json", "media", "proto" - ], - "type": "string" + ] }, "key": { - "location": "query", "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.", - "type": "string" + "type": "string", + "location": "query" }, "access_token": { "description": "OAuth access token.", @@ -979,42 +981,40 @@ "location": "query" }, "quotaUser": { + "type": "string", "location": "query", - "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.", - "type": "string" + "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." }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" + "default": "true" }, "bearer_token": { - "description": "OAuth bearer token.", "type": "string", - "location": "query" + "location": "query", + "description": "OAuth bearer token." + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" } }, "version": "v1beta1", "baseUrl": "https://cloudresourcemanager.googleapis.com/", - "kind": "discovery#restDescription", - "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.", "servicePath": "", - "basePath": "" + "description": "The Google Cloud Resource Manager API provides methods for creating, reading, and updating project metadata.", + "kind": "discovery#restDescription", + "basePath": "", + "documentationLink": "https://cloud.google.com/resource-manager", + "revision": "20180103", + "id": "cloudresourcemanager:v1beta1", + "discoveryVersion": "v1" }
diff --git a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json index cd3e60a..8c6d9a6 100644 --- a/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json +++ b/cloudresourcemanager/v2beta1/cloudresourcemanager-api.json
@@ -1,199 +1,13 @@ { + "ownerDomain": "google.com", + "name": "cloudresourcemanager", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Cloud Resource Manager API", + "ownerName": "Google", "resources": { "folders": { "methods": { - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v2beta1/folders/{foldersId}:getIamPolicy", - "path": "v2beta1/{+resource}:getIamPolicy", - "id": "cloudresourcemanager.folders.getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder." - }, - "search": { - "response": { - "$ref": "SearchFoldersResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v2beta1/folders:search", - "path": "v2beta1/folders:search", - "id": "cloudresourcemanager.folders.search", - "request": { - "$ref": "SearchFoldersRequest" - }, - "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`." - }, - "patch": { - "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in the\nCreateFolder documentation.\n\nThe Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.", - "request": { - "$ref": "Folder" - }, - "response": { - "$ref": "Folder" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$", - "location": "path", - "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\"." - }, - "updateMask": { - "type": "string", - "location": "query", - "description": "Fields to be updated.\nOnly the `display_name` can be updated.", - "format": "google-fieldmask" - } - }, - "flatPath": "v2beta1/folders/{foldersId}", - "path": "v2beta1/{+name}", - "id": "cloudresourcemanager.folders.patch" - }, - "get": { - "response": { - "$ref": "Folder" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v2beta1/folders/{foldersId}", - "path": "v2beta1/{+name}", - "id": "cloudresourcemanager.folders.get", - "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder." - }, - "undelete": { - "response": { - "$ref": "Folder" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$", - "location": "path", - "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/folders/{foldersId}:undelete", - "path": "v2beta1/{+name}:undelete", - "id": "cloudresourcemanager.folders.undelete", - "request": { - "$ref": "UndeleteFolderRequest" - }, - "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder." - }, - "move": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "flatPath": "v2beta1/folders/{foldersId}:move", - "path": "v2beta1/{+name}:move", - "id": "cloudresourcemanager.folders.move", - "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent.", - "request": { - "$ref": "MoveFolderRequest" - } - }, - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.", - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions", - "path": "v2beta1/{+resource}:testIamPermissions", - "id": "cloudresourcemanager.folders.testIamPermissions" - }, "delete": { "response": { "$ref": "Folder" @@ -204,11 +18,11 @@ "httpMethod": "DELETE", "parameters": { "name": { - "required": true, - "type": "string", "pattern": "^folders/[^/]+$", "location": "path", - "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`." + "description": "the resource name of the Folder to be deleted.\nMust be of the form `folders/{folder_id}`.", + "required": true, + "type": "string" } }, "scopes": [ @@ -221,20 +35,16 @@ }, "list": { "description": "Lists the Folders that are direct descendants of supplied parent resource.\nList provides a strongly consistent view of the Folders underneath\nthe specified parent resource.\nList returns Folders sorted based upon the (ascending) lexical ordering\nof their display_name.\nThe caller must have `resourcemanager.folders.list` permission on the\nidentified parent.", - "httpMethod": "GET", - "parameterOrder": [], "response": { "$ref": "ListFoldersResponse" }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], + "parameterOrder": [], + "httpMethod": "GET", "parameters": { "parent": { - "location": "query", "description": "The resource name of the Organization or Folder whose Folders are\nbeing listed.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.\nAccess to this method is controlled by checking the\n`resourcemanager.folders.list` permission on the `parent`.", - "type": "string" + "type": "string", + "location": "query" }, "showDeleted": { "location": "query", @@ -253,11 +63,74 @@ "type": "integer" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "flatPath": "v2beta1/folders", - "id": "cloudresourcemanager.folders.list", - "path": "v2beta1/folders" + "path": "v2beta1/folders", + "id": "cloudresourcemanager.folders.list" + }, + "create": { + "request": { + "$ref": "Folder" + }, + "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": { + "parent": { + "type": "string", + "location": "query", + "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/folders", + "path": "v2beta1/folders", + "id": "cloudresourcemanager.folders.create" }, "setIamPolicy": { + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy", + "id": "cloudresourcemanager.folders.setIamPolicy", + "path": "v2beta1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder." + }, + "getIamPolicy": { + "flatPath": "v2beta1/folders/{foldersId}:getIamPolicy", + "path": "v2beta1/{+resource}:getIamPolicy", + "id": "cloudresourcemanager.folders.getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Gets the access control policy for a Folder. The returned policy may be\nempty if no such policy or resource exists. The `resource` field should\nbe the Folder's resource name, e.g. \"folders/1234\".\nThe caller must have `resourcemanager.folders.getIamPolicy` permission\non the identified folder.", "response": { "$ref": "Policy" }, @@ -265,123 +138,199 @@ "resource" ], "httpMethod": "POST", + "parameters": { + "resource": { + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ] + }, + "search": { + "path": "v2beta1/folders:search", + "id": "cloudresourcemanager.folders.search", + "description": "Search for folders that match specific filter criteria.\nSearch provides an eventually consistent view of the folders a user has\naccess to which meet the specified filter criteria.\n\nThis will only return folders on which the caller has the\npermission `resourcemanager.folders.get`.", + "request": { + "$ref": "SearchFoldersRequest" + }, + "response": { + "$ref": "SearchFoldersResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": {}, + "flatPath": "v2beta1/folders:search" + }, + "undelete": { + "path": "v2beta1/{+name}:undelete", + "id": "cloudresourcemanager.folders.undelete", + "description": "Cancels the deletion request for a Folder. This method may only be\ncalled on a Folder in the\nDELETE_REQUESTED state.\nIn order to succeed, the Folder's parent must be in the\nACTIVE state.\nIn addition, reintroducing the folder into the tree must not violate\nfolder naming, height and fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.undelete` permission on the\nidentified folder.", + "request": { + "$ref": "UndeleteFolderRequest" + }, + "response": { + "$ref": "Folder" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "The resource name of the Folder to undelete.\nMust be of the form `folders/{folder_id}`.", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$" + } + }, + "flatPath": "v2beta1/folders/{foldersId}:undelete" + }, + "get": { + "description": "Retrieves a Folder identified by the supplied resource name.\nValid Folder resource names have the format `folders/{folder_id}`\n(for example, `folders/1234`).\nThe caller must have `resourcemanager.folders.get` permission on the\nidentified folder.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Folder" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "The resource name of the Folder to retrieve.\nMust be of the form `folders/{folder_id}`." + } + }, + "flatPath": "v2beta1/folders/{foldersId}", + "id": "cloudresourcemanager.folders.get", + "path": "v2beta1/{+name}" + }, + "patch": { + "flatPath": "v2beta1/folders/{foldersId}", + "id": "cloudresourcemanager.folders.patch", + "path": "v2beta1/{+name}", + "description": "Updates a Folder, changing its display_name.\nChanges to the folder display_name will be rejected if they violate either\nthe display_name formatting rules or naming constraints described in the\nCreateFolder documentation.\n\nThe Folder's display name must start and end with a letter or digit,\nmay contain letters, digits, spaces, hyphens and underscores and can be\nno longer than 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.\nThe caller must have `resourcemanager.folders.update` permission on the\nidentified folder.\n\nIf the update fails due to the unique name constraint then a\nPreconditionFailure explaining this violation will be returned\nin the Status.details field.", + "request": { + "$ref": "Folder" + }, + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Folder" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "updateMask": { + "location": "query", + "description": "Fields to be updated.\nOnly the `display_name` can be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "location": "path", + "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$" + } + } + }, + "move": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "The resource name of the Folder to move.\nMust be of the form folders/{folder_id}" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/folders/{foldersId}:move", + "id": "cloudresourcemanager.folders.move", + "path": "v2beta1/{+name}:move", + "request": { + "$ref": "MoveFolderRequest" + }, + "description": "Moves a Folder under a new resource parent.\nReturns an Operation which can be used to track the progress of the\nfolder move workflow.\nUpon success the Operation.response field will be populated with the\nmoved Folder.\nUpon failure, a FolderOperationError categorizing the failure cause will\nbe returned - if the failure occurs synchronously then the\nFolderOperationError will be returned via the Status.details field\nand if it occurs asynchronously then the FolderOperation will be returned\nvia the the Operation.error field.\nIn addition, the Operation.metadata field will be populated with a\nFolderOperation message as an aid to stateless clients.\nFolder moves will be rejected if they violate either the naming, height\nor fanout constraints described in the\nCreateFolder documentation.\nThe caller must have `resourcemanager.folders.move` permission on the\nfolder's current and proposed new parent." + }, + "testIamPermissions": { + "id": "cloudresourcemanager.folders.testIamPermissions", + "path": "v2beta1/{+resource}:testIamPermissions", + "description": "Returns permissions that a caller has on the specified Folder.\nThe `resource` field should be the Folder's resource name,\ne.g. \"folders/1234\".\n\nThere are no permissions required for making this API call.", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "TestIamPermissionsResponse" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "resource": { "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^folders/[^/]+$" } }, - "flatPath": "v2beta1/folders/{foldersId}:setIamPolicy", - "path": "v2beta1/{+resource}:setIamPolicy", - "id": "cloudresourcemanager.folders.setIamPolicy", - "description": "Sets the access control policy on a Folder, replacing any existing policy.\nThe `resource` field should be the Folder's resource name, e.g.\n\"folders/1234\".\nThe caller must have `resourcemanager.folders.setIamPolicy` permission\non the identified folder.", - "request": { - "$ref": "SetIamPolicyRequest" - } - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "location": "query", - "description": "The resource name of the new Folder's parent.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.", - "type": "string" - } - }, - "flatPath": "v2beta1/folders", - "path": "v2beta1/folders", - "id": "cloudresourcemanager.folders.create", - "description": "Creates a Folder in the resource hierarchy.\nReturns an Operation which can be used to track the progress of the\nfolder creation workflow.\nUpon success the Operation.response field will be populated with the\ncreated Folder.\n\nIn order to succeed, the addition of this new Folder must not violate\nthe Folder naming, height or fanout constraints.\n\n+ The Folder's display_name must be distinct from all other Folder's that\nshare its parent.\n+ The addition of the Folder must not cause the active Folder hierarchy\nto exceed a height of 4. Note, the full active + deleted Folder hierarchy\nis allowed to reach a height of 8; this provides additional headroom when\nmoving folders that contain deleted folders.\n+ The addition of the Folder must not cause the total number of Folders\nunder its parent to exceed 100.\n\nIf the operation fails due to a folder constraint violation,\na PreconditionFailure explaining the violation will be returned.\nIf the failure occurs synchronously then the PreconditionFailure\nwill be returned via the Status.details field and if it occurs\nasynchronously then the PreconditionFailure will be returned\nvia the the Operation.error field.\n\nThe caller must have `resourcemanager.folders.create` permission on the\nidentified parent.", - "request": { - "$ref": "Folder" - } + "flatPath": "v2beta1/folders/{foldersId}:testIamPermissions" } } } }, "parameters": { - "alt": { + "fields": { + "description": "Selector specifying which fields to include in a partial response.", "type": "string", - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "key": { - "type": "string", - "location": "query", - "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." - }, - "quotaUser": { - "type": "string", - "location": "query", - "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." - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "type": "string", - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." - }, - "prettyPrint": { - "type": "boolean", - "default": "true", - "location": "query", - "description": "Returns response with indentations and line breaks." + "location": "query" }, "uploadType": { - "type": "string", "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, "$.xgafv": { + "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", @@ -391,13 +340,70 @@ "enum": [ "1", "2" - ], - "description": "V1 error format." + ] }, "callback": { "location": "query", "description": "JSONP", "type": "string" + }, + "alt": { + "location": "query", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ] + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "type": "string", + "location": "query", + "description": "OAuth bearer token." + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "type": "boolean", + "default": "true", + "location": "query", + "description": "Returns response with indentations and line breaks." } }, "version": "v2beta1", @@ -411,281 +417,38 @@ "id": "cloudresourcemanager:v2beta1", "discoveryVersion": "v1", "schemas": { - "MoveFolderRequest": { + "Policy": { + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", "type": "object", "properties": { - "destinationParent": { - "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.", - "type": "string" - } - }, - "id": "MoveFolderRequest", - "description": "The MoveFolder request message." - }, - "SearchFoldersResponse": { - "type": "object", - "properties": { - "folders": { + "auditConfigs": { "type": "array", "items": { - "$ref": "Folder" + "$ref": "AuditConfig" }, - "description": "A possibly paginated folder search results.\nthe specified parent resource." + "description": "Specifies cloud audit logging configuration for this policy." }, - "nextPageToken": { - "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.", - "type": "string" - } - }, - "id": "SearchFoldersResponse", - "description": "The response message for searching folders." - }, - "SetIamPolicyRequest": { - "type": "object", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." - }, - "updateMask": { - "type": "string", - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask" - } - }, - "id": "SetIamPolicyRequest", - "description": "Request message for `SetIamPolicy` method." - }, - "Status": { - "type": "object", - "properties": { - "details": { + "bindings": { "type": "array", "items": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - } + "$ref": "Binding" }, - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error." }, - "code": { - "type": "integer", - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" - }, - "message": { + "etag": { "type": "string", - "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." - } - }, - "id": "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." - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", - "properties": { - "members": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n" + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte" }, - "role": { - "type": "string", - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired" - } - }, - "id": "Binding" - }, - "SearchFoldersRequest": { - "type": "object", - "properties": { - "query": { - "type": "string", - "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is \"folders/123\".|" - }, - "pageToken": { - "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of folders to return in the response.\nThis field is optional.", + "version": { + "description": "Deprecated.", "format": "int32", "type": "integer" } }, - "id": "SearchFoldersRequest", - "description": "The request message for searching folders." - }, - "Folder": { - "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.", - "type": "object", - "properties": { - "lifecycleState": { - "type": "string", - "enumDescriptions": [ - "Unspecified state.", - "The normal and active state.", - "The folder has been marked for deletion by the user." - ], - "enum": [ - "LIFECYCLE_STATE_UNSPECIFIED", - "ACTIVE", - "DELETE_REQUESTED" - ], - "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder." - }, - "name": { - "type": "string", - "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\"." - }, - "displayName": { - "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.", - "type": "string" - }, - "parent": { - "type": "string", - "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder." - }, - "createTime": { - "type": "string", - "description": "Output only. Timestamp when the Folder was created. Assigned by the server.", - "format": "google-datetime" - } - }, - "id": "Folder" - }, - "ProjectCreationStatus": { - "type": "object", - "properties": { - "ready": { - "type": "boolean", - "description": "True if the project creation process is complete." - }, - "createTime": { - "type": "string", - "description": "Creation time of the project creation workflow.", - "format": "google-datetime" - }, - "gettable": { - "type": "boolean", - "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete." - } - }, - "id": "ProjectCreationStatus", - "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed." - }, - "GetIamPolicyRequest": { - "type": "object", - "properties": {}, - "id": "GetIamPolicyRequest", - "description": "Request message for `GetIamPolicy` method." - }, - "TestIamPermissionsResponse": { - "type": "object", - "properties": { - "permissions": { - "type": "array", - "items": { - "type": "string" - }, - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed." - } - }, - "id": "TestIamPermissionsResponse", - "description": "Response message for `TestIamPermissions` method." - }, - "UndeleteFolderRequest": { - "type": "object", - "properties": {}, - "id": "UndeleteFolderRequest", - "description": "The UndeleteFolder request message." - }, - "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", - "type": "object", - "properties": { - "logType": { - "type": "string", - "enumDescriptions": [ - "Default case. Should never be this.", - "Admin reads. Example: CloudIAM getIamPolicy", - "Data writes. Example: CloudSQL Users create", - "Data reads. Example: CloudSQL Users list" - ], - "enum": [ - "LOG_TYPE_UNSPECIFIED", - "ADMIN_READ", - "DATA_WRITE", - "DATA_READ" - ], - "description": "The log type that this config enables." - }, - "exemptedMembers": { - "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "AuditLogConfig" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" - }, - "FolderOperationError": { - "type": "object", - "properties": { - "errorMessageId": { - "enum": [ - "ERROR_TYPE_UNSPECIFIED", - "ACTIVE_FOLDER_HEIGHT_VIOLATION", - "MAX_CHILD_FOLDERS_VIOLATION", - "FOLDER_NAME_UNIQUENESS_VIOLATION", - "RESOURCE_DELETED_VIOLATION", - "PARENT_DELETED_VIOLATION", - "CYCLE_INTRODUCED_VIOLATION", - "FOLDER_BEING_MOVED_VIOLATION", - "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION", - "DELETED_FOLDER_HEIGHT_VIOLATION" - ], - "description": "The type of operation error experienced.", - "type": "string", - "enumDescriptions": [ - "The error type was unrecognized or unspecified.", - "The attempted action would violate the max folder depth constraint.", - "The attempted action would violate the max child folders constraint.", - "The attempted action would violate the locally-unique folder\ndisplay_name constraint.", - "The resource being moved has been deleted.", - "The resource a folder was being added to has been deleted.", - "The attempted action would introduce cycle in resource path.", - "The attempted action would move a folder that is already being moved.", - "The folder the caller is trying to delete contains active resources.", - "The attempted action would violate the max deleted folder depth\nconstraint." - ] - } - }, - "id": "FolderOperationError", - "description": "A classification of the Folder Operation error." + "id": "Policy" }, "FolderOperation": { - "description": "Metadata describing a long running folder operation", "type": "object", "properties": { "operationType": { @@ -703,61 +466,67 @@ "description": "The type of this operation." }, "displayName": { - "description": "The display name of the folder.", - "type": "string" + "type": "string", + "description": "The display name of the folder." }, "sourceParent": { - "type": "string", - "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE." + "description": "The resource name of the folder's parent.\nOnly applicable when the operation_type is MOVE.", + "type": "string" }, "destinationParent": { "description": "The resource name of the folder or organization we are either creating\nthe folder under or moving the folder to.", "type": "string" } }, - "id": "FolderOperation" + "id": "FolderOperation", + "description": "Metadata describing a long running folder operation" }, - "Policy": { - "type": "object", + "FolderOperationError": { "properties": { - "etag": { + "errorMessageId": { "type": "string", - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte" - }, - "version": { - "type": "integer", - "description": "Deprecated.", - "format": "int32" - }, - "auditConfigs": { - "type": "array", - "items": { - "$ref": "AuditConfig" - }, - "description": "Specifies cloud audit logging configuration for this policy." - }, - "bindings": { - "type": "array", - "items": { - "$ref": "Binding" - }, - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error." + "enumDescriptions": [ + "The error type was unrecognized or unspecified.", + "The attempted action would violate the max folder depth constraint.", + "The attempted action would violate the max child folders constraint.", + "The attempted action would violate the locally-unique folder\ndisplay_name constraint.", + "The resource being moved has been deleted.", + "The resource a folder was being added to has been deleted.", + "The attempted action would introduce cycle in resource path.", + "The attempted action would move a folder that is already being moved.", + "The folder the caller is trying to delete contains active resources.", + "The attempted action would violate the max deleted folder depth\nconstraint." + ], + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "ACTIVE_FOLDER_HEIGHT_VIOLATION", + "MAX_CHILD_FOLDERS_VIOLATION", + "FOLDER_NAME_UNIQUENESS_VIOLATION", + "RESOURCE_DELETED_VIOLATION", + "PARENT_DELETED_VIOLATION", + "CYCLE_INTRODUCED_VIOLATION", + "FOLDER_BEING_MOVED_VIOLATION", + "FOLDER_TO_DELETE_NON_EMPTY_VIOLATION", + "DELETED_FOLDER_HEIGHT_VIOLATION" + ], + "description": "The type of operation error experienced." } }, - "id": "Policy", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs)." + "id": "FolderOperationError", + "description": "A classification of the Folder Operation error.", + "type": "object" }, "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "properties": { "response": { + "type": "object", "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." + "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" + "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`." }, "name": { "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", @@ -768,38 +537,37 @@ "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { + "type": "object", "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any." }, "done": { - "type": "boolean", - "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." + "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" } }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." + "id": "Operation" }, "AuditConfig": { - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", "type": "object", "properties": { - "service": { - "type": "string", - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services." - }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.\nNext ID: 4", "type": "array", "items": { "$ref": "AuditLogConfig" } + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" } }, - "id": "AuditConfig" + "id": "AuditConfig", + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging." }, "ListFoldersResponse": { "description": "The ListFolders response message.", @@ -813,18 +581,256 @@ } }, "nextPageToken": { - "type": "string", - "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional." + "description": "A pagination token returned from a previous call to `ListFolders`\nthat indicates from where listing should continue.\nThis field is optional.", + "type": "string" } }, "id": "ListFoldersResponse" + }, + "MoveFolderRequest": { + "description": "The MoveFolder request message.", + "type": "object", + "properties": { + "destinationParent": { + "description": "The resource name of the Folder or Organization to reparent\nthe folder under.\nMust be of the form `folders/{folder_id}` or `organizations/{org_id}`.", + "type": "string" + } + }, + "id": "MoveFolderRequest" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "format": "google-fieldmask", + "type": "string" + }, + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest" + }, + "SearchFoldersResponse": { + "description": "The response message for searching folders.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where searching should continue.\nThis field is optional.", + "type": "string" + }, + "folders": { + "description": "A possibly paginated folder search results.\nthe specified parent resource.", + "type": "array", + "items": { + "$ref": "Folder" + } + } + }, + "id": "SearchFoldersResponse" + }, + "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.", + "type": "object", + "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" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + } + }, + "id": "Status" + }, + "Binding": { + "type": "object", + "properties": { + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "Binding", + "description": "Associates `members` with a `role`." + }, + "SearchFoldersRequest": { + "description": "The request message for searching folders.", + "type": "object", + "properties": { + "pageToken": { + "description": "A pagination token returned from a previous call to `SearchFolders`\nthat indicates from where search should continue.\nThis field is optional.", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of folders to return in the response.\nThis field is optional.", + "format": "int32", + "type": "integer" + }, + "query": { + "type": "string", + "description": "Search criteria used to select the Folders to return.\nIf no search criteria is specified then all accessible folders will be\nreturned.\n\nQuery expressions can be used to restrict results based upon displayName,\nlifecycleState and parent, where the operators `=`, `NOT`, `AND` and `OR`\ncan be used along with the suffix wildcard symbol `*`.\n\nSome example queries are:\n\n|Query | Description|\n|----- | -----------|\n|displayName=Test*|Folders whose display name starts with \"Test\".|\n|lifecycleState=ACTIVE|Folders whose lifecycleState is ACTIVE.|\n|parent=folders/123|Folders whose parent is \"folders/123\".|\n|parent=folders/123 AND lifecycleState=ACTIVE|Active folders whose parent is \"folders/123\".|" + } + }, + "id": "SearchFoldersRequest" + }, + "ProjectCreationStatus": { + "description": "A status object which is used as the `metadata` field for the Operation\nreturned by CreateProject. It provides insight for when significant phases of\nProject creation have completed.", + "type": "object", + "properties": { + "createTime": { + "description": "Creation time of the project creation workflow.", + "format": "google-datetime", + "type": "string" + }, + "gettable": { + "description": "True if the project can be retrieved using GetProject. No other operations\non the project are guaranteed to work until the project creation is\ncomplete.", + "type": "boolean" + }, + "ready": { + "description": "True if the project creation process is complete.", + "type": "boolean" + } + }, + "id": "ProjectCreationStatus" + }, + "Folder": { + "description": "A Folder in an Organization's resource hierarchy, used to\norganize that Organization's resources.", + "type": "object", + "properties": { + "parent": { + "description": "The Folder’s parent's resource name.\nUpdates to the folder's parent must be performed via\nMoveFolder.", + "type": "string" + }, + "createTime": { + "description": "Output only. Timestamp when the Folder was created. Assigned by the server.", + "format": "google-datetime", + "type": "string" + }, + "lifecycleState": { + "enumDescriptions": [ + "Unspecified state.", + "The normal and active state.", + "The folder has been marked for deletion by the user." + ], + "enum": [ + "LIFECYCLE_STATE_UNSPECIFIED", + "ACTIVE", + "DELETE_REQUESTED" + ], + "description": "Output only. The lifecycle state of the folder.\nUpdates to the lifecycle_state must be performed via\nDeleteFolder and\nUndeleteFolder.", + "type": "string" + }, + "name": { + "description": "Output only. The resource name of the Folder.\nIts format is `folders/{folder_id}`, for example: \"folders/1234\".", + "type": "string" + }, + "displayName": { + "description": "The folder’s display name.\nA folder’s display name must be unique amongst its siblings, e.g.\nno two folders with the same parent can share the same display name.\nThe display name must start and end with a letter or digit, may contain\nletters, digits, spaces, hyphens and underscores and can be no longer\nthan 30 characters. This is captured by the regular expression:\n[\\p{L}\\p{N}]({\\p{L}\\p{N}_- ]{0,28}[\\p{L}\\p{N}])?.", + "type": "string" + } + }, + "id": "Folder" + }, + "GetIamPolicyRequest": { + "type": "object", + "properties": {}, + "id": "GetIamPolicyRequest", + "description": "Request message for `GetIamPolicy` method." + }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsResponse" + }, + "UndeleteFolderRequest": { + "id": "UndeleteFolderRequest", + "description": "The UndeleteFolder request message.", + "type": "object", + "properties": {} + }, + "AuditLogConfig": { + "type": "object", + "properties": { + "exemptedMembers": { + "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", + "type": "array", + "items": { + "type": "string" + } + }, + "logType": { + "type": "string", + "enumDescriptions": [ + "Default case. Should never be this.", + "Admin reads. Example: CloudIAM getIamPolicy", + "Data writes. Example: CloudSQL Users create", + "Data reads. Example: CloudSQL Users list" + ], + "enum": [ + "LOG_TYPE_UNSPECIFIED", + "ADMIN_READ", + "DATA_WRITE", + "DATA_READ" + ], + "description": "The log type that this config enables." + } + }, + "id": "AuditLogConfig", + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging." + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest" } }, + "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", "canonicalName": "Cloud Resource Manager", "auth": { "oauth2": { @@ -838,11 +844,5 @@ } } }, - "rootUrl": "https://cloudresourcemanager.googleapis.com/", - "ownerDomain": "google.com", - "name": "cloudresourcemanager", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Resource Manager API", - "ownerName": "Google" + "rootUrl": "https://cloudresourcemanager.googleapis.com/" }
diff --git a/cloudshell/v1/cloudshell-api.json b/cloudshell/v1/cloudshell-api.json index c71cf65..7adb8db 100644 --- a/cloudshell/v1/cloudshell-api.json +++ b/cloudshell/v1/cloudshell-api.json
@@ -1,242 +1,148 @@ { - "ownerDomain": "google.com", - "name": "cloudshell", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Cloud Shell API", - "ownerName": "Google", - "resources": { - "operations": { - "methods": { - "cancel": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^operations/.+$", - "location": "path" - } - }, - "flatPath": "v1/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "cloudshell.operations.cancel", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "request": { - "$ref": "CancelOperationRequest" - } - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "pattern": "^operations/.+$", - "location": "path", - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations/{operationsId}", - "path": "v1/{+name}", - "id": "cloudshell.operations.delete", - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`." - }, - "list": { - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - }, - "name": { - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^operations$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations", - "path": "v1/{+name}", - "id": "cloudshell.operations.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." - }, - "get": { - "flatPath": "v1/operations/{operationsId}", - "path": "v1/{+name}", - "id": "cloudshell.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.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^operations/.+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - }, - "parameters": { - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "type": "string", - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "type": "string", - "location": "query", - "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." - } - }, - "version": "v1", - "baseUrl": "https://cloudshell.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", - "servicePath": "", - "basePath": "", "id": "cloudshell:v1", "documentationLink": "https://cloud.google.com/shell/docs/", - "revision": "20180102", + "revision": "20180108", "discoveryVersion": "v1", "version_module": true, "schemas": { + "StartEnvironmentMetadata": { + "description": "Message included in the metadata field of operations returned from\nStartEnvironment.", + "type": "object", + "properties": { + "state": { + "enumDescriptions": [ + "The environment's start state is unknown.", + "The environment is in the process of being started, but no additional\ndetails are available.", + "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.", + "Startup is complete and the user should be able to establish an SSH\nconnection to their environment." + ], + "enum": [ + "STATE_UNSPECIFIED", + "STARTING", + "UNARCHIVING_DISK", + "FINISHED" + ], + "description": "Current state of the environment being started.", + "type": "string" + } + }, + "id": "StartEnvironmentMetadata" + }, + "Operation": { + "properties": { + "response": { + "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", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "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" + } + }, + "id": "Operation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + }, + "id": "ListOperationsResponse" + }, + "Environment": { + "properties": { + "sshUsername": { + "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.", + "type": "string" + }, + "publicKeys": { + "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.", + "type": "array", + "items": { + "$ref": "PublicKey" + } + }, + "dockerImage": { + "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".", + "type": "string" + }, + "state": { + "description": "Output only. Current execution state of this environment.", + "type": "string", + "enumDescriptions": [ + "The environment's states is unknown.", + "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", + "The environment is being started but is not yet ready to accept\nconnections.", + "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." + ], + "enum": [ + "STATE_UNSPECIFIED", + "DISABLED", + "STARTING", + "RUNNING" + ] + }, + "name": { + "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.", + "type": "string" + }, + "sshHost": { + "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", + "type": "string" + }, + "sshPort": { + "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "Output only. The environment's identifier, which is always \"default\".", + "type": "string" + } + }, + "id": "Environment", + "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".", + "type": "object" + }, "StartEnvironmentResponse": { "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.", "type": "object", "properties": { "environment": { - "description": "Environment that was started.", - "$ref": "Environment" + "$ref": "Environment", + "description": "Environment that was started." } }, "id": "StartEnvironmentResponse" @@ -246,15 +152,15 @@ "type": "object", "properties": { "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } - }, - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." + }, + "type": "object" + } }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", @@ -305,153 +211,22 @@ "id": "PublicKey" }, "Empty": { + "properties": {}, + "id": "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "type": "object", - "properties": {}, - "id": "CancelOperationRequest" - }, - "StartEnvironmentMetadata": { - "description": "Message included in the metadata field of operations returned from\nStartEnvironment.", - "type": "object", - "properties": { - "state": { - "type": "string", - "enumDescriptions": [ - "The environment's start state is unknown.", - "The environment is in the process of being started, but no additional\ndetails are available.", - "Startup is waiting for the user's disk to be unarchived. This can happen\nwhen the user returns to Cloud Shell after not having used it for a\nwhile, and suggests that startup will take longer than normal.", - "Startup is complete and the user should be able to establish an SSH\nconnection to their environment." - ], - "enum": [ - "STATE_UNSPECIFIED", - "STARTING", - "UNARCHIVING_DISK", - "FINISHED" - ], - "description": "Current state of the environment being started." - } - }, - "id": "StartEnvironmentMetadata" - }, - "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": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object" }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "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.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "id": "ListOperationsResponse" - }, - "Environment": { - "id": "Environment", - "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".", - "type": "object", - "properties": { - "publicKeys": { - "description": "Output only. Public keys associated with the environment. Clients can\nconnect to this environment via SSH only if they possess a private key\ncorresponding to at least one of these public keys. Keys can be added to or\nremoved from the environment using the CreatePublicKey and DeletePublicKey\nmethods.", - "type": "array", - "items": { - "$ref": "PublicKey" - } - }, - "dockerImage": { - "description": "Required. Full path to the Docker image used to run this environment, e.g.\n\"gcr.io/dev-con/cloud-devshell:latest\".", - "type": "string" - }, - "state": { - "description": "Output only. Current execution state of this environment.", - "type": "string", - "enumDescriptions": [ - "The environment's states is unknown.", - "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", - "The environment is being started but is not yet ready to accept\nconnections.", - "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." - ], - "enum": [ - "STATE_UNSPECIFIED", - "DISABLED", - "STARTING", - "RUNNING" - ] - }, - "name": { - "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.", - "type": "string" - }, - "sshHost": { - "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", - "type": "string" - }, - "sshPort": { - "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.", - "format": "int32", - "type": "integer" - }, - "id": { - "description": "Output only. The environment's identifier, which is always \"default\".", - "type": "string" - }, - "sshUsername": { - "description": "Output only. Username that clients should use when initiating SSH sessions\nwith the environment.", - "type": "string" - } - } + "CancelOperationRequest": { + "properties": {}, + "id": "CancelOperationRequest", + "description": "The request message for Operations.CancelOperation.", + "type": "object" } }, "protocol": "rest", "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "canonicalName": "Cloud Shell", "auth": { @@ -463,5 +238,230 @@ } } }, - "rootUrl": "https://cloudshell.googleapis.com/" + "rootUrl": "https://cloudshell.googleapis.com/", + "ownerDomain": "google.com", + "name": "cloudshell", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Cloud Shell API", + "ownerName": "Google", + "resources": { + "operations": { + "methods": { + "cancel": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^operations/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations/{operationsId}:cancel", + "id": "cloudshell.operations.cancel", + "path": "v1/{+name}:cancel", + "request": { + "$ref": "CancelOperationRequest" + }, + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." + }, + "delete": { + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "cloudshell.operations.delete", + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string", + "pattern": "^operations/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "id": "cloudshell.operations.list", + "path": "v1/{+name}", + "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", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "ListOperationsResponse" + }, + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^operations$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations" + }, + "get": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^operations/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "cloudshell.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." + } + } + } + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + } + }, + "version": "v1", + "baseUrl": "https://cloudshell.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", + "servicePath": "", + "basePath": "" }
diff --git a/cloudshell/v1alpha1/cloudshell-api.json b/cloudshell/v1alpha1/cloudshell-api.json index a4c5a9f..392a84f 100644 --- a/cloudshell/v1alpha1/cloudshell-api.json +++ b/cloudshell/v1alpha1/cloudshell-api.json
@@ -1,14 +1,93 @@ { - "servicePath": "", - "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", - "kind": "discovery#restDescription", - "basePath": "", - "revision": "20180102", - "documentationLink": "https://cloud.google.com/shell/docs/", - "id": "cloudshell:v1alpha1", "discoveryVersion": "v1", "version_module": true, "schemas": { + "StartEnvironmentResponse": { + "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.", + "type": "object", + "properties": { + "environment": { + "description": "Environment that was started.", + "$ref": "Environment" + } + }, + "id": "StartEnvironmentResponse" + }, + "Status": { + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "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" + } + }, + "id": "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.", + "type": "object" + }, + "StartEnvironmentRequest": { + "description": "Request message for StartEnvironment.", + "type": "object", + "properties": {}, + "id": "StartEnvironmentRequest" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "PublicKey": { + "description": "A public SSH key, corresponding to a private SSH key held by the client.", + "type": "object", + "properties": { + "name": { + "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.", + "type": "string" + }, + "key": { + "description": "Required. Content of this key.", + "format": "byte", + "type": "string" + }, + "format": { + "description": "Required. Format of this key's content.", + "type": "string", + "enumDescriptions": [ + "Unknown format. Do not use.", + "`ssh-dss` key format (see RFC4253).", + "`ssh-rsa` key format (see RFC4253).", + "`ecdsa-sha2-nistp256` key format (see RFC5656).", + "`ecdsa-sha2-nistp384` key format (see RFC5656).", + "`ecdsa-sha2-nistp521` key format (see RFC5656)." + ], + "enum": [ + "FORMAT_UNSPECIFIED", + "SSH_DSS", + "SSH_RSA", + "ECDSA_SHA2_NISTP256", + "ECDSA_SHA2_NISTP384", + "ECDSA_SHA2_NISTP521" + ] + } + }, + "id": "PublicKey" + }, "StartEnvironmentMetadata": { "description": "Message included in the metadata field of operations returned from\nStartEnvironment.", "type": "object", @@ -33,24 +112,10 @@ "id": "StartEnvironmentMetadata" }, "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", "properties": { - "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - }, "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" }, "metadata": { "additionalProperties": { @@ -63,18 +128,28 @@ "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" } }, - "id": "Operation" + "id": "Operation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object" }, "Environment": { "description": "A Cloud Shell environment, which is defined as the combination of a Docker\nimage specifying what is installed on the environment and a home directory\ncontaining the user's data that will remain across sessions. Each user has a\nsingle environment with the ID \"default\".", "type": "object", "properties": { - "sshHost": { - "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", - "type": "string" - }, "sshPort": { "description": "Output only. Port to which clients can connect to initiate SSH sessions\nwith the environment.", "format": "int32", @@ -100,6 +175,12 @@ "type": "string" }, "state": { + "enumDescriptions": [ + "The environment's states is unknown.", + "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", + "The environment is being started but is not yet ready to accept\nconnections.", + "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." + ], "enum": [ "STATE_UNSPECIFIED", "DISABLED", @@ -107,117 +188,29 @@ "RUNNING" ], "description": "Output only. Current execution state of this environment.", - "type": "string", - "enumDescriptions": [ - "The environment's states is unknown.", - "The environment is not running and can't be connected to. Starting the\nenvironment will transition it to the STARTING state.", - "The environment is being started but is not yet ready to accept\nconnections.", - "The environment is running and ready to accept connections. It will\nautomatically transition back to DISABLED after a period of inactivity or\nif another environment is started." - ] + "type": "string" }, "name": { "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}`. `{owner_email}` is the\nemail address of the user to whom this environment belongs, and\n`{environment_id}` is the identifier of this environment. For example,\n`users/someone@example.com/environments/default`.", "type": "string" + }, + "sshHost": { + "description": "Output only. Host to which clients can connect to initiate SSH sessions\nwith the environment.", + "type": "string" } }, "id": "Environment" }, "CreatePublicKeyRequest": { - "description": "Request message for CreatePublicKey.", - "type": "object", "properties": { "key": { "$ref": "PublicKey", "description": "Key that should be added to the environment." } }, - "id": "CreatePublicKeyRequest" - }, - "StartEnvironmentResponse": { - "description": "Message included in the response field of operations returned from\nStartEnvironment once the\noperation is complete.", - "type": "object", - "properties": { - "environment": { - "$ref": "Environment", - "description": "Environment that was started." - } - }, - "id": "StartEnvironmentResponse" - }, - "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.", - "type": "object", - "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 is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - } - }, - "id": "Status" - }, - "StartEnvironmentRequest": { - "description": "Request message for StartEnvironment.", - "type": "object", - "properties": {}, - "id": "StartEnvironmentRequest" - }, - "PublicKey": { - "properties": { - "name": { - "description": "Output only. Full name of this resource, in the format\n`users/{owner_email}/environments/{environment_id}/publicKeys/{key_id}`.\n`{owner_email}` is the email address of the user to whom the key belongs.\n`{environment_id}` is the identifier of the environment to which the key\ngrants access. `{key_id}` is the unique identifier of the key. For example,\n`users/someone@example.com/environments/default/publicKeys/myKey`.", - "type": "string" - }, - "key": { - "description": "Required. Content of this key.", - "format": "byte", - "type": "string" - }, - "format": { - "enumDescriptions": [ - "Unknown format. Do not use.", - "`ssh-dss` key format (see RFC4253).", - "`ssh-rsa` key format (see RFC4253).", - "`ecdsa-sha2-nistp256` key format (see RFC5656).", - "`ecdsa-sha2-nistp384` key format (see RFC5656).", - "`ecdsa-sha2-nistp521` key format (see RFC5656)." - ], - "enum": [ - "FORMAT_UNSPECIFIED", - "SSH_DSS", - "SSH_RSA", - "ECDSA_SHA2_NISTP256", - "ECDSA_SHA2_NISTP384", - "ECDSA_SHA2_NISTP521" - ], - "description": "Required. Format of this key's content.", - "type": "string" - } - }, - "id": "PublicKey", - "description": "A public SSH key, corresponding to a private SSH key held by the client.", + "id": "CreatePublicKeyRequest", + "description": "Request message for CreatePublicKey.", "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" } }, "protocol": "rest", @@ -247,43 +240,15 @@ "resources": { "environments": { "methods": { - "start": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "Name of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+/environments/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start", - "path": "v1alpha1/{+name}:start", - "id": "cloudshell.users.environments.start", - "request": { - "$ref": "StartEnvironmentRequest" - }, - "description": "Starts an existing environment, allowing clients to connect to it. The\nreturned operation will contain an instance of StartEnvironmentMetadata in\nits metadata field. Users can wait for the environment to start by polling\nthis operation via GetOperation. Once the environment has finished starting\nand is ready to accept connections, the operation will contain a\nStartEnvironmentResponse in its response field." - }, "get": { "description": "Gets an environment. Returns NOT_FOUND if the environment does not exist.", + "httpMethod": "GET", "response": { "$ref": "Environment" }, "parameterOrder": [ "name" ], - "httpMethod": "GET", "parameters": { "name": { "description": "Name of the requested resource, for example `users/me/environments/default`\nor `users/someone@example.com/environments/default`.", @@ -297,48 +262,108 @@ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}", - "path": "v1alpha1/{+name}", - "id": "cloudshell.users.environments.get" + "id": "cloudshell.users.environments.get", + "path": "v1alpha1/{+name}" }, "patch": { - "description": "Updates an existing environment.", - "request": { - "$ref": "Environment" - }, - "response": { - "$ref": "Environment" - }, + "httpMethod": "PATCH", "parameterOrder": [ "name" ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], + "response": { + "$ref": "Environment" + }, "parameters": { + "updateMask": { + "location": "query", + "description": "Mask specifying which fields in the environment should be updated.", + "format": "google-fieldmask", + "type": "string" + }, "name": { "description": "Name of the resource to be updated, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.", "required": true, "type": "string", "pattern": "^users/[^/]+/environments/[^/]+$", "location": "path" - }, - "updateMask": { - "location": "query", - "description": "Mask specifying which fields in the environment should be updated.", - "format": "google-fieldmask", - "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}", + "id": "cloudshell.users.environments.patch", "path": "v1alpha1/{+name}", - "id": "cloudshell.users.environments.patch" + "request": { + "$ref": "Environment" + }, + "description": "Updates an existing environment." + }, + "start": { + "request": { + "$ref": "StartEnvironmentRequest" + }, + "description": "Starts an existing environment, allowing clients to connect to it. The\nreturned operation will contain an instance of StartEnvironmentMetadata in\nits metadata field. Users can wait for the environment to start by polling\nthis operation via GetOperation. Once the environment has finished starting\nand is ready to accept connections, the operation will contain a\nStartEnvironmentResponse in its response field.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "Name of the resource that should be started, for example\n`users/me/environments/default` or\n`users/someone@example.com/environments/default`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/environments/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}:start", + "path": "v1alpha1/{+name}:start", + "id": "cloudshell.users.environments.start" } }, "resources": { "publicKeys": { "methods": { + "delete": { + "description": "Removes a public SSH key from an environment. Clients will no longer be\nable to connect to the environment using the corresponding private key.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$" + } + }, + "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}", + "path": "v1alpha1/{+name}", + "id": "cloudshell.users.environments.publicKeys.delete" + }, "create": { + "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys", + "path": "v1alpha1/{+parent}/publicKeys", + "id": "cloudshell.users.environments.publicKeys.create", + "description": "Adds a public SSH key to an environment, allowing clients with the\ncorresponding private key to connect to that environment via SSH. If a key\nwith the same format and content already exists, this will return the\nexisting key.", + "request": { + "$ref": "CreatePublicKeyRequest" + }, "response": { "$ref": "PublicKey" }, @@ -351,45 +376,13 @@ ], "parameters": { "parent": { - "pattern": "^users/[^/]+/environments/[^/]+$", - "location": "path", "description": "Parent resource name, e.g. `users/me/environments/default`.", "required": true, - "type": "string" - } - }, - "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys", - "path": "v1alpha1/{+parent}/publicKeys", - "id": "cloudshell.users.environments.publicKeys.create", - "description": "Adds a public SSH key to an environment, allowing clients with the\ncorresponding private key to connect to that environment via SSH. If a key\nwith the same format and content already exists, this will return the\nexisting key.", - "request": { - "$ref": "CreatePublicKeyRequest" - } - }, - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "location": "path", - "description": "Name of the resource to be deleted, e.g.\n`users/me/environments/default/publicKeys/my-key`.", - "required": true, "type": "string", - "pattern": "^users/[^/]+/environments/[^/]+/publicKeys/[^/]+$" + "pattern": "^users/[^/]+/environments/[^/]+$", + "location": "path" } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1alpha1/users/{usersId}/environments/{environmentsId}/publicKeys/{publicKeysId}", - "id": "cloudshell.users.environments.publicKeys.delete", - "path": "v1alpha1/{+name}", - "description": "Removes a public SSH key from an environment. Clients will no longer be\nable to connect to the environment using the corresponding private key." + } } } } @@ -399,49 +392,51 @@ } }, "parameters": { + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, "pp": { "description": "Pretty-print response.", "type": "boolean", "default": "true", "location": "query" }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { - "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "$.xgafv": { + "description": "V1 error format.", + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -450,9 +445,12 @@ "enum": [ "1", "2" - ], - "description": "V1 error format.", - "type": "string" + ] + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "alt": { "enum": [ @@ -470,22 +468,24 @@ "description": "Data format for response.", "default": "json" }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, "key": { "location": "query", "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.", "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.", - "type": "string", - "location": "query" + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" } }, "version": "v1alpha1", - "baseUrl": "https://cloudshell.googleapis.com/" + "baseUrl": "https://cloudshell.googleapis.com/", + "servicePath": "", + "description": "Allows users to start, configure, and connect to interactive shell sessions running in the cloud.\n", + "kind": "discovery#restDescription", + "basePath": "", + "revision": "20180108", + "documentationLink": "https://cloud.google.com/shell/docs/", + "id": "cloudshell:v1alpha1" }
diff --git a/cloudtasks/v2beta2/cloudtasks-api.json b/cloudtasks/v2beta2/cloudtasks-api.json index 67f0a30..0e70623 100644 --- a/cloudtasks/v2beta2/cloudtasks-api.json +++ b/cloudtasks/v2beta2/cloudtasks-api.json
@@ -22,7 +22,6 @@ "locations": { "methods": { "list": { - "description": "Lists information about the supported locations for this service.", "response": { "$ref": "ListLocationsResponse" }, @@ -31,27 +30,27 @@ ], "httpMethod": "GET", "parameters": { - "name": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The resource that owns the locations collection, if applicable.", - "required": true, + "filter": { + "location": "query", + "description": "The standard list filter.", "type": "string" }, - "pageToken": { - "description": "The standard list page token.", + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "required": true, "type": "string", - "location": "query" + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" }, "pageSize": { - "location": "query", "description": "The standard list page size.", "format": "int32", - "type": "integer" - }, - "filter": { - "description": "The standard list filter.", - "type": "string", + "type": "integer", "location": "query" } }, @@ -60,392 +59,41 @@ ], "flatPath": "v2beta2/projects/{projectsId}/locations", "path": "v2beta2/{+name}/locations", - "id": "cloudtasks.projects.locations.list" + "id": "cloudtasks.projects.locations.list", + "description": "Lists information about the supported locations for this service." }, "get": { + "id": "cloudtasks.projects.locations.get", + "path": "v2beta2/{+name}", + "description": "Get information about a location.", + "httpMethod": "GET", "response": { "$ref": "Location" }, "parameterOrder": [ "name" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "name": { - "pattern": "^projects/[^/]+/locations/[^/]+$", "location": "path", "description": "Resource name for the location.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" } }, - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}", - "path": "v2beta2/{+name}", - "id": "cloudtasks.projects.locations.get", - "description": "Get information about a location." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}" } }, "resources": { "queues": { - "methods": { - "purge": { - "request": { - "$ref": "PurgeQueueRequest" - }, - "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Queue" - }, - "parameters": { - "name": { - "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge", - "id": "cloudtasks.projects.locations.queues.purge", - "path": "v2beta2/{+name}:purge" - }, - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions", - "id": "cloudtasks.projects.locations.queues.testIamPermissions", - "path": "v2beta2/{+resource}:testIamPermissions" - }, - "pause": { - "path": "v2beta2/{+name}:pause", - "id": "cloudtasks.projects.locations.queues.pause", - "request": { - "$ref": "PauseQueueRequest" - }, - "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.state; if paused it will be set to\nQueue.State.PAUSED.", - "response": { - "$ref": "Queue" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause" - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", - "path": "v2beta2/{+name}", - "id": "cloudtasks.projects.locations.queues.delete", - "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method." - }, - "list": { - "response": { - "$ref": "ListQueuesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`", - "required": true, - "type": "string" - }, - "filter": { - "location": "query", - "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues", - "path": "v2beta2/{+parent}/queues", - "id": "cloudtasks.projects.locations.queues.list", - "description": "Lists queues.\n\nQueues are returned in lexicographical order." - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy", - "path": "v2beta2/{+resource}:setIamPolicy", - "id": "cloudtasks.projects.locations.queues.setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nNote: The Cloud Console does not check queue-level IAM permissions yet.\nProject-level permissions are required to use the Cloud Console.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`" - }, - "create": { - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues", - "path": "v2beta2/{+parent}/queues", - "id": "cloudtasks.projects.locations.queues.create", - "request": { - "$ref": "Queue" - }, - "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.", - "response": { - "$ref": "Queue" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "resume": { - "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.State.PAUSED or Queue.State.DISABLED. The state of\na queue is stored in Queue.state; after calling this method it\nwill be set to Queue.State.RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf).", - "request": { - "$ref": "ResumeQueueRequest" - }, - "response": { - "$ref": "Queue" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume", - "path": "v2beta2/{+name}:resume", - "id": "cloudtasks.projects.locations.queues.resume" - }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy", - "path": "v2beta2/{+resource}:getIamPolicy", - "id": "cloudtasks.projects.locations.queues.getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`" - }, - "patch": { - "request": { - "$ref": "Queue" - }, - "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.", - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Queue" - }, - "parameters": { - "updateMask": { - "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path", - "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", - "id": "cloudtasks.projects.locations.queues.patch", - "path": "v2beta2/{+name}" - }, - "get": { - "description": "Gets a queue.", - "httpMethod": "GET", - "response": { - "$ref": "Queue" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", - "id": "cloudtasks.projects.locations.queues.get", - "path": "v2beta2/{+name}" - } - }, "resources": { "tasks": { "methods": { - "acknowledge": { - "request": { - "$ref": "AcknowledgeTaskRequest" - }, - "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that received this task in\na LeaseTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nLeaseTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nLeaseTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.LeaseTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge", - "path": "v2beta2/{+name}:acknowledge", - "id": "cloudtasks.projects.locations.queues.tasks.acknowledge" - }, "renewLease": { - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease", "path": "v2beta2/{+name}:renewLease", "id": "cloudtasks.projects.locations.queues.tasks.renewLease", "request": { @@ -461,19 +109,19 @@ "httpMethod": "POST", "parameters": { "name": { + "location": "path", "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:renewLease" }, "get": { - "description": "Gets a task.", "response": { "$ref": "Task" }, @@ -505,9 +153,13 @@ ], "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}", "path": "v2beta2/{+name}", - "id": "cloudtasks.projects.locations.queues.tasks.get" + "id": "cloudtasks.projects.locations.queues.tasks.get", + "description": "Gets a task." }, "lease": { + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease", + "id": "cloudtasks.projects.locations.queues.tasks.lease", + "path": "v2beta2/{+parent}/tasks:lease", "request": { "$ref": "LeaseTasksRequest" }, @@ -521,21 +173,21 @@ }, "parameters": { "parent": { - "location": "path", "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks:lease", - "id": "cloudtasks.projects.locations.queues.tasks.lease", - "path": "v2beta2/{+parent}/tasks:lease" + ] }, "delete": { + "path": "v2beta2/{+name}", + "id": "cloudtasks.projects.locations.queues.tasks.delete", + "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed.", "response": { "$ref": "Empty" }, @@ -543,9 +195,6 @@ "name" ], "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "name": { "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", @@ -555,12 +204,16 @@ "location": "path" } }, - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}", - "path": "v2beta2/{+name}", - "id": "cloudtasks.projects.locations.queues.tasks.delete", - "description": "Deletes a task.\n\nA task can be deleted if it is scheduled or dispatched. A task\ncannot be deleted if it has completed successfully or permanently\nfailed." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}" }, "list": { + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks", + "id": "cloudtasks.projects.locations.queues.tasks.list", + "path": "v2beta2/{+parent}/tasks", + "description": "Lists the tasks in a queue.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default due to performance\nconsiderations; ListTasksRequest.response_view controls the\nsubset of information which is returned.", "httpMethod": "GET", "response": { "$ref": "ListTasksResponse" @@ -569,28 +222,15 @@ "parent" ], "parameters": { - "pageSize": { - "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nListTasksResponse.next_page_token to determine if more tasks\nexist.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path", - "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", - "required": true, - "type": "string" - }, "responseView": { - "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", - "type": "string", - "location": "query", "enum": [ "VIEW_UNSPECIFIED", "BASIC", "FULL" - ] + ], + "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", + "type": "string", + "location": "query" }, "orderBy": { "location": "query", @@ -601,49 +241,54 @@ "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListTasksResponse.next_page_token returned from the previous\ncall to CloudTasks.ListTasks method.\n\nThe page token is valid for only 2 hours.", "type": "string", "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Requested page size. Fewer tasks than requested might be returned.\n\nThe maximum page size is 1000. If unspecified, the page size will\nbe the maximum. Fewer tasks than requested might be returned,\neven if more tasks exist; use\nListTasksResponse.next_page_token to determine if more tasks\nexist.", + "format": "int32", + "type": "integer" + }, + "parent": { + "location": "path", + "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks", - "id": "cloudtasks.projects.locations.queues.tasks.list", - "path": "v2beta2/{+parent}/tasks", - "description": "Lists the tasks in a queue.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default due to performance\nconsiderations; ListTasksRequest.response_view controls the\nsubset of information which is returned." + ] }, "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], "response": { "$ref": "Task" }, - "parameters": { - "parent": { - "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", - "location": "path" - } - }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path", + "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\nThe queue must already exist.", + "required": true, + "type": "string" + } + }, "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks", - "id": "cloudtasks.projects.locations.queues.tasks.create", "path": "v2beta2/{+parent}/tasks", + "id": "cloudtasks.projects.locations.queues.tasks.create", + "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB.", "request": { "$ref": "CreateTaskRequest" - }, - "description": "Creates a task and adds it to a queue.\n\nTo add multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.\n\nTasks cannot be updated after creation; there is no UpdateTask command.\n\n* For [App Engine queues](google.cloud.tasks.v2beta2.AppEngineHttpTarget),\n the maximum task size is 100KB.\n* For [pull queues](google.cloud.tasks.v2beta2.PullTarget), this\n the maximum task size is 1MB." + } }, - "cancelLease": { - "request": { - "$ref": "CancelLeaseRequest" - }, - "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.LeaseTasks.", + "run": { "httpMethod": "POST", "parameterOrder": [ "name" @@ -653,28 +298,29 @@ }, "parameters": { "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", + "location": "path", "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease", - "id": "cloudtasks.projects.locations.queues.tasks.cancelLease", - "path": "v2beta2/{+name}:cancelLease" - }, - "run": { "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:run", - "path": "v2beta2/{+name}:run", "id": "cloudtasks.projects.locations.queues.tasks.run", - "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, CloudTasks.RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is Queue.State.PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the Task.status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nTask.schedule_time will be reset to the time that\nCloudTasks.RunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nCloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when\nit is called on a task that has already succeeded or permanently\nfailed. google.rpc.Code.FAILED_PRECONDITION is returned when\nCloudTasks.RunTask is called on task that is dispatched or\nalready running.\n\nCloudTasks.RunTask cannot be called on pull tasks.", + "path": "v2beta2/{+name}:run", "request": { "$ref": "RunTaskRequest" }, + "description": "Forces a task to run now.\n\nThis command is meant to be used for manual debugging. For\nexample, CloudTasks.RunTask can be used to retry a failed\ntask after a fix has been made or to manually force a task to be\ndispatched now.\n\nWhen this method is called, Cloud Tasks will dispatch the task to its\ntarget, even if the queue is Queue.State.PAUSED.\n\nThe dispatched task is returned. That is, the task that is returned\ncontains the Task.status after the task is dispatched but\nbefore the task is received by its target.\n\nIf Cloud Tasks receives a successful response from the task's\nhandler, then the task will be deleted; otherwise the task's\nTask.schedule_time will be reset to the time that\nCloudTasks.RunTask was called plus the retry delay specified\nin the queue and task's RetryConfig.\n\nCloudTasks.RunTask returns google.rpc.Code.NOT_FOUND when\nit is called on a task that has already succeeded or permanently\nfailed. google.rpc.Code.FAILED_PRECONDITION is returned when\nCloudTasks.RunTask is called on task that is dispatched or\nalready running.\n\nCloudTasks.RunTask cannot be called on pull tasks." + }, + "cancelLease": { + "description": "Cancel a pull task's lease.\n\nThe worker can use this method to cancel a task's lease\nby setting Task.schedule_time to now. This will make the task\navailable to be leased to the next caller of CloudTasks.LeaseTasks.", + "request": { + "$ref": "CancelLeaseRequest" + }, "response": { "$ref": "Task" }, @@ -687,16 +333,370 @@ ], "parameters": { "name": { + "location": "path", + "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:cancelLease", + "path": "v2beta2/{+name}:cancelLease", + "id": "cloudtasks.projects.locations.queues.tasks.cancelLease" + }, + "acknowledge": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+/tasks/[^/]+$", "location": "path", "description": "Required.\n\nThe task name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`", "required": true, "type": "string" } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}/tasks/{tasksId}:acknowledge", + "path": "v2beta2/{+name}:acknowledge", + "id": "cloudtasks.projects.locations.queues.tasks.acknowledge", + "description": "Acknowledges a pull task.\n\nThe worker, that is, the entity that received this task in\na LeaseTasksResponse, must call this method to indicate that\nthe work associated with the task has finished.\n\nThe worker must acknowledge a task within the\nLeaseTasksRequest.lease_duration or the lease will expire and\nthe task will become ready to be returned in a different\nLeaseTasksResponse. After the task is acknowledged, it will\nnot be returned by a later CloudTasks.LeaseTasks,\nCloudTasks.GetTask, or CloudTasks.ListTasks.\n\nTo acknowledge multiple tasks at the same time, use\n[HTTP batching](/storage/docs/json_api/v1/how-tos/batch)\nor the batching documentation for your client library, for example\nhttps://developers.google.com/api-client-library/python/guide/batch.", + "request": { + "$ref": "AcknowledgeTaskRequest" } } } } + }, + "methods": { + "purge": { + "response": { + "$ref": "Queue" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path", + "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:purge", + "path": "v2beta2/{+name}:purge", + "id": "cloudtasks.projects.locations.queues.purge", + "description": "Purges a queue by deleting all of its tasks.\n\nAll tasks created before this method is called are permanently deleted.\n\nPurge operations can take up to one minute to take effect. Tasks\nmight be dispatched before the purge takes effect. A purge is irreversible.", + "request": { + "$ref": "PurgeQueueRequest" + } + }, + "testIamPermissions": { + "description": "Returns permissions that a caller has on a Queue.\nIf the resource does not exist, this will return an empty set of\npermissions, not a google.rpc.Code.NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:testIamPermissions", + "path": "v2beta2/{+resource}:testIamPermissions", + "id": "cloudtasks.projects.locations.queues.testIamPermissions" + }, + "pause": { + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:pause", + "path": "v2beta2/{+name}:pause", + "id": "cloudtasks.projects.locations.queues.pause", + "description": "Pauses the queue.\n\nIf a queue is paused then the system will stop executing the\ntasks in the queue until it is resumed via\nCloudTasks.ResumeQueue. Tasks can still be added when the\nqueue is paused. The state of the queue is stored in\nQueue.state; if paused it will be set to\nQueue.State.PAUSED.", + "request": { + "$ref": "PauseQueueRequest" + }, + "response": { + "$ref": "Queue" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" + } + } + }, + "delete": { + "description": "Deletes a queue.\n\nThis command will delete the queue even if it has tasks in it.\n\nNote: If you delete a queue, a queue with the same name can't be created\nfor 7 days.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.", + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", + "id": "cloudtasks.projects.locations.queues.delete", + "path": "v2beta2/{+name}" + }, + "list": { + "description": "Lists queues.\n\nQueues are returned in lexicographical order.", + "response": { + "$ref": "ListQueuesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "parent": { + "description": "Required.\n\nThe location name.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" + }, + "filter": { + "location": "query", + "description": "`filter` can be used to specify a subset of queues. Any Queue\nfield can be used as a filter and several operators as supported.\nFor example: `\u003c=, \u003c, \u003e=, \u003e, !=, =, :`. The filter syntax is the same as\ndescribed in\n[Stackdriver's Advanced Logs Filters](/logging/docs/view/advanced_filters).\n\nSample filter \"app_engine_http_target: *\".\n\nNote that using filters might cause fewer queues than the\nrequested_page size to be returned.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "A token identifying the page of results to return.\n\nTo request the first page results, page_token must be empty. To\nrequest the next page of results, page_token must be the value of\nListQueuesResponse.next_page_token returned from the previous\ncall to CloudTasks.ListQueues method. It is an error to\nswitch the value of ListQueuesRequest.filter while iterating\nthrough pages.", + "type": "string" + }, + "pageSize": { + "description": "Requested page size.\n\nThe maximum page size is 9800. If unspecified, the page size will\nbe the maximum. Fewer queues than requested might be returned,\neven if more queues exist; use\nListQueuesResponse.next_page_token to determine if more\nqueues exist.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues", + "path": "v2beta2/{+parent}/queues", + "id": "cloudtasks.projects.locations.queues.list" + }, + "create": { + "response": { + "$ref": "Queue" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "Required.\n\nThe location name in which the queue will be created.\nFor example: `projects/PROJECT_ID/locations/LOCATION_ID`\n\nThe list of allowed locations can be obtained by calling Cloud\nTasks' implementation of\ngoogle.cloud.location.Locations.ListLocations.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues", + "path": "v2beta2/{+parent}/queues", + "id": "cloudtasks.projects.locations.queues.create", + "description": "Creates a queue.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.", + "request": { + "$ref": "Queue" + } + }, + "setIamPolicy": { + "description": "Sets the access control policy for a Queue. Replaces any existing\npolicy.\n\nNote: The Cloud Console does not check queue-level IAM permissions yet.\nProject-level permissions are required to use the Cloud Console.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.setIamPolicy`", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:setIamPolicy", + "path": "v2beta2/{+resource}:setIamPolicy", + "id": "cloudtasks.projects.locations.queues.setIamPolicy" + }, + "resume": { + "response": { + "$ref": "Queue" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path", + "description": "Required.\n\nThe queue name. For example:\n`projects/PROJECT_ID/location/LOCATION_ID/queues/QUEUE_ID`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:resume", + "path": "v2beta2/{+name}:resume", + "id": "cloudtasks.projects.locations.queues.resume", + "request": { + "$ref": "ResumeQueueRequest" + }, + "description": "Resume a queue.\n\nThis method resumes a queue after it has been\nQueue.State.PAUSED or Queue.State.DISABLED. The state of\na queue is stored in Queue.state; after calling this method it\nwill be set to Queue.State.RUNNING.\n\nWARNING: Resuming many high-QPS queues at the same time can\nlead to target overloading. If you are resuming high-QPS\nqueues, follow the 500/50/5 pattern described in\n[Managing Cloud Tasks Scaling Risks](/cloud-tasks/pdfs/managing-cloud-tasks-scaling-risks-2017-06-05.pdf)." + }, + "getIamPolicy": { + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}:getIamPolicy", + "path": "v2beta2/{+resource}:getIamPolicy", + "id": "cloudtasks.projects.locations.queues.getIamPolicy", + "description": "Gets the access control policy for a Queue.\nReturns an empty policy if the resource exists and does not have a policy\nset.\n\nAuthorization requires the following [Google IAM](/iam) permission on the\nspecified resource parent:\n\n* `cloudtasks.queues.getIamPolicy`", + "request": { + "$ref": "GetIamPolicyRequest" + } + }, + "get": { + "response": { + "$ref": "Queue" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Required.\n\nThe resource name of the queue. For example:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", + "path": "v2beta2/{+name}", + "id": "cloudtasks.projects.locations.queues.get", + "description": "Gets a queue." + }, + "patch": { + "description": "Updates a queue.\n\nThis method creates the queue if it does not exist and updates\nthe queue if it does exist.\n\nQueues created with this method allow tasks to live for a maximum of 31\ndays. After a task is 31 days old, the task will be deleted regardless of whether\nit was dispatched or not.\n\nWARNING: Using this method may have unintended side effects if you are\nusing an App Engine `queue.yaml` or `queue.xml` file to manage your queues.\nRead\n[Overview of Queue Management and queue.yaml](/cloud-tasks/docs/queue-yaml)\ncarefully before using this method.", + "request": { + "$ref": "Queue" + }, + "response": { + "$ref": "Queue" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "updateMask": { + "location": "query", + "description": "A mask used to specify which fields of the queue are being updated.\n\nIf empty, then all fields will be updated.", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "location": "path", + "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/queues/[^/]+$" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/locations/{locationsId}/queues/{queuesId}", + "path": "v2beta2/{+name}", + "id": "cloudtasks.projects.locations.queues.patch" + } } } } @@ -705,36 +705,31 @@ } }, "parameters": { - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { - "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "$.xgafv": { "enumDescriptions": [ @@ -749,11 +744,6 @@ "description": "V1 error format.", "type": "string" }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "alt": { "enumDescriptions": [ "Responses with Content-Type of application/json", @@ -770,14 +760,14 @@ ], "type": "string" }, - "access_token": { - "description": "OAuth access 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.", "type": "string", "location": "query" }, - "key": { + "access_token": { "location": "query", - "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.", + "description": "OAuth access token.", "type": "string" }, "quotaUser": { @@ -790,6 +780,16 @@ "description": "Pretty-print response.", "type": "boolean", "default": "true" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" } }, "version": "v2beta2", @@ -799,600 +799,11 @@ "servicePath": "", "basePath": "", "revision": "20180106", - "id": "cloudtasks:v2beta2", "documentationLink": "https://cloud.google.com/cloud-tasks/", + "id": "cloudtasks:v2beta2", "discoveryVersion": "v1", "version_module": true, "schemas": { - "Queue": { - "properties": { - "state": { - "enumDescriptions": [ - "Unspecified state.", - "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has had no\nactivity (method calls or task dispatches) for 30 days, the queue may\ntake a few minutes to re-activate. Some method calls may return\ngoogle.rpc.Code.NOT_FOUND and tasks may not be dispatched for a few\nminutes until the queue has been re-activated.", - "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.LeaseTasks calls will return a\n`FAILED_PRECONDITION` error.", - "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.LeaseTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue." - ], - "enum": [ - "STATE_UNSPECIFIED", - "RUNNING", - "PAUSED", - "DISABLED" - ], - "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nCloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading\n[queue.yaml](/appengine/docs/python/config/queueref).\nCloudTasks.UpdateQueue cannot be used to change `state`.", - "type": "string" - }, - "retryConfig": { - "$ref": "RetryConfig", - "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." - }, - "name": { - "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.", - "type": "string" - }, - "rateLimits": { - "$ref": "RateLimits", - "description": "Rate limits for task dispatches.\n\nQueue.rate_limits and Queue.retry_config are related because they\nboth control task attempts however they control how tasks are attempted in\ndifferent ways:\n\n* Queue.rate_limits controls the total rate of dispatches from a queue\n (i.e. all traffic dispatched from the queue, regardless of whether the\n dispatch is from a first attempt or a retry).\n* Queue.retry_config controls what happens to particular a task after\n its first attempt fails. That is, Queue.retry_config controls task\n retries (the second attempt, third attempt, etc)." - }, - "pullTarget": { - "$ref": "PullTarget", - "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget." - }, - "appEngineHttpTarget": { - "$ref": "AppEngineHttpTarget", - "description": "App Engine HTTP target.\n\nAn App Engine queue is a queue that has an AppEngineHttpTarget." - }, - "purgeTime": { - "description": "Output only. The last time this queue was purged.\n\nAll tasks that were created before this time\nwere purged.\n\nA queue can be purged using CloudTasks.PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be zero if the queue has never been purged.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "Queue", - "description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.", - "type": "object" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." - } - }, - "id": "SetIamPolicyRequest" - }, - "AppEngineRouting": { - "description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).", - "type": "object", - "properties": { - "version": { - "description": "App version.\n\nBy default, the task is sent to the version which is the default\nversion when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.", - "type": "string" - }, - "host": { - "description": "Output only. The host that the task is sent to.\n\nFor more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` AppEngineRouting.service\n\n* `version =` AppEngineRouting.version\n\n* `version_dot_service =`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\n* `instance =` AppEngineRouting.instance\n\n* `instance_dot_service =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.service\n\n* `instance_dot_version =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.version\n\n* `instance_dot_version_dot_service =`\n AppEngineRouting.instance `+ '.' +`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\nIf AppEngineRouting.service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf AppEngineRouting.version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf AppEngineRouting.instance is empty, then the task will be sent\nto an instance which is available when the task is attempted.\n\nWhen AppEngineRouting.service is \"default\",\nAppEngineRouting.version is \"default\", and\nAppEngineRouting.instance is empty, AppEngineRouting.host is\nshortened to just the `application_domain_name`.\n\nIf AppEngineRouting.service, AppEngineRouting.version, or\nAppEngineRouting.instance is invalid, then the task will be sent\nto the default version of the default service when the task is attempted.", - "type": "string" - }, - "service": { - "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.", - "type": "string" - }, - "instance": { - "description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).", - "type": "string" - } - }, - "id": "AppEngineRouting" - }, - "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" - }, - "AppEngineHttpTarget": { - "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`", - "type": "object", - "properties": { - "appEngineRoutingOverride": { - "$ref": "AppEngineRouting", - "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing." - } - }, - "id": "AppEngineHttpTarget" - }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "type": "object", - "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object" - }, - "name": { - "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", - "type": "object" - } - }, - "id": "Location" - }, - "LeaseTasksRequest": { - "properties": { - "filter": { - "description": "`filter` can be used to specify a subset of tasks to lease.\n\nWhen `filter` is set to `tag=\u003cmy-tag\u003e` then the\nLeaseTasksResponse will contain only tasks whose\nLeaseMessage.tag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be less than\n500 bytes.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string | bytes`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).", - "type": "string" - }, - "maxTasks": { - "description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.", - "format": "int32", - "type": "integer" - }, - "leaseDuration": { - "description": "The duration of the lease.\n\nEach task returned in the LeaseTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nLeaseTasksResponse is leased -- that task will not be\nreturned in a different LeaseTasksResponse before the\nTask.schedule_time.\n\nAfter the worker has successfully finished the work\nassociated with the task, the worker must call\nCloudTasks.AcknowledgeTask. If the task is not acknowledged\nvia CloudTasks.AcknowledgeTask before the\nTask.schedule_time then it will be returned in a later\nLeaseTasksResponse so that another worker can process\nit.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.", - "format": "google-duration", - "type": "string" - }, - "responseView": { - "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", - "type": "string", - "enumDescriptions": [ - "Unspecified. Defaults to BASIC.", - "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", - "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." - ], - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ] - } - }, - "id": "LeaseTasksRequest", - "description": "Request message for pulling tasks using CloudTasks.LeaseTasks.", - "type": "object" - }, - "AcknowledgeTaskRequest": { - "description": "Request message for acknowledging a task using\nCloudTasks.AcknowledgeTask.", - "type": "object", - "properties": { - "scheduleTime": { - "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "AcknowledgeTaskRequest" - }, - "ListQueuesResponse": { - "description": "Response message for CloudTasks.ListQueues.", - "type": "object", - "properties": { - "queues": { - "description": "The list of queues.", - "type": "array", - "items": { - "$ref": "Queue" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListQueues with this value as the\nListQueuesRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.", - "type": "string" - } - }, - "id": "ListQueuesResponse" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" - }, - "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", - "type": "object", - "properties": { - "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Deprecated.", - "format": "int32", - "type": "integer" - } - }, - "id": "Policy" - }, - "ListLocationsResponse": { - "description": "The response message for Locations.ListLocations.", - "type": "object", - "properties": { - "locations": { - "description": "A list of locations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Location" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListLocationsResponse" - }, - "CancelLeaseRequest": { - "description": "Request message for canceling a lease using\nCloudTasks.CancelLease.", - "type": "object", - "properties": { - "scheduleTime": { - "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.", - "format": "google-datetime", - "type": "string" - }, - "responseView": { - "enumDescriptions": [ - "Unspecified. Defaults to BASIC.", - "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", - "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." - ], - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", - "type": "string" - } - }, - "id": "CancelLeaseRequest" - }, - "AttemptStatus": { - "description": "The status of a task attempt.", - "type": "object", - "properties": { - "responseTime": { - "description": "Output only. The time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.", - "format": "google-datetime", - "type": "string" - }, - "responseStatus": { - "$ref": "Status", - "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is google.rpc.Code.UNKNOWN." - }, - "scheduleTime": { - "description": "Output only. The time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.", - "format": "google-datetime", - "type": "string" - }, - "dispatchTime": { - "description": "Output only. The time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "AttemptStatus" - }, - "RateLimits": { - "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.", - "type": "object", - "properties": { - "maxTasksDispatchedPerSecond": { - "description": "The maximum rate at which tasks are dispatched from this\nqueue.\n\nThe maximum allowed value is 500.\n\n* For App Engine queues, this field is 1 by default.\n* For pull queues, this field is output only and always 10,000.\n In addition to the `max_tasks_dispatched_per_second` limit, a maximum of\n 10 QPS of CloudTasks.LeaseTasks requests are allowed per queue.\n\nThis field has the same meaning as\n[rate in queue.yaml](/appengine/docs/standard/python/config/queueref#rate).", - "format": "double", - "type": "number" - }, - "maxBurstSize": { - "description": "Output only. The max burst size.\n\nMax burst size limits how fast the queue is processed when many\ntasks are in the queue and the rate is high. This field allows\nthe queue to have a high rate so processing starts shortly after\na task is enqueued, but still limits resource usage when many\ntasks are enqueued in a short period of time.\n\n* For App Engine queues, if\n RateLimits.max_tasks_dispatched_per_second is 1, this\n field is 10; otherwise this field is\n RateLimits.max_tasks_dispatched_per_second / 5.\n* For pull queues, this field is output only and always 10,000.\n\nNote: For App Engine queues that were created through\n`queue.yaml/xml`, `max_burst_size` might not have the same\nsettings as specified above; CloudTasks.UpdateQueue can be\nused to set `max_burst_size` only to the values specified above.\n\nThis field has the same meaning as\n[bucket_size in queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_size).", - "format": "int32", - "type": "integer" - }, - "maxConcurrentTasks": { - "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nThe maximum allowed value is 5,000.\n\n* For App Engine queues, this field is 10 by default.\n* For pull queues, this field is output only and always -1, which\n indicates no limit.\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).", - "format": "int32", - "type": "integer" - } - }, - "id": "RateLimits" - }, - "PurgeQueueRequest": { - "description": "Request message for CloudTasks.PurgeQueue.", - "type": "object", - "properties": {}, - "id": "PurgeQueueRequest" - }, - "PauseQueueRequest": { - "properties": {}, - "id": "PauseQueueRequest", - "description": "Request message for CloudTasks.PauseQueue.", - "type": "object" - }, - "RunTaskRequest": { - "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.", - "type": "object", - "properties": { - "responseView": { - "enumDescriptions": [ - "Unspecified. Defaults to BASIC.", - "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", - "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." - ], - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", - "type": "string" - } - }, - "id": "RunTaskRequest" - }, - "Task": { - "description": "A unit of scheduled work.", - "type": "object", - "properties": { - "pullMessage": { - "$ref": "PullMessage", - "description": "Pull message contains data that should be used by the caller of\nCloudTasks.LeaseTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set." - }, - "scheduleTime": { - "description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the LeaseTasksRequest.lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.", - "format": "google-datetime", - "type": "string" - }, - "createTime": { - "description": "Output only. The time that the task was created.\n\n`create_time` will be truncated to the nearest second.", - "format": "google-datetime", - "type": "string" - }, - "status": { - "$ref": "TaskStatus", - "description": "Output only. The task status." - }, - "name": { - "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the task's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.\n\nOptionally caller-specified in CreateTaskRequest.", - "type": "string" - }, - "appEngineHttpRequest": { - "$ref": "AppEngineHttpRequest", - "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set." - }, - "view": { - "enumDescriptions": [ - "Unspecified. Defaults to BASIC.", - "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", - "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." - ], - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "description": "Output only. The view specifies which subset of the Task has\nbeen returned.", - "type": "string" - } - }, - "id": "Task" - }, - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "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" - } - }, - "id": "Status" - }, - "PullMessage": { - "description": "The pull message contains data that can be used by the caller of\nCloudTasks.LeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.", - "type": "object", - "properties": { - "payload": { - "description": "A data payload consumed by the worker to execute the task.", - "format": "byte", - "type": "string" - }, - "tag": { - "description": "The task's tag.\n\nTags allow similar tasks to be processed in a batch. If you label\ntasks with a tag, your worker can lease tasks\nwith the same tag using LeaseTasksRequest.filter. For example,\nif you want to aggregate the events associated with a specific\nuser once a day, you could tag tasks with the user ID.\n\nThe task's tag can only be set when the\ntask is created.\n\nThe tag must be less than 500 bytes.", - "format": "byte", - "type": "string" - } - }, - "id": "PullMessage" - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - } - }, - "id": "Binding" - }, - "RenewLeaseRequest": { - "properties": { - "scheduleTime": { - "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.", - "format": "google-datetime", - "type": "string" - }, - "leaseDuration": { - "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.", - "format": "google-duration", - "type": "string" - }, - "responseView": { - "enumDescriptions": [ - "Unspecified. Defaults to BASIC.", - "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", - "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." - ], - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", - "type": "string" - } - }, - "id": "RenewLeaseRequest", - "description": "Request message for renewing a lease using CloudTasks.RenewLease.", - "type": "object" - }, - "TaskStatus": { - "properties": { - "attemptDispatchCount": { - "description": "Output only. The number of attempts dispatched.\n\nThis count includes tasks which have been dispatched but haven't\nreceived a response.", - "format": "int32", - "type": "integer" - }, - "firstAttemptStatus": { - "$ref": "AttemptStatus", - "description": "Output only. The status of the task's first attempt.\n\nOnly AttemptStatus.dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)." - }, - "attemptResponseCount": { - "description": "Output only. The number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).", - "format": "int32", - "type": "integer" - }, - "lastAttemptStatus": { - "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).", - "$ref": "AttemptStatus" - } - }, - "id": "TaskStatus", - "description": "Status of the task.", - "type": "object" - }, - "AppEngineHttpRequest": { - "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task attempt has succeeded if the app's request handler returns\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.", - "type": "object", - "properties": { - "appEngineRouting": { - "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing.", - "$ref": "AppEngineRouting" - }, - "httpMethod": { - "enum": [ - "HTTP_METHOD_UNSPECIFIED", - "POST", - "GET", - "HEAD", - "PUT", - "DELETE" - ], - "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).", - "type": "string", - "enumDescriptions": [ - "HTTP method unspecified", - "HTTP Post", - "HTTP Get", - "HTTP Head", - "HTTP Put", - "HTTP Delete" - ] - }, - "payload": { - "description": "Payload.\n\nThe payload will be sent as the HTTP message body. A message\nbody, and thus a payload, is allowed only if the HTTP method is\nPOST or PUT. It is an error to set a data payload on a task with\nan incompatible HttpMethod.", - "format": "byte", - "type": "string" - }, - "relativeUrl": { - "description": "The relative URL.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path and query string arguments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.", - "type": "string" - }, - "headers": { - "additionalProperties": { - "type": "string" - }, - "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CloudTasks.CreateTask documentation.", - "type": "object" - } - }, - "id": "AppEngineHttpRequest" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsResponse" - }, - "GetIamPolicyRequest": { - "properties": {}, - "id": "GetIamPolicyRequest", - "description": "Request message for `GetIamPolicy` method.", - "type": "object" - }, "RetryConfig": { "description": "Retry config.\n\nThese settings determine how a failed task attempt is retried.", "type": "object", @@ -1463,23 +874,23 @@ "description": "Request message for CloudTasks.CreateTask.", "type": "object", "properties": { - "task": { - "$ref": "Task", - "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a name for the task in\nTask.name. If a name is not specified then the system will\ngenerate a random unique task id, which will be returned in the\nresponse's Task.name.\n\nIf Task.schedule_time is not set or is in the past then Cloud\nTasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith google.rpc.Code.ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CloudTasks.CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently." - }, "responseView": { - "enumDescriptions": [ - "Unspecified. Defaults to BASIC.", - "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", - "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." - ], "enum": [ "VIEW_UNSPECIFIED", "BASIC", "FULL" ], "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", + "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." + ] + }, + "task": { + "$ref": "Task", + "description": "Required.\n\nThe task to add.\n\nTask names have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`.\nThe user can optionally specify a name for the task in\nTask.name. If a name is not specified then the system will\ngenerate a random unique task id, which will be returned in the\nresponse's Task.name.\n\nIf Task.schedule_time is not set or is in the past then Cloud\nTasks will set it to the current time.\n\nTask De-duplication:\n\nExplicitly specifying a task ID enables task de-duplication. If\na task's ID is identical to that of an existing task or a task\nthat was deleted or completed recently then the call will fail\nwith google.rpc.Code.ALREADY_EXISTS.\nIf the task's queue was created using Cloud Tasks, then another task with\nthe same name can't be created for ~1hour after the original task was\ndeleted or completed. If the task's queue was created using queue.yaml or\nqueue.xml, then another task with the same name can't be created\nfor ~9days after the original task was deleted or completed.\n\nBecause there is an extra lookup cost to identify duplicate task\nnames, these CloudTasks.CreateTask calls have significantly\nincreased latency. Using hashed strings for the task id or for\nthe prefix of the task id is recommended. Choosing task ids that\nare sequential or have sequential prefixes, for example using a\ntimestamp, causes an increase in latency and error rates in all\ntask commands. The infrastructure relies on an approximately\nuniform distribution of task ids to store and serve tasks\nefficiently." } }, "id": "CreateTaskRequest" @@ -1497,11 +908,600 @@ } }, "id": "LeaseTasksResponse" + }, + "Queue": { + "description": "A queue is a container of related tasks. Queues are configured to manage\nhow those tasks are dispatched. Configurable properties include rate limits,\nretry options, target types, and others.", + "type": "object", + "properties": { + "state": { + "description": "Output only. The state of the queue.\n\n`state` can only be changed by called\nCloudTasks.PauseQueue, CloudTasks.ResumeQueue, or uploading\n[queue.yaml](/appengine/docs/python/config/queueref).\nCloudTasks.UpdateQueue cannot be used to change `state`.", + "type": "string", + "enumDescriptions": [ + "Unspecified state.", + "The queue is running. Tasks can be dispatched.\n\nIf the queue was created using Cloud Tasks and the queue has had no\nactivity (method calls or task dispatches) for 30 days, the queue may\ntake a few minutes to re-activate. Some method calls may return\ngoogle.rpc.Code.NOT_FOUND and tasks may not be dispatched for a few\nminutes until the queue has been re-activated.", + "Tasks are paused by the user. If the queue is paused then Cloud\nTasks will stop delivering tasks from it, but more tasks can\nstill be added to it by the user. When a pull queue is paused,\nall CloudTasks.LeaseTasks calls will return a\n`FAILED_PRECONDITION` error.", + "The queue is disabled.\n\nA queue becomes `DISABLED` when\n[queue.yaml](/appengine/docs/python/config/queueref) or\n[queue.xml](appengine/docs/standard/java/config/queueref) is uploaded\nwhich does not contain the queue. You cannot directly disable a queue.\n\nWhen a queue is disabled, tasks can still be added to a queue\nbut the tasks are not dispatched and CloudTasks.LeaseTasks calls\nreturn a `FAILED_PRECONDITION` error.\n\nTo permanently delete this queue and all of its tasks, call\nCloudTasks.DeleteQueue." + ], + "enum": [ + "STATE_UNSPECIFIED", + "RUNNING", + "PAUSED", + "DISABLED" + ] + }, + "retryConfig": { + "$ref": "RetryConfig", + "description": "Settings that determine the retry behavior.\n\n* For tasks created using Cloud Tasks: the queue-level retry settings\n apply to all tasks in the queue that were created using Cloud Tasks.\n Retry settings cannot be set on individual tasks.\n* For tasks created using the App Engine SDK: the queue-level retry\n settings apply to all tasks in the queue which do not have retry settings\n explicitly set on the task and were created by the App Engine SDK. See\n [App Engine documentation](/appengine/docs/standard/python/taskqueue/push/retrying-tasks)." + }, + "name": { + "description": "The queue name.\n\nThe queue name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the queue's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n\nCaller-specified and required in CreateQueueRequest, after which\nit becomes output only.", + "type": "string" + }, + "rateLimits": { + "$ref": "RateLimits", + "description": "Rate limits for task dispatches.\n\nQueue.rate_limits and Queue.retry_config are related because they\nboth control task attempts however they control how tasks are attempted in\ndifferent ways:\n\n* Queue.rate_limits controls the total rate of dispatches from a queue\n (i.e. all traffic dispatched from the queue, regardless of whether the\n dispatch is from a first attempt or a retry).\n* Queue.retry_config controls what happens to particular a task after\n its first attempt fails. That is, Queue.retry_config controls task\n retries (the second attempt, third attempt, etc)." + }, + "pullTarget": { + "$ref": "PullTarget", + "description": "Pull target.\n\nA pull queue is a queue that has a PullTarget." + }, + "appEngineHttpTarget": { + "description": "App Engine HTTP target.\n\nAn App Engine queue is a queue that has an AppEngineHttpTarget.", + "$ref": "AppEngineHttpTarget" + }, + "purgeTime": { + "description": "Output only. The last time this queue was purged.\n\nAll tasks that were created before this time\nwere purged.\n\nA queue can be purged using CloudTasks.PurgeQueue, the\n[App Engine Task Queue SDK, or the Cloud Console](/appengine/docs/standard/python/taskqueue/push/deleting-tasks-and-queues#purging_all_tasks_from_a_queue).\n\nPurge time will be truncated to the nearest microsecond. Purge\ntime will be zero if the queue has never been purged.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "Queue" + }, + "SetIamPolicyRequest": { + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest", + "description": "Request message for `SetIamPolicy` method.", + "type": "object" + }, + "AppEngineRouting": { + "description": "App Engine Routing.\n\nFor more information about services, versions, and instances see\n[An Overview of App Engine](/appengine/docs/python/an-overview-of-app-engine),\n[Microservices Architecture on Google App Engine](/appengine/docs/python/microservices-on-app-engine),\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed),\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).", + "type": "object", + "properties": { + "service": { + "description": "App service.\n\nBy default, the task is sent to the service which is the default\nservice when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.", + "type": "string" + }, + "instance": { + "description": "App instance.\n\nBy default, the task is sent to an instance which is available when\nthe task is attempted.\n\nRequests can only be sent to a specific instance if\n[manual scaling is used in App Engine Standard](/appengine/docs/python/an-overview-of-app-engine?hl=en_US#scaling_types_and_instance_classes).\nApp Engine Flex does not support instances. For more information, see\n[App Engine Standard request routing](/appengine/docs/standard/python/how-requests-are-routed)\nand [App Engine Flex request routing](/appengine/docs/flexible/python/how-requests-are-routed).", + "type": "string" + }, + "version": { + "description": "App version.\n\nBy default, the task is sent to the version which is the default\nversion when the task is attempted (\"default\").\n\nFor some queues or tasks which were created using the App Engine Task Queue\nAPI, AppEngineRouting.host is not parsable into\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance. For example, some tasks which were created\nusing the App Engine SDK use a custom domain name; custom domains are not\nparsed by Cloud Tasks. If AppEngineRouting.host is not parsable, then\nAppEngineRouting.service, AppEngineRouting.version, and\nAppEngineRouting.instance are the empty string.", + "type": "string" + }, + "host": { + "description": "Output only. The host that the task is sent to.\n\nFor more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed).\n\nThe host is constructed as:\n\n\n* `host = [application_domain_name]`\u003c/br\u003e\n `| [service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [version_dot_service]+ '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_service] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version] + '.' + [application_domain_name]`\u003c/br\u003e\n `| [instance_dot_version_dot_service] + '.' + [application_domain_name]`\n\n* `application_domain_name` = The domain name of the app, for\n example \u003capp-id\u003e.appspot.com, which is associated with the\n queue's project ID. Some tasks which were created using the App Engine\n SDK use a custom domain name.\n\n* `service =` AppEngineRouting.service\n\n* `version =` AppEngineRouting.version\n\n* `version_dot_service =`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\n* `instance =` AppEngineRouting.instance\n\n* `instance_dot_service =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.service\n\n* `instance_dot_version =`\n AppEngineRouting.instance `+ '.' +` AppEngineRouting.version\n\n* `instance_dot_version_dot_service =`\n AppEngineRouting.instance `+ '.' +`\n AppEngineRouting.version `+ '.' +` AppEngineRouting.service\n\nIf AppEngineRouting.service is empty, then the task will be sent\nto the service which is the default service when the task is attempted.\n\nIf AppEngineRouting.version is empty, then the task will be sent\nto the version which is the default version when the task is attempted.\n\nIf AppEngineRouting.instance is empty, then the task will be sent\nto an instance which is available when the task is attempted.\n\nWhen AppEngineRouting.service is \"default\",\nAppEngineRouting.version is \"default\", and\nAppEngineRouting.instance is empty, AppEngineRouting.host is\nshortened to just the `application_domain_name`.\n\nIf AppEngineRouting.service, AppEngineRouting.version, or\nAppEngineRouting.instance is invalid, then the task will be sent\nto the default version of the default service when the task is attempted.", + "type": "string" + } + }, + "id": "AppEngineRouting" + }, + "Empty": { + "properties": {}, + "id": "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 `{}`.", + "type": "object" + }, + "AppEngineHttpTarget": { + "properties": { + "appEngineRoutingOverride": { + "$ref": "AppEngineRouting", + "description": "Overrides for the\ntask-level app_engine_routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing." + } + }, + "id": "AppEngineHttpTarget", + "description": "App Engine HTTP target.\n\nThe task will be delivered to the App Engine application hostname\nspecified by its AppEngineHttpTarget and AppEngineHttpRequest.\nThe documentation for AppEngineHttpRequest explains how the\ntask's host URL is constructed.\n\nUsing AppEngineHttpTarget requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`", + "type": "object" + }, + "Location": { + "properties": { + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + } + }, + "id": "Location", + "description": "A resource that represents Google Cloud Platform location.", + "type": "object" + }, + "LeaseTasksRequest": { + "properties": { + "filter": { + "description": "`filter` can be used to specify a subset of tasks to lease.\n\nWhen `filter` is set to `tag=\u003cmy-tag\u003e` then the\nLeaseTasksResponse will contain only tasks whose\nLeaseMessage.tag is equal to `\u003cmy-tag\u003e`. `\u003cmy-tag\u003e` must be less than\n500 bytes.\n\nWhen `filter` is set to `tag_function=oldest_tag()`, only tasks which have\nthe same tag as the task with the oldest schedule_time will be returned.\n\nGrammar Syntax:\n\n* `filter = \"tag=\" tag | \"tag_function=\" function`\n\n* `tag = string | bytes`\n\n* `function = \"oldest_tag()\"`\n\nThe `oldest_tag()` function returns tasks which have the same tag as the\noldest task (ordered by schedule time).", + "type": "string" + }, + "maxTasks": { + "description": "The maximum number of tasks to lease. The maximum that can be\nrequested is 1000.", + "format": "int32", + "type": "integer" + }, + "leaseDuration": { + "description": "The duration of the lease.\n\nEach task returned in the LeaseTasksResponse will have its\nTask.schedule_time set to the current time plus the\n`lease_duration`. A task that has been returned in a\nLeaseTasksResponse is leased -- that task will not be\nreturned in a different LeaseTasksResponse before the\nTask.schedule_time.\n\nAfter the worker has successfully finished the work\nassociated with the task, the worker must call\nCloudTasks.AcknowledgeTask. If the task is not acknowledged\nvia CloudTasks.AcknowledgeTask before the\nTask.schedule_time then it will be returned in a later\nLeaseTasksResponse so that another worker can process\nit.\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.", + "format": "google-duration", + "type": "string" + }, + "responseView": { + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", + "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." + ], + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", + "type": "string" + } + }, + "id": "LeaseTasksRequest", + "description": "Request message for pulling tasks using CloudTasks.LeaseTasks.", + "type": "object" + }, + "AcknowledgeTaskRequest": { + "description": "Request message for acknowledging a task using\nCloudTasks.AcknowledgeTask.", + "type": "object", + "properties": { + "scheduleTime": { + "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "AcknowledgeTaskRequest" + }, + "ListQueuesResponse": { + "description": "Response message for CloudTasks.ListQueues.", + "type": "object", + "properties": { + "queues": { + "description": "The list of queues.", + "type": "array", + "items": { + "$ref": "Queue" + } + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.\n\nTo return the next page of results, call\nCloudTasks.ListQueues with this value as the\nListQueuesRequest.page_token.\n\nIf the next_page_token is empty, there are no more results.\n\nThe page token is valid for only 2 hours.", + "type": "string" + } + }, + "id": "ListQueuesResponse" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest" + }, + "ListLocationsResponse": { + "description": "The response message for Locations.ListLocations.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "locations": { + "description": "A list of locations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Location" + } + } + }, + "id": "ListLocationsResponse" + }, + "Policy": { + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", + "type": "object", + "properties": { + "bindings": { + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + }, + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Deprecated.", + "format": "int32", + "type": "integer" + } + }, + "id": "Policy" + }, + "CancelLeaseRequest": { + "properties": { + "scheduleTime": { + "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.", + "format": "google-datetime", + "type": "string" + }, + "responseView": { + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", + "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." + ], + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", + "type": "string" + } + }, + "id": "CancelLeaseRequest", + "description": "Request message for canceling a lease using\nCloudTasks.CancelLease.", + "type": "object" + }, + "AttemptStatus": { + "description": "The status of a task attempt.", + "type": "object", + "properties": { + "responseTime": { + "description": "Output only. The time that this attempt response was received.\n\n`response_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + }, + "responseStatus": { + "description": "Output only. The response from the target for this attempt.\n\nIf the task has not been attempted or the task is currently running\nthen the response status is google.rpc.Code.UNKNOWN.", + "$ref": "Status" + }, + "scheduleTime": { + "description": "Output only. The time that this attempt was scheduled.\n\n`schedule_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + }, + "dispatchTime": { + "description": "Output only. The time that this attempt was dispatched.\n\n`dispatch_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "AttemptStatus" + }, + "RateLimits": { + "properties": { + "maxTasksDispatchedPerSecond": { + "description": "The maximum rate at which tasks are dispatched from this\nqueue.\n\nThe maximum allowed value is 500.\n\n* For App Engine queues, this field is 1 by default.\n* For pull queues, this field is output only and always 10,000.\n In addition to the `max_tasks_dispatched_per_second` limit, a maximum of\n 10 QPS of CloudTasks.LeaseTasks requests are allowed per queue.\n\nThis field has the same meaning as\n[rate in queue.yaml](/appengine/docs/standard/python/config/queueref#rate).", + "format": "double", + "type": "number" + }, + "maxBurstSize": { + "description": "Output only. The max burst size.\n\nMax burst size limits how fast the queue is processed when many\ntasks are in the queue and the rate is high. This field allows\nthe queue to have a high rate so processing starts shortly after\na task is enqueued, but still limits resource usage when many\ntasks are enqueued in a short period of time.\n\n* For App Engine queues, if\n RateLimits.max_tasks_dispatched_per_second is 1, this\n field is 10; otherwise this field is\n RateLimits.max_tasks_dispatched_per_second / 5.\n* For pull queues, this field is output only and always 10,000.\n\nNote: For App Engine queues that were created through\n`queue.yaml/xml`, `max_burst_size` might not have the same\nsettings as specified above; CloudTasks.UpdateQueue can be\nused to set `max_burst_size` only to the values specified above.\n\nThis field has the same meaning as\n[bucket_size in queue.yaml](/appengine/docs/standard/python/config/queueref#bucket_size).", + "format": "int32", + "type": "integer" + }, + "maxConcurrentTasks": { + "description": "The maximum number of concurrent tasks that Cloud Tasks allows\nto be dispatched for this queue. After this threshold has been\nreached, Cloud Tasks stops dispatching tasks until the number of\nconcurrent requests decreases.\n\nThe maximum allowed value is 5,000.\n\n* For App Engine queues, this field is 10 by default.\n* For pull queues, this field is output only and always -1, which\n indicates no limit.\n\nThis field has the same meaning as\n[max_concurrent_requests in queue.yaml](/appengine/docs/standard/python/config/queueref#max_concurrent_requests).", + "format": "int32", + "type": "integer" + } + }, + "id": "RateLimits", + "description": "Rate limits.\n\nThis message determines the maximum rate that tasks can be dispatched by a\nqueue, regardless of whether the dispatch is a first task attempt or a retry.", + "type": "object" + }, + "PauseQueueRequest": { + "properties": {}, + "id": "PauseQueueRequest", + "description": "Request message for CloudTasks.PauseQueue.", + "type": "object" + }, + "PurgeQueueRequest": { + "description": "Request message for CloudTasks.PurgeQueue.", + "type": "object", + "properties": {}, + "id": "PurgeQueueRequest" + }, + "Task": { + "description": "A unit of scheduled work.", + "type": "object", + "properties": { + "appEngineHttpRequest": { + "description": "App Engine HTTP request that is sent to the task's target. Can be set\nonly if Queue.app_engine_http_target is set.\n\nAn App Engine task is a task that has AppEngineHttpRequest set.", + "$ref": "AppEngineHttpRequest" + }, + "view": { + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", + "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." + ], + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "description": "Output only. The view specifies which subset of the Task has\nbeen returned.", + "type": "string" + }, + "pullMessage": { + "description": "Pull message contains data that should be used by the caller of\nCloudTasks.LeaseTasks to process the task. Can be set only if\nQueue.pull_target is set.\n\nA pull task is a task that has PullMessage set.", + "$ref": "PullMessage" + }, + "scheduleTime": { + "description": "The time when the task is scheduled to be attempted.\n\nFor App Engine queues, this is when the task will be attempted or retried.\n\nFor pull queues, this is the time when the task is available to\nbe leased; if a task is currently leased, this is the time when\nthe current lease expires, that is, the time that the task was\nleased plus the LeaseTasksRequest.lease_duration.\n\n`schedule_time` will be truncated to the nearest microsecond.", + "format": "google-datetime", + "type": "string" + }, + "createTime": { + "description": "Output only. The time that the task was created.\n\n`create_time` will be truncated to the nearest second.", + "format": "google-datetime", + "type": "string" + }, + "status": { + "description": "Output only. The task status.", + "$ref": "TaskStatus" + }, + "name": { + "description": "The task name.\n\nThe task name must have the following format:\n`projects/PROJECT_ID/locations/LOCATION_ID/queues/QUEUE_ID/tasks/TASK_ID`\n\n* `PROJECT_ID` can contain letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), colons (:), or periods (.).\n For more information, see\n [Identifying projects](/resource-manager/docs/creating-managing-projects#identifying_projects)\n* `LOCATION_ID` is the canonical ID for the task's location.\n The list of available locations can be obtained by calling\n google.cloud.location.Locations.ListLocations.\n For more information, see https://cloud.google.com/about/locations/.\n* `QUEUE_ID` can contain letters ([A-Za-z]), numbers ([0-9]), or\n hyphens (-). The maximum length is 100 characters.\n* `TASK_ID` can contain only letters ([A-Za-z]), numbers ([0-9]),\n hyphens (-), or underscores (_). The maximum length is 500 characters.\n\nOptionally caller-specified in CreateTaskRequest.", + "type": "string" + } + }, + "id": "Task" + }, + "RunTaskRequest": { + "description": "Request message for forcing a task to run now using\nCloudTasks.RunTask.", + "type": "object", + "properties": { + "responseView": { + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", + "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." + ], + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", + "type": "string" + } + }, + "id": "RunTaskRequest" + }, + "PullMessage": { + "properties": { + "tag": { + "description": "The task's tag.\n\nTags allow similar tasks to be processed in a batch. If you label\ntasks with a tag, your worker can lease tasks\nwith the same tag using LeaseTasksRequest.filter. For example,\nif you want to aggregate the events associated with a specific\nuser once a day, you could tag tasks with the user ID.\n\nThe task's tag can only be set when the\ntask is created.\n\nThe tag must be less than 500 bytes.", + "format": "byte", + "type": "string" + }, + "payload": { + "description": "A data payload consumed by the worker to execute the task.", + "format": "byte", + "type": "string" + } + }, + "id": "PullMessage", + "description": "The pull message contains data that can be used by the caller of\nCloudTasks.LeaseTasks to process the task.\n\nThis proto can only be used for tasks in a queue which has\nQueue.pull_target set.", + "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.", + "type": "object", + "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" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + } + }, + "id": "Status" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "type": "object", + "properties": { + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + } + }, + "id": "Binding" + }, + "RenewLeaseRequest": { + "properties": { + "scheduleTime": { + "description": "Required.\n\nThe task's current schedule time, available in the Task.schedule_time\nreturned in LeaseTasksResponse.tasks or\nCloudTasks.RenewLease. This restriction is to ensure that your\nworker currently holds the lease.", + "format": "google-datetime", + "type": "string" + }, + "leaseDuration": { + "description": "Required.\n\nThe desired new lease duration, starting from now.\n\n\nThe maximum lease duration is 1 week.\n`lease_duration` will be truncated to the nearest second.", + "format": "google-duration", + "type": "string" + }, + "responseView": { + "description": "The response_view specifies which subset of the Task will be\nreturned.\n\nBy default response_view is Task.View.BASIC; not all\ninformation is retrieved by default because some data, such as\npayloads, might be desirable to return only when needed because\nof its large size or because of the sensitivity of data that it\ncontains.\n\nAuthorization for Task.View.FULL requires `cloudtasks.tasks.fullView`\n[Google IAM](/iam/) permission on the\nTask.name resource.", + "type": "string", + "enumDescriptions": [ + "Unspecified. Defaults to BASIC.", + "The basic view omits fields which can be large or can contain\nsensitive data.\n\nThis view does not include (AppEngineHttpRequest.payload\nand PullMessage.payload). These payloads are desirable to\nreturn only when needed, because they can be large and because\nof the sensitivity of the data that you choose to store in it.", + "All information is returned.\n\nAuthorization for Task.View.FULL requires\n`cloudtasks.tasks.fullView` [Google IAM](https://cloud.google.com/iam/)\npermission on the Queue.name resource." + ], + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ] + } + }, + "id": "RenewLeaseRequest", + "description": "Request message for renewing a lease using CloudTasks.RenewLease.", + "type": "object" + }, + "TaskStatus": { + "description": "Status of the task.", + "type": "object", + "properties": { + "lastAttemptStatus": { + "$ref": "AttemptStatus", + "description": "Output only. The status of the task's last attempt.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)." + }, + "attemptDispatchCount": { + "description": "Output only. The number of attempts dispatched.\n\nThis count includes tasks which have been dispatched but haven't\nreceived a response.", + "format": "int32", + "type": "integer" + }, + "firstAttemptStatus": { + "$ref": "AttemptStatus", + "description": "Output only. The status of the task's first attempt.\n\nOnly AttemptStatus.dispatch_time will be set.\nThe other AttemptStatus information is not retained by Cloud Tasks.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget)." + }, + "attemptResponseCount": { + "description": "Output only. The number of attempts which have received a response.\n\nThis field is not calculated for\n[pull tasks](google.cloud.tasks.v2beta2.PullTaskTarget).", + "format": "int32", + "type": "integer" + } + }, + "id": "TaskStatus" + }, + "AppEngineHttpRequest": { + "properties": { + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "HTTP request headers.\n\nThis map contains the header field names and values.\nHeaders can be set when the\n[task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\nRepeated headers are not supported but a header value can contain commas.\n\nCloud Tasks sets some headers to default values:\n\n* `User-Agent`: By default, this header is\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"`.\n This header can be modified, but Cloud Tasks will append\n `\"AppEngine-Google; (+http://code.google.com/appengine)\"` to the\n modified `User-Agent`.\n\nIf the task has an AppEngineHttpRequest.payload, Cloud Tasks sets the\nfollowing headers:\n\n* `Content-Type`: By default, the `Content-Type` header is set to\n `\"application/octet-stream\"`. The default can be overridden by explictly\n setting `Content-Type` to a particular media type when the\n [task is created](google.cloud.tasks.v2beta2.CloudTasks.CreateTask).\n For example, `Content-Type` can be set to `\"application/json\"`.\n* `Content-Length`: This is computed by Cloud Tasks. This value is\n output only. It cannot be changed.\n\nThe headers below cannot be set or overridden:\n\n* `Host`\n* `X-Google-*`\n* `X-AppEngine-*`\n\nIn addition, Cloud Tasks sets some headers when the task is dispatched,\nsuch as headers containing information about the task; see\n[request headers](/appengine/docs/python/taskqueue/push/creating-handlers#reading_request_headers).\nThese headers are set only when the task is dispatched, so they are not\nvisible when the task is returned in a Cloud Tasks response.\n\nAlthough there is no specific limit for the maximum number of headers or\nthe size, there is a limit on the maximum size of the Task. For more\ninformation, see the CloudTasks.CreateTask documentation.", + "type": "object" + }, + "appEngineRouting": { + "$ref": "AppEngineRouting", + "description": "Task-level setting for App Engine routing.\n\nIf set, AppEngineHttpTarget.app_engine_routing_override is used for\nall tasks in the queue, no matter what the setting is for the\ntask-level app_engine_routing." + }, + "httpMethod": { + "enum": [ + "HTTP_METHOD_UNSPECIFIED", + "POST", + "GET", + "HEAD", + "PUT", + "DELETE" + ], + "description": "The HTTP method to use for the request. The default is POST.\n\nThe app's request handler for the task's target URL must be able to handle\nHTTP requests with this http_method, otherwise the task attempt will fail\nwith error code 405 (Method Not Allowed). See\n[Writing a push task request handler](/appengine/docs/java/taskqueue/push/creating-handlers#writing_a_push_task_request_handler)\nand the documentation for the request handlers in the language your app is\nwritten in e.g.\n[Python Request Handler](/appengine/docs/python/tools/webapp/requesthandlerclass).", + "type": "string", + "enumDescriptions": [ + "HTTP method unspecified", + "HTTP Post", + "HTTP Get", + "HTTP Head", + "HTTP Put", + "HTTP Delete" + ] + }, + "payload": { + "description": "Payload.\n\nThe payload will be sent as the HTTP message body. A message\nbody, and thus a payload, is allowed only if the HTTP method is\nPOST or PUT. It is an error to set a data payload on a task with\nan incompatible HttpMethod.", + "format": "byte", + "type": "string" + }, + "relativeUrl": { + "description": "The relative URL.\n\nThe relative URL must begin with \"/\" and must be a valid HTTP relative URL.\nIt can contain a path and query string arguments.\nIf the relative URL is empty, then the root path \"/\" will be used.\nNo spaces are allowed, and the maximum length allowed is 2083 characters.", + "type": "string" + } + }, + "id": "AppEngineHttpRequest", + "description": "App Engine HTTP request.\n\nThe message defines the HTTP request that is sent to an App Engine app when\nthe task is dispatched.\n\nThis proto can only be used for tasks in a queue which has\nQueue.app_engine_http_target set.\n\nUsing AppEngineHttpRequest requires\n[`appengine.applications.get`](/appengine/docs/admin-api/access-control)\nGoogle IAM permission for the project\nand the following scope:\n\n`https://www.googleapis.com/auth/cloud-platform`\n\nThe task will be delivered to the App Engine app which belongs to the same\nproject as the queue. For more information, see\n[How Requests are Routed](/appengine/docs/standard/python/how-requests-are-routed)\nand how routing is affected by\n[dispatch files](/appengine/docs/python/config/dispatchref).\n\nThe AppEngineRouting used to construct the URL that the task is\ndelivered to can be set at the queue-level or task-level:\n\n* If set, AppEngineHttpTarget.app_engine_routing_override is used for\n all tasks in the queue, no matter what the setting is for the\n task-level app_engine_routing.\n\n\nThe `url` that the task will be sent to is:\n\n* `url =` AppEngineRouting.host `+` AppEngineHttpRequest.relative_url\n\nThe task attempt has succeeded if the app's request handler returns\nan HTTP response code in the range [`200` - `299`]. `503` is\nconsidered an App Engine system error instead of an application\nerror. Requests returning error `503` will be retried regardless of\nretry configuration and not counted against retry counts.\nAny other response code or a failure to receive a response before the\ndeadline is a failed attempt.", + "type": "object" + }, + "GetIamPolicyRequest": { + "properties": {}, + "id": "GetIamPolicyRequest", + "description": "Request message for `GetIamPolicy` method.", + "type": "object" + }, + "TestIamPermissionsResponse": { + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsResponse", + "description": "Response message for `TestIamPermissions` method.", + "type": "object" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" } }
diff --git a/cloudtrace/v1/cloudtrace-api.json b/cloudtrace/v1/cloudtrace-api.json index b5fa57b..87748ac 100644 --- a/cloudtrace/v1/cloudtrace-api.json +++ b/cloudtrace/v1/cloudtrace-api.json
@@ -1,4 +1,151 @@ { + "version": "v1", + "baseUrl": "https://cloudtrace.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n", + "servicePath": "", + "basePath": "", + "id": "cloudtrace:v1", + "documentationLink": "https://cloud.google.com/trace", + "revision": "20171229", + "discoveryVersion": "v1", + "version_module": true, + "schemas": { + "Traces": { + "description": "List of new or updated traces.", + "type": "object", + "properties": { + "traces": { + "description": "List of traces.", + "type": "array", + "items": { + "$ref": "Trace" + } + } + }, + "id": "Traces" + }, + "TraceSpan": { + "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.", + "type": "object", + "properties": { + "spanId": { + "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.", + "format": "uint64", + "type": "string" + }, + "parentSpanId": { + "description": "ID of the parent span, if any. Optional.", + "format": "uint64", + "type": "string" + }, + "endTime": { + "description": "End time of the span in nanoseconds from the UNIX epoch.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Start time of the span in nanoseconds from the UNIX epoch.", + "format": "google-datetime", + "type": "string" + }, + "kind": { + "enumDescriptions": [ + "Unspecified.", + "Indicates that the span covers server-side handling of an RPC or other\nremote network request.", + "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request." + ], + "enum": [ + "SPAN_KIND_UNSPECIFIED", + "RPC_SERVER", + "RPC_CLIENT" + ], + "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`", + "type": "object" + }, + "name": { + "description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.", + "type": "string" + } + }, + "id": "TraceSpan" + }, + "ListTracesResponse": { + "description": "The response message for the `ListTraces` method.", + "type": "object", + "properties": { + "traces": { + "description": "List of trace records returned.", + "type": "array", + "items": { + "$ref": "Trace" + } + }, + "nextPageToken": { + "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.", + "type": "string" + } + }, + "id": "ListTracesResponse" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "Trace": { + "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.", + "type": "object", + "properties": { + "projectId": { + "description": "Project ID of the Cloud project where the trace data is stored.", + "type": "string" + }, + "spans": { + "description": "Collection of spans in the trace.", + "type": "array", + "items": { + "$ref": "TraceSpan" + } + }, + "traceId": { + "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.", + "type": "string" + } + }, + "id": "Trace" + } + }, + "protocol": "rest", + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" + }, + "canonicalName": "Cloud Trace", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/trace.readonly": { + "description": "Read Trace data for a project or application" + }, + "https://www.googleapis.com/auth/trace.append": { + "description": "Write Trace data for a project or application" + } + } + } + }, + "rootUrl": "https://cloudtrace.googleapis.com/", "ownerDomain": "google.com", "name": "cloudtrace", "batchPath": "batch", @@ -54,11 +201,22 @@ "https://www.googleapis.com/auth/trace.readonly" ], "parameters": { - "pageToken": { + "filter": { + "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.", + "type": "string", + "location": "query" + }, + "endTime": { "location": "query", - "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.", + "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.", + "format": "google-datetime", "type": "string" }, + "pageToken": { + "description": "Token identifying the page of results to return. If provided, use the\nvalue of the `next_page_token` field from a previous request. Optional.", + "type": "string", + "location": "query" + }, "startTime": { "location": "query", "description": "Start of the time interval (inclusive) during which the trace data was\ncollected from the application.", @@ -66,21 +224,21 @@ "type": "string" }, "pageSize": { - "location": "query", "description": "Maximum number of traces to return. If not specified or \u003c= 0, the\nimplementation selects a reasonable value. The implementation may\nreturn fewer traces than the requested page size. Optional.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "view": { + "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.", + "type": "string", "location": "query", "enum": [ "VIEW_TYPE_UNSPECIFIED", "MINIMAL", "ROOTSPAN", "COMPLETE" - ], - "description": "Type of data returned for traces in the list. Optional. Default is\n`MINIMAL`.", - "type": "string" + ] }, "orderBy": { "location": "query", @@ -92,17 +250,6 @@ "description": "ID of the Cloud project where the trace data is stored.", "required": true, "type": "string" - }, - "filter": { - "description": "An optional filter against labels for the request.\n\nBy default, searches use prefix matching. To specify exact match, prepend\na plus symbol (`+`) to the search term.\nMultiple terms are ANDed. Syntax:\n\n* `root:NAME_PREFIX` or `NAME_PREFIX`: Return traces where any root\n span starts with `NAME_PREFIX`.\n* `+root:NAME` or `+NAME`: Return traces where any root span's name is\n exactly `NAME`.\n* `span:NAME_PREFIX`: Return traces where any span starts with\n `NAME_PREFIX`.\n* `+span:NAME`: Return traces where any span's name is exactly\n `NAME`.\n* `latency:DURATION`: Return traces whose overall latency is\n greater or equal to than `DURATION`. Accepted units are nanoseconds\n (`ns`), milliseconds (`ms`), and seconds (`s`). Default is `ms`. For\n example, `latency:24ms` returns traces whose overall latency\n is greater than or equal to 24 milliseconds.\n* `label:LABEL_KEY`: Return all traces containing the specified\n label key (exact match, case-sensitive) regardless of the key:value\n pair's value (including empty values).\n* `LABEL_KEY:VALUE_PREFIX`: Return all traces containing the specified\n label key (exact match, case-sensitive) whose value starts with\n `VALUE_PREFIX`. Both a key and a value must be specified.\n* `+LABEL_KEY:VALUE`: Return all traces containing a key:value pair\n exactly matching the specified text. Both a key and a value must be\n specified.\n* `method:VALUE`: Equivalent to `/http/method:VALUE`.\n* `url:VALUE`: Equivalent to `/http/url:VALUE`.", - "type": "string", - "location": "query" - }, - "endTime": { - "description": "End of the time interval (inclusive) during which the trace data was\ncollected from the application.", - "format": "google-datetime", - "type": "string", - "location": "query" } }, "flatPath": "v1/projects/{projectId}/traces", @@ -110,6 +257,8 @@ "id": "cloudtrace.projects.traces.list" }, "get": { + "description": "Gets a single trace by its ID.", + "httpMethod": "GET", "response": { "$ref": "Trace" }, @@ -117,29 +266,27 @@ "projectId", "traceId" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/trace.readonly" - ], "parameters": { - "projectId": { - "description": "ID of the Cloud project where the trace data is stored.", - "required": true, - "type": "string", - "location": "path" - }, "traceId": { "location": "path", "description": "ID of the trace to return.", "required": true, "type": "string" + }, + "projectId": { + "location": "path", + "description": "ID of the Cloud project where the trace data is stored.", + "required": true, + "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/trace.readonly" + ], "flatPath": "v1/projects/{projectId}/traces/{traceId}", - "path": "v1/projects/{projectId}/traces/{traceId}", "id": "cloudtrace.projects.traces.get", - "description": "Gets a single trace by its ID." + "path": "v1/projects/{projectId}/traces/{traceId}" } } } @@ -147,34 +294,6 @@ } }, "parameters": { - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, "alt": { "description": "Data format for response.", "default": "json", @@ -197,9 +316,9 @@ "location": "query" }, "access_token": { - "location": "query", "description": "OAuth access token.", - "type": "string" + "type": "string", + "location": "query" }, "quotaUser": { "location": "query", @@ -212,173 +331,54 @@ "default": "true", "location": "query" }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "prettyPrint": { - "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" } - }, - "version": "v1", - "baseUrl": "https://cloudtrace.googleapis.com/", - "servicePath": "", - "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n", - "kind": "discovery#restDescription", - "basePath": "", - "id": "cloudtrace:v1", - "documentationLink": "https://cloud.google.com/trace", - "revision": "20171214", - "discoveryVersion": "v1", - "version_module": true, - "schemas": { - "Traces": { - "description": "List of new or updated traces.", - "type": "object", - "properties": { - "traces": { - "description": "List of traces.", - "type": "array", - "items": { - "$ref": "Trace" - } - } - }, - "id": "Traces" - }, - "TraceSpan": { - "description": "A span represents a single timed event within a trace. Spans can be nested\nand form a trace tree. Often, a trace contains a root span that describes the\nend-to-end latency of an operation and, optionally, one or more subspans for\nits suboperations. Spans do not need to be contiguous. There may be gaps\nbetween spans in a trace.", - "type": "object", - "properties": { - "parentSpanId": { - "description": "ID of the parent span, if any. Optional.", - "format": "uint64", - "type": "string" - }, - "endTime": { - "description": "End time of the span in nanoseconds from the UNIX epoch.", - "format": "google-datetime", - "type": "string" - }, - "startTime": { - "description": "Start time of the span in nanoseconds from the UNIX epoch.", - "format": "google-datetime", - "type": "string" - }, - "kind": { - "enumDescriptions": [ - "Unspecified.", - "Indicates that the span covers server-side handling of an RPC or other\nremote network request.", - "Indicates that the span covers the client-side wrapper around an RPC or\nother remote request." - ], - "enum": [ - "SPAN_KIND_UNSPECIFIED", - "RPC_SERVER", - "RPC_CLIENT" - ], - "description": "Distinguishes between spans generated in a particular context. For example,\ntwo spans with the same name may be distinguished using `RPC_CLIENT`\nand `RPC_SERVER` to identify queueing latency associated with the span.", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Collection of labels associated with the span. Label keys must be less than\n128 bytes. Label values must be less than 16 kilobytes (10MB for\n`/stacktrace` values).\n\nSome predefined label keys exist, or you may create your own. When creating\nyour own, we recommend the following formats:\n\n* `/category/product/key` for agents of well-known products (e.g.\n `/db/mongodb/read_size`).\n* `short_host/path/key` for domain-specific keys (e.g.\n `foo.com/myproduct/bar`)\n\nPredefined labels include:\n\n* `/agent`\n* `/component`\n* `/error/message`\n* `/error/name`\n* `/http/client_city`\n* `/http/client_country`\n* `/http/client_protocol`\n* `/http/client_region`\n* `/http/host`\n* `/http/method`\n* `/http/redirected_url`\n* `/http/request/size`\n* `/http/response/size`\n* `/http/status_code`\n* `/http/url`\n* `/http/user_agent`\n* `/pid`\n* `/stacktrace`\n* `/tid`", - "type": "object" - }, - "name": { - "description": "Name of the span. Must be less than 128 bytes. The span name is sanitized\nand displayed in the Stackdriver Trace tool in the\n{% dynamic print site_values.console_name %}.\nThe name may be a method name or some other per-call site name.\nFor the same executable and the same call point, a best practice is\nto use a consistent name, which makes it easier to correlate\ncross-trace spans.", - "type": "string" - }, - "spanId": { - "description": "Identifier for the span. Must be a 64-bit integer other than 0 and\nunique within a trace.", - "format": "uint64", - "type": "string" - } - }, - "id": "TraceSpan" - }, - "ListTracesResponse": { - "description": "The response message for the `ListTraces` method.", - "type": "object", - "properties": { - "traces": { - "description": "List of trace records returned.", - "type": "array", - "items": { - "$ref": "Trace" - } - }, - "nextPageToken": { - "description": "If defined, indicates that there are more traces that match the request\nand that this value should be passed to the next request to continue\nretrieving additional traces.", - "type": "string" - } - }, - "id": "ListTracesResponse" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "Trace": { - "description": "A trace describes how long it takes for an application to perform an\noperation. It consists of a set of spans, each of which represent a single\ntimed event within the operation.", - "type": "object", - "properties": { - "projectId": { - "description": "Project ID of the Cloud project where the trace data is stored.", - "type": "string" - }, - "spans": { - "description": "Collection of spans in the trace.", - "type": "array", - "items": { - "$ref": "TraceSpan" - } - }, - "traceId": { - "description": "Globally unique identifier for the trace. This identifier is a 128-bit\nnumeric value formatted as a 32-byte hex string.", - "type": "string" - } - }, - "id": "Trace" - } - }, - "protocol": "rest", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "canonicalName": "Cloud Trace", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/trace.readonly": { - "description": "Read Trace data for a project or application" - }, - "https://www.googleapis.com/auth/trace.append": { - "description": "Write Trace data for a project or application" - } - } - } - }, - "rootUrl": "https://cloudtrace.googleapis.com/" + } }
diff --git a/cloudtrace/v2/cloudtrace-api.json b/cloudtrace/v2/cloudtrace-api.json index 4dd709a..18eb555 100644 --- a/cloudtrace/v2/cloudtrace-api.json +++ b/cloudtrace/v2/cloudtrace-api.json
@@ -1,185 +1,33 @@ { - "resources": { - "projects": { - "resources": { - "traces": { - "methods": { - "batchWrite": { - "request": { - "$ref": "BatchWriteSpansRequest" - }, - "description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Required. The name of the project where the spans belong. The format is\n`projects/[PROJECT_ID]`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/trace.append" - ], - "flatPath": "v2/projects/{projectsId}/traces:batchWrite", - "id": "cloudtrace.projects.traces.batchWrite", - "path": "v2/{+name}/traces:batchWrite" - } - }, - "resources": { - "spans": { - "methods": { - "createSpan": { - "response": { - "$ref": "Span" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/trace.append" - ], - "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}", - "path": "v2/{+name}", - "id": "cloudtrace.projects.traces.spans.createSpan", - "request": { - "$ref": "Span" - }, - "description": "Creates a new span." - } - } - } - } - } - } - } - }, - "parameters": { - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - } - }, - "version": "v2", - "baseUrl": "https://cloudtrace.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n", - "servicePath": "", - "basePath": "", - "revision": "20171214", - "documentationLink": "https://cloud.google.com/trace", "id": "cloudtrace:v2", + "documentationLink": "https://cloud.google.com/trace", + "revision": "20171229", "discoveryVersion": "v1", "version_module": true, "schemas": { - "TimeEvents": { + "StackFrames": { "properties": { - "droppedAnnotationsCount": { - "description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.", + "droppedFramesCount": { + "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.", "format": "int32", "type": "integer" }, + "frame": { + "description": "Stack frames in this call stack.", + "type": "array", + "items": { + "$ref": "StackFrame" + } + } + }, + "id": "StackFrames", + "description": "A collection of stack frames, which can be truncated.", + "type": "object" + }, + "TimeEvents": { + "description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.", + "type": "object", + "properties": { "droppedMessageEventsCount": { "description": "The number of dropped message events in all the included time events.\nIf the value is 0, then no message events were dropped.", "format": "int32", @@ -191,30 +39,31 @@ "items": { "$ref": "TimeEvent" } + }, + "droppedAnnotationsCount": { + "description": "The number of dropped annotations in all the included time events.\nIf the value is 0, then no annotations were dropped.", + "format": "int32", + "type": "integer" } }, - "id": "TimeEvents", - "description": "A collection of `TimeEvent`s. A `TimeEvent` is a time-stamped annotation\non the span, consisting of either user-supplied key:value pairs, or\ndetails of a message sent/received between Spans.", - "type": "object" + "id": "TimeEvents" }, "Module": { "description": "Binary module.", "type": "object", "properties": { "module": { - "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes).", - "$ref": "TruncatableString" + "$ref": "TruncatableString", + "description": "For example: main binary, kernel modules, and dynamic libraries\nsuch as libc.so, sharedlib.so (up to 256 bytes)." }, "buildId": { - "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes).", - "$ref": "TruncatableString" + "$ref": "TruncatableString", + "description": "A unique identifier for the module, usually a hash of its\ncontents (up to 128 bytes)." } }, "id": "Module" }, "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.", - "type": "object", "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.", @@ -237,9 +86,13 @@ "type": "integer" } }, - "id": "Status" + "id": "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.", + "type": "object" }, "BatchWriteSpansRequest": { + "description": "The request message for the `BatchWriteSpans` method.", + "type": "object", "properties": { "spans": { "description": "A list of new spans. The span names must not match existing\nspans, or the results are undefined.", @@ -249,20 +102,20 @@ } } }, - "id": "BatchWriteSpansRequest", - "description": "The request message for the `BatchWriteSpans` method.", - "type": "object" - }, - "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" + "id": "BatchWriteSpansRequest" }, "Span": { "description": "A span represents a single operation within a trace. Spans can be\nnested to form a trace tree. Often, a trace contains a root span\nthat describes the end-to-end latency, and one or more subspans for\nits sub-operations. A trace can also contain multiple root spans,\nor none at all. Spans do not need to be contiguous—there may be\ngaps or overlaps between spans in a trace.", "type": "object", "properties": { + "attributes": { + "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan.", + "$ref": "Attributes" + }, + "spanId": { + "description": "The [SPAN_ID] portion of the span's resource name.", + "type": "string" + }, "childSpanCount": { "description": "An optional number of child spans that were generated while this span\nwas active. If set, allows implementation to detect missing child spans.", "format": "int32", @@ -281,8 +134,8 @@ "type": "string" }, "stackTrace": { - "$ref": "StackTrace", - "description": "Stack trace captured at the start of the span." + "description": "Stack trace captured at the start of the span.", + "$ref": "StackTrace" }, "parentSpanId": { "description": "The [SPAN_ID] of this span's parent span. If this is a root span,\nthen this field must be empty.", @@ -299,28 +152,26 @@ "type": "string" }, "displayName": { - "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces.", - "$ref": "TruncatableString" + "$ref": "TruncatableString", + "description": "A description of the span's operation (up to 128 bytes).\nStackdriver Trace displays the description in the\n{% dynamic print site_values.console_name %}.\nFor example, the display name can be a qualified method name or a file name\nand a line number where the operation is called. A best practice is to use\nthe same display name within an application and at the same call point.\nThis makes it easier to correlate spans in different traces." }, "timeEvents": { "$ref": "TimeEvents", "description": "A set of time events. You can have up to 32 annotations and 128 message\nevents per span." }, "links": { - "description": "Links associated with the span. You can have up to 128 links per Span.", - "$ref": "Links" - }, - "attributes": { - "$ref": "Attributes", - "description": "A set of attributes on the span. You can have up to 32 attributes per\nspan." - }, - "spanId": { - "description": "The [SPAN_ID] portion of the span's resource name.", - "type": "string" + "$ref": "Links", + "description": "Links associated with the span. You can have up to 128 links per Span." } }, "id": "Span" }, + "Empty": { + "properties": {}, + "id": "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 `{}`.", + "type": "object" + }, "AttributeValue": { "description": "The allowed types for [VALUE] in a `[KEY]:[VALUE]` attribute.", "type": "object", @@ -331,8 +182,8 @@ "type": "string" }, "stringValue": { - "$ref": "TruncatableString", - "description": "A string up to 256 bytes long." + "description": "A string up to 256 bytes long.", + "$ref": "TruncatableString" }, "boolValue": { "description": "A Boolean value represented by `true` or `false`.", @@ -361,6 +212,8 @@ "id": "Attributes" }, "Links": { + "description": "A collection of links, which are references from this span to a span\nin the same or different trace.", + "type": "object", "properties": { "droppedLinksCount": { "description": "The number of dropped links after the maximum size was enforced. If\nthis value is 0, then no links were dropped.", @@ -375,17 +228,31 @@ } } }, - "id": "Links", - "description": "A collection of links, which are references from this span to a span\nin the same or different trace.", - "type": "object" + "id": "Links" + }, + "TruncatableString": { + "description": "Represents a string that might be shortened to a specified length.", + "type": "object", + "properties": { + "truncatedByteCount": { + "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.", + "format": "int32", + "type": "integer" + }, + "value": { + "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.", + "type": "string" + } + }, + "id": "TruncatableString" }, "StackTrace": { "description": "A call stack appearing in a trace.", "type": "object", "properties": { "stackFrames": { - "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed.", - "$ref": "StackFrames" + "$ref": "StackFrames", + "description": "Stack frames in this stack trace. A maximum of 128 frames are allowed." }, "stackTraceHashId": { "description": "The hash ID is used to conserve network bandwidth for duplicate\nstack traces within a single trace.\n\nOften multiple spans will have identical stack traces.\nThe first occurrence of a stack trace should contain both the\n`stackFrame` content and a value in `stackTraceHashId`.\n\nSubsequent spans within the same request can refer\nto that stack trace by only setting `stackTraceHashId`.", @@ -395,59 +262,46 @@ }, "id": "StackTrace" }, - "TruncatableString": { - "properties": { - "value": { - "description": "The shortened string. For example, if the original string is 500\nbytes long and the limit of the string is 128 bytes, then\n`value` contains the first 128 bytes of the 500-byte string.\n\nTruncation always happens on a UTF8 character boundary. If there\nare multi-byte characters in the string, then the length of the\nshortened string might be less than the size limit.", - "type": "string" - }, - "truncatedByteCount": { - "description": "The number of bytes removed from the original string. If this\nvalue is 0, then the string was not shortened.", - "format": "int32", - "type": "integer" - } - }, - "id": "TruncatableString", - "description": "Represents a string that might be shortened to a specified length.", - "type": "object" - }, "TimeEvent": { + "description": "A time-stamped annotation or message event in the Span.", + "type": "object", "properties": { - "annotation": { - "description": "Text annotation with a set of attributes.", - "$ref": "Annotation" - }, - "messageEvent": { - "description": "An event describing a message sent/received between Spans.", - "$ref": "MessageEvent" - }, "time": { "description": "The timestamp indicating the time the event occurred.", "format": "google-datetime", "type": "string" + }, + "annotation": { + "$ref": "Annotation", + "description": "Text annotation with a set of attributes." + }, + "messageEvent": { + "description": "An event describing a message sent/received between Spans.", + "$ref": "MessageEvent" } }, - "id": "TimeEvent", - "description": "A time-stamped annotation or message event in the Span.", - "type": "object" + "id": "TimeEvent" }, "MessageEvent": { - "description": "An event describing a message sent/received between Spans.", - "type": "object", "properties": { + "uncompressedSizeBytes": { + "description": "The number of uncompressed bytes sent or received.", + "format": "int64", + "type": "string" + }, "type": { + "enumDescriptions": [ + "Unknown event type.", + "Indicates a sent message.", + "Indicates a received message." + ], "enum": [ "TYPE_UNSPECIFIED", "SENT", "RECEIVED" ], "description": "Type of MessageEvent. Indicates whether the message was sent or\nreceived.", - "type": "string", - "enumDescriptions": [ - "Unknown event type.", - "Indicates a sent message.", - "Indicates a received message." - ] + "type": "string" }, "id": { "description": "An identifier for the MessageEvent's message that can be used to match\nSENT and RECEIVED MessageEvents. It is recommended to be unique within\na Span.", @@ -458,22 +312,31 @@ "description": "The number of compressed bytes sent or received. If missing assumed to\nbe the same size as uncompressed.", "format": "int64", "type": "string" - }, - "uncompressedSizeBytes": { - "description": "The number of uncompressed bytes sent or received.", - "format": "int64", - "type": "string" } }, - "id": "MessageEvent" + "id": "MessageEvent", + "description": "An event describing a message sent/received between Spans.", + "type": "object" }, "StackFrame": { "description": "Represents a single stack frame in a stack trace.", "type": "object", "properties": { - "functionName": { + "fileName": { "$ref": "TruncatableString", - "description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes)." + "description": "The name of the source file where the function call appears (up to 256\nbytes)." + }, + "sourceVersion": { + "description": "The version of the deployed source code (up to 128 bytes).", + "$ref": "TruncatableString" + }, + "originalFunctionName": { + "$ref": "TruncatableString", + "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)." + }, + "functionName": { + "description": "The fully-qualified name that uniquely identifies the function or\nmethod that is active in this frame (up to 1024 bytes).", + "$ref": "TruncatableString" }, "lineNumber": { "description": "The line number in `file_name` where the function call appears.", @@ -488,25 +351,11 @@ "description": "The column number where the function call appears, if available.\nThis is important in JavaScript because of its anonymous functions.", "format": "int64", "type": "string" - }, - "fileName": { - "description": "The name of the source file where the function call appears (up to 256\nbytes).", - "$ref": "TruncatableString" - }, - "sourceVersion": { - "$ref": "TruncatableString", - "description": "The version of the deployed source code (up to 128 bytes)." - }, - "originalFunctionName": { - "$ref": "TruncatableString", - "description": "An un-mangled function name, if `function_name` is\n[mangled](http://www.avabodh.com/cxxin/namemangling.html). The name can\nbe fully-qualified (up to 1024 bytes)." } }, "id": "StackFrame" }, "Link": { - "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.", - "type": "object", "properties": { "traceId": { "description": "The [TRACE_ID] for a trace within a project.", @@ -521,55 +370,38 @@ "type": "string" }, "type": { - "enum": [ - "TYPE_UNSPECIFIED", - "CHILD_LINKED_SPAN", - "PARENT_LINKED_SPAN" - ], "description": "The relationship of the current span relative to the linked span.", "type": "string", "enumDescriptions": [ "The relationship of the two spans is unknown.", "The linked span is a child of the current span.", "The linked span is a parent of the current span." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "CHILD_LINKED_SPAN", + "PARENT_LINKED_SPAN" ] } }, - "id": "Link" + "id": "Link", + "description": "A pointer from the current span to another span in the same trace or in a\ndifferent trace. For example, this can be used in batching operations,\nwhere a single batch handler processes multiple requests from different\ntraces or when the handler receives a request from a different project.", + "type": "object" }, "Annotation": { + "description": "Text annotation with a set of attributes.", + "type": "object", "properties": { "description": { - "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes.", - "$ref": "TruncatableString" + "$ref": "TruncatableString", + "description": "A user-supplied message describing the event. The maximum length for\nthe description is 256 bytes." }, "attributes": { "$ref": "Attributes", "description": "A set of attributes on the annotation. You can have up to 4 attributes\nper Annotation." } }, - "id": "Annotation", - "description": "Text annotation with a set of attributes.", - "type": "object" - }, - "StackFrames": { - "description": "A collection of stack frames, which can be truncated.", - "type": "object", - "properties": { - "droppedFramesCount": { - "description": "The number of stack frames that were dropped because there\nwere too many stack frames.\nIf this value is 0, then no stack frames were dropped.", - "format": "int32", - "type": "integer" - }, - "frame": { - "description": "Stack frames in this call stack.", - "type": "array", - "items": { - "$ref": "StackFrame" - } - } - }, - "id": "StackFrames" + "id": "Annotation" } }, "protocol": "rest", @@ -596,5 +428,173 @@ "batchPath": "batch", "fullyEncodeReservedExpansion": true, "title": "Stackdriver Trace API", - "ownerName": "Google" + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "traces": { + "methods": { + "batchWrite": { + "request": { + "$ref": "BatchWriteSpansRequest" + }, + "description": "Sends new spans to new or existing traces. You cannot update\nexisting spans.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The name of the project where the spans belong. The format is\n`projects/[PROJECT_ID]`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/trace.append" + ], + "flatPath": "v2/projects/{projectsId}/traces:batchWrite", + "path": "v2/{+name}/traces:batchWrite", + "id": "cloudtrace.projects.traces.batchWrite" + } + }, + "resources": { + "spans": { + "methods": { + "createSpan": { + "flatPath": "v2/projects/{projectsId}/traces/{tracesId}/spans/{spansId}", + "id": "cloudtrace.projects.traces.spans.createSpan", + "path": "v2/{+name}", + "request": { + "$ref": "Span" + }, + "description": "Creates a new span.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Span" + }, + "parameters": { + "name": { + "description": "The resource name of the span in the following format:\n\n projects/[PROJECT_ID]/traces/[TRACE_ID]/spans/SPAN_ID is a unique identifier for a trace within a project;\nit is a 32-character hexadecimal encoding of a 16-byte array.\n\n[SPAN_ID] is a unique identifier for a span within a trace; it\nis a 16-character hexadecimal encoding of an 8-byte array.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/traces/[^/]+/spans/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/trace.append" + ] + } + } + } + } + } + } + } + }, + "parameters": { + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + } + }, + "version": "v2", + "baseUrl": "https://cloudtrace.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Sends application trace data to Stackdriver Trace for viewing. Trace data is collected for all App Engine applications by default. Trace data from other applications can be provided using this API.\n", + "servicePath": "", + "basePath": "" }
diff --git a/container/v1/container-api.json b/container/v1/container-api.json index 2275fd2..045fa19 100644 --- a/container/v1/container-api.json +++ b/container/v1/container-api.json
@@ -1,1347 +1,4 @@ { - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Container Engine API", - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "zones": { - "methods": { - "getServerconfig": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig", - "path": "v1/projects/{projectId}/zones/{zone}/serverconfig", - "id": "container.projects.zones.getServerconfig", - "description": "Returns configuration info about the Kubernetes Engine service.", - "response": { - "$ref": "ServerConfig" - }, - "parameterOrder": [ - "projectId", - "zone" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "clusters": { - "methods": { - "get": { - "description": "Gets the details of a specific cluster.", - "response": { - "$ref": "Cluster" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to retrieve.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "id": "container.projects.zones.clusters.get" - }, - "legacyAbac": { - "request": { - "$ref": "SetLegacyAbacRequest" - }, - "description": "Enables or disables the ABAC authorization mechanism on a cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to update.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", - "id": "container.projects.zones.clusters.legacyAbac" - }, - "setNetworkPolicy": { - "request": { - "$ref": "SetNetworkPolicyRequest" - }, - "description": "Enables/Disables Network Policy for a cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", - "id": "container.projects.zones.clusters.setNetworkPolicy" - }, - "startIpRotation": { - "request": { - "$ref": "StartIPRotationRequest" - }, - "description": "Start master IP rotation.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", - "id": "container.projects.zones.clusters.startIpRotation" - }, - "addons": { - "description": "Sets the addons of a specific cluster.", - "request": { - "$ref": "SetAddonsConfigRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", - "id": "container.projects.zones.clusters.addons" - }, - "setMaintenancePolicy": { - "request": { - "$ref": "SetMaintenancePolicyRequest" - }, - "description": "Sets the maintenance policy for a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to update.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", - "id": "container.projects.zones.clusters.setMaintenancePolicy", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy" - }, - "delete": { - "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "DELETE", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to delete.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "id": "container.projects.zones.clusters.delete" - }, - "locations": { - "request": { - "$ref": "SetLocationsRequest" - }, - "description": "Sets the locations of a specific cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", - "id": "container.projects.zones.clusters.locations", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations" - }, - "update": { - "request": { - "$ref": "UpdateClusterRequest" - }, - "description": "Updates the settings of a specific cluster.", - "httpMethod": "PUT", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "id": "container.projects.zones.clusters.update", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}" - }, - "monitoring": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", - "id": "container.projects.zones.clusters.monitoring", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", - "request": { - "$ref": "SetMonitoringServiceRequest" - }, - "description": "Sets the monitoring service of a specific cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "master": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", - "id": "container.projects.zones.clusters.master", - "description": "Updates the master of a specific cluster.", - "request": { - "$ref": "UpdateMasterRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "setMasterAuth": { - "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set the password.", - "request": { - "$ref": "SetMasterAuthRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", - "id": "container.projects.zones.clusters.setMasterAuth" - }, - "logging": { - "request": { - "$ref": "SetLoggingServiceRequest" - }, - "description": "Sets the logging service of a specific cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", - "id": "container.projects.zones.clusters.logging", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging" - }, - "list": { - "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "zone" - ], - "response": { - "$ref": "ListClustersResponse" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", - "id": "container.projects.zones.clusters.list", - "path": "v1/projects/{projectId}/zones/{zone}/clusters" - }, - "resourceLabels": { - "description": "Sets labels on a cluster.", - "request": { - "$ref": "SetLabelsRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", - "id": "container.projects.zones.clusters.resourceLabels" - }, - "create": { - "request": { - "$ref": "CreateClusterRequest" - }, - "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", - "path": "v1/projects/{projectId}/zones/{zone}/clusters", - "id": "container.projects.zones.clusters.create" - }, - "completeIpRotation": { - "description": "Completes master IP rotation.", - "request": { - "$ref": "CompleteIPRotationRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", - "id": "container.projects.zones.clusters.completeIpRotation" - } - }, - "resources": { - "nodePools": { - "methods": { - "delete": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "id": "container.projects.zones.clusters.nodePools.delete", - "description": "Deletes a node pool from a cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "DELETE", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.", - "required": true, - "type": "string", - "location": "path" - }, - "nodePoolId": { - "location": "path", - "description": "The name of the node pool to delete.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setManagement": { - "request": { - "$ref": "SetNodePoolManagementRequest" - }, - "description": "Sets the NodeManagement options for a node pool.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to update.", - "required": true, - "type": "string" - }, - "nodePoolId": { - "description": "The name of the node pool to update.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", - "id": "container.projects.zones.clusters.nodePools.setManagement" - }, - "setSize": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to update.", - "required": true, - "type": "string", - "location": "path" - }, - "nodePoolId": { - "description": "The name of the node pool to update.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", - "id": "container.projects.zones.clusters.nodePools.setSize", - "request": { - "$ref": "SetNodePoolSizeRequest" - }, - "description": "Sets the size of a specific node pool." - }, - "list": { - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "ListNodePoolsResponse" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "id": "container.projects.zones.clusters.nodePools.list", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "description": "Lists the node pools for a cluster." - }, - "rollback": { - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to rollback.", - "required": true, - "type": "string", - "location": "path" - }, - "nodePoolId": { - "location": "path", - "description": "The name of the node pool to rollback.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", - "id": "container.projects.zones.clusters.nodePools.rollback", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", - "request": { - "$ref": "RollbackNodePoolUpgradeRequest" - }, - "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed." - }, - "create": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "id": "container.projects.zones.clusters.nodePools.create", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "request": { - "$ref": "CreateNodePoolRequest" - }, - "description": "Creates a node pool for a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "autoscaling": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", - "id": "container.projects.zones.clusters.nodePools.autoscaling", - "description": "Sets the autoscaling settings of a specific node pool.", - "request": { - "$ref": "SetNodePoolAutoscalingRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "nodePoolId": { - "description": "The name of the node pool to upgrade.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "get": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "id": "container.projects.zones.clusters.nodePools.get", - "description": "Retrieves the node pool requested.", - "response": { - "$ref": "NodePool" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.", - "required": true, - "type": "string", - "location": "path" - }, - "nodePoolId": { - "description": "The name of the node pool.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "update": { - "request": { - "$ref": "UpdateNodePoolRequest" - }, - "description": "Updates the version and/or image type of a specific node pool.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "POST", - "parameters": { - "nodePoolId": { - "description": "The name of the node pool to upgrade.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", - "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", - "id": "container.projects.zones.clusters.nodePools.update" - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "request": { - "$ref": "CancelOperationRequest" - }, - "description": "Cancels the specified operation.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "operationId" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "operationId": { - "description": "The server-assigned `name` of the operation.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", - "id": "container.projects.zones.operations.cancel", - "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel" - }, - "list": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/operations", - "id": "container.projects.zones.operations.list", - "path": "v1/projects/{projectId}/zones/{zone}/operations", - "description": "Lists all operations in a project in a specific zone or all zones.", - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "zone" - ], - "response": { - "$ref": "ListOperationsResponse" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}", - "id": "container.projects.zones.operations.get", - "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}", - "description": "Gets the specified operation.", - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "zone", - "operationId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "operationId": { - "description": "The server-assigned `name` of the operation.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - }, - "parameters": { - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - } - }, - "version": "v1", "baseUrl": "https://container.googleapis.com/", "kind": "discovery#restDescription", "description": "The Google Kubernetes Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.", @@ -1352,320 +9,13 @@ "documentationLink": "https://cloud.google.com/container-engine/", "discoveryVersion": "v1", "schemas": { - "AutoUpgradeOptions": { - "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.", - "type": "object", - "properties": { - "description": { - "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.", - "type": "string" - }, - "autoUpgradeStartTime": { - "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", - "type": "string" - } - }, - "id": "AutoUpgradeOptions" - }, - "ListClustersResponse": { - "description": "ListClustersResponse is the result of ListClustersRequest.", - "type": "object", - "properties": { - "missingZones": { - "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.", - "type": "array", - "items": { - "type": "string" - } - }, - "clusters": { - "description": "A list of clusters in the project in the specified zone, or\nacross all ones.", - "type": "array", - "items": { - "$ref": "Cluster" - } - } - }, - "id": "ListClustersResponse" - }, - "HttpLoadBalancing": { - "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.", - "type": "object", - "properties": { - "disabled": { - "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.", - "type": "boolean" - } - }, - "id": "HttpLoadBalancing" - }, - "SetMasterAuthRequest": { - "description": "SetMasterAuthRequest updates the admin password of a cluster.", - "type": "object", - "properties": { - "update": { - "description": "A description of the update.", - "$ref": "MasterAuth" - }, - "action": { - "description": "The exact form of action to be taken on the master auth.", - "type": "string", - "enumDescriptions": [ - "Operation is unknown and will error out.", - "Set the password to a user generated value.", - "Generate a new password and set it to that.", - "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none." - ], - "enum": [ - "UNKNOWN", - "SET_PASSWORD", - "GENERATE_PASSWORD", - "SET_USERNAME" - ] - } - }, - "id": "SetMasterAuthRequest" - }, - "SetNetworkPolicyRequest": { - "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.", - "type": "object", - "properties": { - "networkPolicy": { - "description": "Configuration options for the NetworkPolicy feature.", - "$ref": "NetworkPolicy" - } - }, - "id": "SetNetworkPolicyRequest" - }, - "NodePoolAutoscaling": { - "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.", - "type": "object", - "properties": { - "maxNodeCount": { - "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.", - "format": "int32", - "type": "integer" - }, - "minNodeCount": { - "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.", - "format": "int32", - "type": "integer" - }, - "enabled": { - "description": "Is autoscaling enabled for this node pool.", - "type": "boolean" - } - }, - "id": "NodePoolAutoscaling" - }, - "ClusterUpdate": { - "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.", - "type": "object", - "properties": { - "desiredImageType": { - "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.", - "type": "string" - }, - "desiredAddonsConfig": { - "$ref": "AddonsConfig", - "description": "Configurations for the various addons available to run in the cluster." - }, - "desiredNodePoolId": { - "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.", - "type": "string" - }, - "desiredNodeVersion": { - "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.", - "type": "string" - }, - "desiredMasterVersion": { - "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.", - "type": "string" - }, - "desiredMasterAuthorizedNetworksConfig": { - "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.", - "$ref": "MasterAuthorizedNetworksConfig" - }, - "desiredLocations": { - "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.", - "type": "array", - "items": { - "type": "string" - } - }, - "desiredNodePoolAutoscaling": { - "$ref": "NodePoolAutoscaling", - "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool." - }, - "desiredMonitoringService": { - "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster", - "type": "string" - } - }, - "id": "ClusterUpdate" - }, - "IPAllocationPolicy": { - "description": "Configuration for controlling how IPs are allocated in the cluster.", - "type": "object", - "properties": { - "servicesIpv4CidrBlock": { - "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", - "type": "string" - }, - "subnetworkName": { - "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.", - "type": "string" - }, - "clusterIpv4Cidr": { - "description": "This field is deprecated, use cluster_ipv4_cidr_block.", - "type": "string" - }, - "nodeIpv4Cidr": { - "description": "This field is deprecated, use node_ipv4_cidr_block.", - "type": "string" - }, - "clusterSecondaryRangeName": { - "description": "The name of the secondary range to be used for the cluster CIDR\nblock. The secondary range will be used for pod IP\naddresses. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.", - "type": "string" - }, - "clusterIpv4CidrBlock": { - "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", - "type": "string" - }, - "nodeIpv4CidrBlock": { - "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", - "type": "string" - }, - "servicesIpv4Cidr": { - "description": "This field is deprecated, use services_ipv4_cidr_block.", - "type": "string" - }, - "servicesSecondaryRangeName": { - "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.", - "type": "string" - }, - "useIpAliases": { - "description": "Whether alias IPs will be used for pod IPs in the cluster.", - "type": "boolean" - }, - "createSubnetwork": { - "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.", - "type": "boolean" - } - }, - "id": "IPAllocationPolicy" - }, - "HorizontalPodAutoscaling": { - "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.", - "type": "object", - "properties": { - "disabled": { - "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.", - "type": "boolean" - } - }, - "id": "HorizontalPodAutoscaling" - }, - "SetNodePoolManagementRequest": { - "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.", - "type": "object", - "properties": { - "management": { - "description": "NodeManagement configuration for the node pool.", - "$ref": "NodeManagement" - } - }, - "id": "SetNodePoolManagementRequest" - }, - "MasterAuthorizedNetworksConfig": { - "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.", - "type": "object", - "properties": { - "enabled": { - "description": "Whether or not master authorized networks is enabled.", - "type": "boolean" - }, - "cidrBlocks": { - "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.", - "type": "array", - "items": { - "$ref": "CidrBlock" - } - } - }, - "id": "MasterAuthorizedNetworksConfig" - }, - "SetNodePoolAutoscalingRequest": { - "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.", - "type": "object", - "properties": { - "autoscaling": { - "$ref": "NodePoolAutoscaling", - "description": "Autoscaling configuration for the node pool." - } - }, - "id": "SetNodePoolAutoscalingRequest" - }, - "CreateClusterRequest": { - "description": "CreateClusterRequest creates a cluster.", - "type": "object", - "properties": { - "cluster": { - "$ref": "Cluster", - "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)" - } - }, - "id": "CreateClusterRequest" - }, - "LegacyAbac": { - "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.", - "type": "object", - "properties": { - "enabled": { - "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.", - "type": "boolean" - } - }, - "id": "LegacyAbac" - }, - "AcceleratorConfig": { - "description": "AcceleratorConfig represents a Hardware Accelerator request.", - "type": "object", - "properties": { - "acceleratorCount": { - "description": "The number of the accelerator cards exposed to an instance.", - "format": "int64", - "type": "string" - }, - "acceleratorType": { - "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)", - "type": "string" - } - }, - "id": "AcceleratorConfig" - }, - "UpdateNodePoolRequest": { - "description": "UpdateNodePoolRequests update a node pool's image and/or version.", - "type": "object", - "properties": { - "imageType": { - "description": "The desired image type for the node pool.", - "type": "string" - }, - "nodeVersion": { - "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.", - "type": "string" - } - }, - "id": "UpdateNodePoolRequest" - }, "SetAddonsConfigRequest": { "description": "SetAddonsConfigRequest sets the addons associated with the cluster.", "type": "object", "properties": { "addonsConfig": { - "description": "The desired configurations for the various addons available to run in the\ncluster.", - "$ref": "AddonsConfig" + "$ref": "AddonsConfig", + "description": "The desired configurations for the various addons available to run in the\ncluster." } }, "id": "SetAddonsConfigRequest" @@ -1685,21 +35,21 @@ "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.", "type": "object", "properties": { - "kubernetesDashboard": { - "$ref": "KubernetesDashboard", - "description": "Configuration for the Kubernetes Dashboard." - }, - "networkPolicyConfig": { - "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.", - "$ref": "NetworkPolicyConfig" - }, "horizontalPodAutoscaling": { - "$ref": "HorizontalPodAutoscaling", - "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods." + "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.", + "$ref": "HorizontalPodAutoscaling" }, "httpLoadBalancing": { - "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.", - "$ref": "HttpLoadBalancing" + "$ref": "HttpLoadBalancing", + "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster." + }, + "kubernetesDashboard": { + "description": "Configuration for the Kubernetes Dashboard.", + "$ref": "KubernetesDashboard" + }, + "networkPolicyConfig": { + "$ref": "NetworkPolicyConfig", + "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes." } }, "id": "AddonsConfig" @@ -1735,8 +85,8 @@ "type": "object", "properties": { "update": { - "$ref": "ClusterUpdate", - "description": "A description of the update." + "description": "A description of the update.", + "$ref": "ClusterUpdate" } }, "id": "UpdateClusterRequest" @@ -1756,81 +106,6 @@ "description": "A Google Kubernetes Engine cluster.", "type": "object", "properties": { - "masterAuth": { - "description": "The authentication information for accessing the master endpoint.", - "$ref": "MasterAuth" - }, - "currentMasterVersion": { - "description": "[Output only] The current software version of the master endpoint.", - "type": "string" - }, - "nodeConfig": { - "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used.", - "$ref": "NodeConfig" - }, - "addonsConfig": { - "$ref": "AddonsConfig", - "description": "Configurations for the various addons available to run in the cluster." - }, - "status": { - "description": "[Output only] The current status of this cluster.", - "type": "string", - "enumDescriptions": [ - "Not set.", - "The PROVISIONING state indicates the cluster is being created.", - "The RUNNING state indicates the cluster has been created and is fully\nusable.", - "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.", - "The STOPPING state indicates the cluster is being deleted.", - "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "PROVISIONING", - "RUNNING", - "RECONCILING", - "STOPPING", - "ERROR" - ] - }, - "subnetwork": { - "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.", - "type": "string" - }, - "currentNodeVersion": { - "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.", - "type": "string" - }, - "maintenancePolicy": { - "$ref": "MaintenancePolicy", - "description": "Configure the maintenance policy for this cluster." - }, - "resourceLabels": { - "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "name": { - "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.", - "type": "string" - }, - "initialClusterVersion": { - "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.", - "type": "string" - }, - "ipAllocationPolicy": { - "description": "Configuration for cluster IP allocation.", - "$ref": "IPAllocationPolicy" - }, - "endpoint": { - "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.", - "type": "string" - }, - "legacyAbac": { - "description": "Configuration for the legacy ABAC authorization mode.", - "$ref": "LegacyAbac" - }, "createTime": { "description": "[Output only] The time the cluster was created, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" @@ -1844,12 +119,9 @@ "format": "int32", "type": "integer" }, - "nodePools": { - "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.", - "type": "array", - "items": { - "$ref": "NodePool" - } + "selfLink": { + "description": "[Output only] Server-defined URL for the resource.", + "type": "string" }, "locations": { "description": "The list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located.", @@ -1858,9 +130,12 @@ "type": "string" } }, - "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", - "type": "string" + "nodePools": { + "description": "The node pools associated with this cluster.\nThis field should not be set if \"node_config\" or \"initial_node_count\" are\nspecified.", + "type": "array", + "items": { + "$ref": "NodePool" + } }, "instanceGroupUrls": { "description": "Deprecated. Use node_pools.instance_group_urls.", @@ -1869,14 +144,14 @@ "type": "string" } }, + "networkPolicy": { + "$ref": "NetworkPolicy", + "description": "Configuration options for the NetworkPolicy feature." + }, "servicesIpv4Cidr": { "description": "[Output only] The IP address range of the Kubernetes services in\nthis cluster, in\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `1.2.3.4/29`). Service addresses are\ntypically put in the last `/16` from the container CIDR.", "type": "string" }, - "networkPolicy": { - "description": "Configuration options for the NetworkPolicy feature.", - "$ref": "NetworkPolicy" - }, "enableKubernetesAlpha": { "description": "Kubernetes alpha features are enabled on this cluster. This includes alpha\nAPI groups (e.g. v1alpha1) and features that may not be production ready in\nthe kubernetes version of the master and nodes.\nThe cluster has no SLA for uptime and master/node upgrades are disabled.\nAlpha enabled clusters are automatically deleted thirty days after\ncreation.", "type": "boolean" @@ -1910,22 +185,97 @@ "description": "The logging service the cluster should use to write logs.\nCurrently available options:\n\n* `logging.googleapis.com` - the Google Cloud Logging service.\n* `none` - no logs will be exported from the cluster.\n* if left as an empty string,`logging.googleapis.com` will be used.", "type": "string" }, + "expireTime": { + "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "type": "string" + }, "nodeIpv4CidrSize": { "description": "[Output only] The size of the address space on each node for hosting\ncontainers. This is provisioned from within the `container_ipv4_cidr`\nrange.", "format": "int32", "type": "integer" }, - "expireTime": { - "description": "[Output only] The time the cluster will be automatically\ndeleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", - "type": "string" - }, "masterAuthorizedNetworksConfig": { - "description": "Master authorized networks is a Beta feature.\nThe configuration options for master authorized networks feature.", - "$ref": "MasterAuthorizedNetworksConfig" + "$ref": "MasterAuthorizedNetworksConfig", + "description": "Master authorized networks is a Beta feature.\nThe configuration options for master authorized networks feature." }, "statusMessage": { "description": "[Output only] Additional information about the current status of this\ncluster, if available.", "type": "string" + }, + "masterAuth": { + "description": "The authentication information for accessing the master endpoint.", + "$ref": "MasterAuth" + }, + "currentMasterVersion": { + "description": "[Output only] The current software version of the master endpoint.", + "type": "string" + }, + "nodeConfig": { + "$ref": "NodeConfig", + "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used." + }, + "addonsConfig": { + "description": "Configurations for the various addons available to run in the cluster.", + "$ref": "AddonsConfig" + }, + "status": { + "description": "[Output only] The current status of this cluster.", + "type": "string", + "enumDescriptions": [ + "Not set.", + "The PROVISIONING state indicates the cluster is being created.", + "The RUNNING state indicates the cluster has been created and is fully\nusable.", + "The RECONCILING state indicates that some work is actively being done on\nthe cluster, such as upgrading the master or node software. Details can\nbe found in the `statusMessage` field.", + "The STOPPING state indicates the cluster is being deleted.", + "The ERROR state indicates the cluster may be unusable. Details\ncan be found in the `statusMessage` field." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "PROVISIONING", + "RUNNING", + "RECONCILING", + "STOPPING", + "ERROR" + ] + }, + "currentNodeVersion": { + "description": "[Output only] The current version of the node software components.\nIf they are currently at multiple versions because they're in the process\nof being upgraded, this reflects the minimum version of all nodes.", + "type": "string" + }, + "subnetwork": { + "description": "The name of the Google Compute Engine\n[subnetwork](/compute/docs/subnetworks) to which the\ncluster is connected.", + "type": "string" + }, + "name": { + "description": "The name of this cluster. The name must be unique within this project\nand zone, and can be up to 40 characters with the following restrictions:\n\n* Lowercase letters, numbers, and hyphens only.\n* Must start with a letter.\n* Must end with a number or a letter.", + "type": "string" + }, + "resourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The resource labels for the cluster to use to annotate any related\nGoogle Compute Engine resources.", + "type": "object" + }, + "maintenancePolicy": { + "description": "Configure the maintenance policy for this cluster.", + "$ref": "MaintenancePolicy" + }, + "initialClusterVersion": { + "description": "The initial Kubernetes version for this cluster. Valid versions are those\nfound in validMasterVersions returned by getServerConfig. The version can\nbe upgraded over time; such upgrades are reflected in\ncurrentMasterVersion and currentNodeVersion.", + "type": "string" + }, + "ipAllocationPolicy": { + "$ref": "IPAllocationPolicy", + "description": "Configuration for cluster IP allocation." + }, + "endpoint": { + "description": "[Output only] The IP address of this cluster's master endpoint.\nThe endpoint can be accessed from the internet at\n`https://username:password@endpoint/`.\n\nSee the `masterAuth` property of this resource for username and\npassword information.", + "type": "string" + }, + "legacyAbac": { + "$ref": "LegacyAbac", + "description": "Configuration for the legacy ABAC authorization mode." } }, "id": "Cluster" @@ -1945,10 +295,6 @@ "description": "The authentication information for accessing the master endpoint.\nAuthentication can be done using HTTP basic auth or using client\ncertificates.", "type": "object", "properties": { - "clientKey": { - "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.", - "type": "string" - }, "clusterCaCertificate": { "description": "[Output only] Base64-encoded public certificate that is the root of\ntrust for the cluster.", "type": "string" @@ -1968,6 +314,10 @@ "clientCertificateConfig": { "description": "Configuration for client certificate authentication on the cluster. If no\nconfiguration is specified, a client certificate is issued.", "$ref": "ClientCertificateConfig" + }, + "clientKey": { + "description": "[Output only] Base64-encoded private key used by clients to authenticate\nto the cluster endpoint.", + "type": "string" } }, "id": "MasterAuth" @@ -2003,8 +353,8 @@ "type": "object", "properties": { "window": { - "$ref": "MaintenanceWindow", - "description": "Specifies the maintenance window in which maintenance may be performed." + "description": "Specifies the maintenance window in which maintenance may be performed.", + "$ref": "MaintenanceWindow" } }, "id": "MaintenancePolicy" @@ -2025,8 +375,8 @@ "type": "object", "properties": { "maintenancePolicy": { - "$ref": "MaintenancePolicy", - "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy." + "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.", + "$ref": "MaintenancePolicy" } }, "id": "SetMaintenancePolicyRequest" @@ -2093,17 +443,17 @@ "description": "The node configuration of the pool.", "$ref": "NodeConfig" }, - "statusMessage": { - "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.", - "type": "string" - }, "name": { "description": "The name of the node pool.", "type": "string" }, + "statusMessage": { + "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.", + "type": "string" + }, "autoscaling": { - "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.", - "$ref": "NodePoolAutoscaling" + "$ref": "NodePoolAutoscaling", + "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present." }, "initialNodeCount": { "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.", @@ -2111,23 +461,23 @@ "type": "integer" }, "management": { - "$ref": "NodeManagement", - "description": "NodeManagement configuration for this NodePool." + "description": "NodeManagement configuration for this NodePool.", + "$ref": "NodeManagement" }, "selfLink": { "description": "[Output only] Server-defined URL for the resource.", "type": "string" }, - "version": { - "description": "The version of the Kubernetes of this node.", - "type": "string" - }, "instanceGroupUrls": { "description": "[Output only] The resource URLs of the [managed instance\ngroups](/compute/docs/instance-groups/creating-groups-of-managed-instances)\nassociated with this node pool.", "type": "array", "items": { "type": "string" } + }, + "version": { + "description": "The version of the Kubernetes of this node.", + "type": "string" } }, "id": "NodePool" @@ -2136,16 +486,16 @@ "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster", "type": "object", "properties": { + "labelFingerprint": { + "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.", + "type": "string" + }, "resourceLabels": { "additionalProperties": { "type": "string" }, "description": "The labels to set for that cluster.", "type": "object" - }, - "labelFingerprint": { - "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.", - "type": "string" } }, "id": "SetLabelsRequest" @@ -2163,8 +513,8 @@ "type": "boolean" }, "upgradeOptions": { - "$ref": "AutoUpgradeOptions", - "description": "Specifies the Auto Upgrade knobs for the node pool." + "description": "Specifies the Auto Upgrade knobs for the node pool.", + "$ref": "AutoUpgradeOptions" } }, "id": "NodeManagement" @@ -2190,6 +540,40 @@ "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.", "type": "object", "properties": { + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.", + "type": "string" + }, + "status": { + "description": "The current status of the operation.", + "type": "string", + "enumDescriptions": [ + "Not set.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed.", + "The operation is aborting." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE", + "ABORTING" + ] + }, + "name": { + "description": "The server-assigned ID for the operation.", + "type": "string" + }, + "statusMessage": { + "description": "If an error has occurred, a textual description of the error.", + "type": "string" + }, + "selfLink": { + "description": "Server-defined URL for the resource.", + "type": "string" + }, "detail": { "description": "Detailed operation progress, if available.", "type": "string" @@ -2247,40 +631,6 @@ "startTime": { "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.", - "type": "string" - }, - "status": { - "enumDescriptions": [ - "Not set.", - "The operation has been created.", - "The operation is currently running.", - "The operation is done, either cancelled or completed.", - "The operation is aborting." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "PENDING", - "RUNNING", - "DONE", - "ABORTING" - ], - "description": "The current status of the operation.", - "type": "string" - }, - "statusMessage": { - "description": "If an error has occurred, a textual description of the error.", - "type": "string" - }, - "name": { - "description": "The server-assigned ID for the operation.", - "type": "string" - }, - "selfLink": { - "description": "Server-defined URL for the resource.", - "type": "string" } }, "id": "Operation" @@ -2311,8 +661,6 @@ "type": "boolean" }, "provider": { - "description": "The selected network policy provider.", - "type": "string", "enumDescriptions": [ "Not set", "Tigera (Calico Felix)." @@ -2320,7 +668,9 @@ "enum": [ "PROVIDER_UNSPECIFIED", "CALICO" - ] + ], + "description": "The selected network policy provider.", + "type": "string" } }, "id": "NetworkPolicy" @@ -2423,11 +773,6 @@ "description": "Parameters that describe the nodes in a cluster.", "type": "object", "properties": { - "diskSizeGb": { - "description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.", - "format": "int32", - "type": "integer" - }, "accelerators": { "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs.", "type": "array", @@ -2482,19 +827,331 @@ } }, "labels": { - "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "type": "object" + }, + "diskSizeGb": { + "description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.", + "format": "int32", + "type": "integer" } }, "id": "NodeConfig" + }, + "AutoUpgradeOptions": { + "description": "AutoUpgradeOptions defines the set of options for the user to control how\nthe Auto Upgrades will proceed.", + "type": "object", + "properties": { + "description": { + "description": "[Output only] This field is set when upgrades are about to commence\nwith the description of the upgrade.", + "type": "string" + }, + "autoUpgradeStartTime": { + "description": "[Output only] This field is set when upgrades are about to commence\nwith the approximate start time for the upgrades, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "type": "string" + } + }, + "id": "AutoUpgradeOptions" + }, + "ListClustersResponse": { + "description": "ListClustersResponse is the result of ListClustersRequest.", + "type": "object", + "properties": { + "missingZones": { + "description": "If any zones are listed here, the list of clusters returned\nmay be missing those zones.", + "type": "array", + "items": { + "type": "string" + } + }, + "clusters": { + "description": "A list of clusters in the project in the specified zone, or\nacross all ones.", + "type": "array", + "items": { + "$ref": "Cluster" + } + } + }, + "id": "ListClustersResponse" + }, + "HttpLoadBalancing": { + "description": "Configuration options for the HTTP (L7) load balancing controller addon,\nwhich makes it easy to set up HTTP load balancers for services in a cluster.", + "type": "object", + "properties": { + "disabled": { + "description": "Whether the HTTP Load Balancing controller is enabled in the cluster.\nWhen enabled, it runs a small pod in the cluster that manages the load\nbalancers.", + "type": "boolean" + } + }, + "id": "HttpLoadBalancing" + }, + "SetMasterAuthRequest": { + "description": "SetMasterAuthRequest updates the admin password of a cluster.", + "type": "object", + "properties": { + "update": { + "description": "A description of the update.", + "$ref": "MasterAuth" + }, + "action": { + "enumDescriptions": [ + "Operation is unknown and will error out.", + "Set the password to a user generated value.", + "Generate a new password and set it to that.", + "Set the username. If an empty username is provided, basic authentication\nis disabled for the cluster. If a non-empty username is provided, basic\nauthentication is enabled, with either a provided password or a generated\none." + ], + "enum": [ + "UNKNOWN", + "SET_PASSWORD", + "GENERATE_PASSWORD", + "SET_USERNAME" + ], + "description": "The exact form of action to be taken on the master auth.", + "type": "string" + } + }, + "id": "SetMasterAuthRequest" + }, + "NodePoolAutoscaling": { + "description": "NodePoolAutoscaling contains information required by cluster autoscaler to\nadjust the size of the node pool to the current cluster usage.", + "type": "object", + "properties": { + "enabled": { + "description": "Is autoscaling enabled for this node pool.", + "type": "boolean" + }, + "maxNodeCount": { + "description": "Maximum number of nodes in the NodePool. Must be \u003e= min_node_count. There\nhas to enough quota to scale up the cluster.", + "format": "int32", + "type": "integer" + }, + "minNodeCount": { + "description": "Minimum number of nodes in the NodePool. Must be \u003e= 1 and \u003c=\nmax_node_count.", + "format": "int32", + "type": "integer" + } + }, + "id": "NodePoolAutoscaling" + }, + "SetNetworkPolicyRequest": { + "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.", + "type": "object", + "properties": { + "networkPolicy": { + "$ref": "NetworkPolicy", + "description": "Configuration options for the NetworkPolicy feature." + } + }, + "id": "SetNetworkPolicyRequest" + }, + "ClusterUpdate": { + "description": "ClusterUpdate describes an update to the cluster. Exactly one update can\nbe applied to a cluster with each request, so at most one field can be\nprovided.", + "type": "object", + "properties": { + "desiredNodePoolId": { + "description": "The node pool to be upgraded. This field is mandatory if\n\"desired_node_version\", \"desired_image_family\" or\n\"desired_node_pool_autoscaling\" is specified and there is more than one\nnode pool on the cluster.", + "type": "string" + }, + "desiredNodeVersion": { + "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.", + "type": "string" + }, + "desiredMasterVersion": { + "description": "The Kubernetes version to change the master to. The only valid value is the\nlatest supported version. Use \"-\" to have the server automatically select\nthe latest version.", + "type": "string" + }, + "desiredMasterAuthorizedNetworksConfig": { + "description": "Master authorized networks is a Beta feature.\nThe desired configuration options for master authorized networks feature.", + "$ref": "MasterAuthorizedNetworksConfig" + }, + "desiredLocations": { + "description": "The desired list of Google Compute Engine\n[locations](/compute/docs/zones#available) in which the cluster's nodes\nshould be located. Changing the locations a cluster is in will result\nin nodes being either created or removed from the cluster, depending on\nwhether locations are being added or removed.\n\nThis list must always include the cluster's primary zone.", + "type": "array", + "items": { + "type": "string" + } + }, + "desiredNodePoolAutoscaling": { + "description": "Autoscaler configuration for the node pool specified in\ndesired_node_pool_id. If there is only one pool in the\ncluster and desired_node_pool_id is not provided then\nthe change applies to that single node pool.", + "$ref": "NodePoolAutoscaling" + }, + "desiredMonitoringService": { + "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster", + "type": "string" + }, + "desiredImageType": { + "description": "The desired image type for the node pool.\nNOTE: Set the \"desired_node_pool\" field as well.", + "type": "string" + }, + "desiredAddonsConfig": { + "$ref": "AddonsConfig", + "description": "Configurations for the various addons available to run in the cluster." + } + }, + "id": "ClusterUpdate" + }, + "IPAllocationPolicy": { + "description": "Configuration for controlling how IPs are allocated in the cluster.", + "type": "object", + "properties": { + "createSubnetwork": { + "description": "Whether a new subnetwork will be created automatically for the cluster.\n\nThis field is only applicable when `use_ip_aliases` is true.", + "type": "boolean" + }, + "useIpAliases": { + "description": "Whether alias IPs will be used for pod IPs in the cluster.", + "type": "boolean" + }, + "servicesSecondaryRangeName": { + "description": "The name of the secondary range to be used as for the services\nCIDR block. The secondary range will be used for service\nClusterIPs. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.", + "type": "string" + }, + "subnetworkName": { + "description": "A custom subnetwork name to be used if `create_subnetwork` is true. If\nthis field is empty, then an automatic name will be chosen for the new\nsubnetwork.", + "type": "string" + }, + "servicesIpv4CidrBlock": { + "description": "The IP address range of the services IPs in this cluster. If blank, a range\nwill be automatically chosen with the default size.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", + "type": "string" + }, + "clusterIpv4Cidr": { + "description": "This field is deprecated, use cluster_ipv4_cidr_block.", + "type": "string" + }, + "nodeIpv4Cidr": { + "description": "This field is deprecated, use node_ipv4_cidr_block.", + "type": "string" + }, + "clusterIpv4CidrBlock": { + "description": "The IP address range for the cluster pod IPs. If this field is set, then\n`cluster.cluster_ipv4_cidr` must be left blank.\n\nThis field is only applicable when `use_ip_aliases` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", + "type": "string" + }, + "clusterSecondaryRangeName": { + "description": "The name of the secondary range to be used for the cluster CIDR\nblock. The secondary range will be used for pod IP\naddresses. This must be an existing secondary range associated\nwith the cluster subnetwork.\n\nThis field is only applicable with use_ip_aliases is true and\ncreate_subnetwork is false.", + "type": "string" + }, + "nodeIpv4CidrBlock": { + "description": "The IP address range of the instance IPs in this cluster.\n\nThis is applicable only if `create_subnetwork` is true.\n\nSet to blank to have a range chosen with the default size.\n\nSet to /netmask (e.g. `/14`) to have a range chosen with a specific\nnetmask.\n\nSet to a\n[CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing)\nnotation (e.g. `10.96.0.0/14`) from the RFC-1918 private networks (e.g.\n`10.0.0.0/8`, `172.16.0.0/12`, `192.168.0.0/16`) to pick a specific range\nto use.", + "type": "string" + }, + "servicesIpv4Cidr": { + "description": "This field is deprecated, use services_ipv4_cidr_block.", + "type": "string" + } + }, + "id": "IPAllocationPolicy" + }, + "HorizontalPodAutoscaling": { + "description": "Configuration options for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.", + "type": "object", + "properties": { + "disabled": { + "description": "Whether the Horizontal Pod Autoscaling feature is enabled in the cluster.\nWhen enabled, it ensures that a Heapster pod is running in the cluster,\nwhich is also used by the Cloud Monitoring service.", + "type": "boolean" + } + }, + "id": "HorizontalPodAutoscaling" + }, + "SetNodePoolManagementRequest": { + "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.", + "type": "object", + "properties": { + "management": { + "$ref": "NodeManagement", + "description": "NodeManagement configuration for the node pool." + } + }, + "id": "SetNodePoolManagementRequest" + }, + "MasterAuthorizedNetworksConfig": { + "description": "Master authorized networks is a Beta feature.\nConfiguration options for the master authorized networks feature. Enabled\nmaster authorized networks will disallow all external traffic to access\nKubernetes master through HTTPS except traffic from the given CIDR blocks,\nGoogle Compute Engine Public IPs and Google Prod IPs.", + "type": "object", + "properties": { + "enabled": { + "description": "Whether or not master authorized networks is enabled.", + "type": "boolean" + }, + "cidrBlocks": { + "description": "cidr_blocks define up to 10 external networks that could access\nKubernetes master through HTTPS.", + "type": "array", + "items": { + "$ref": "CidrBlock" + } + } + }, + "id": "MasterAuthorizedNetworksConfig" + }, + "SetNodePoolAutoscalingRequest": { + "description": "SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.", + "type": "object", + "properties": { + "autoscaling": { + "description": "Autoscaling configuration for the node pool.", + "$ref": "NodePoolAutoscaling" + } + }, + "id": "SetNodePoolAutoscalingRequest" + }, + "CreateClusterRequest": { + "description": "CreateClusterRequest creates a cluster.", + "type": "object", + "properties": { + "cluster": { + "description": "A [cluster\nresource](/container-engine/reference/rest/v1/projects.zones.clusters)", + "$ref": "Cluster" + } + }, + "id": "CreateClusterRequest" + }, + "LegacyAbac": { + "description": "Configuration for the legacy Attribute Based Access Control authorization\nmode.", + "type": "object", + "properties": { + "enabled": { + "description": "Whether the ABAC authorizer is enabled for this cluster. When enabled,\nidentities in the system, including service accounts, nodes, and\ncontrollers, will have statically granted permissions beyond those\nprovided by the RBAC configuration or IAM.", + "type": "boolean" + } + }, + "id": "LegacyAbac" + }, + "AcceleratorConfig": { + "description": "AcceleratorConfig represents a Hardware Accelerator request.", + "type": "object", + "properties": { + "acceleratorCount": { + "description": "The number of the accelerator cards exposed to an instance.", + "format": "int64", + "type": "string" + }, + "acceleratorType": { + "description": "The accelerator type resource name. List of supported accelerators\n[here](/compute/docs/gpus/#Introduction)", + "type": "string" + } + }, + "id": "AcceleratorConfig" + }, + "UpdateNodePoolRequest": { + "description": "UpdateNodePoolRequests update a node pool's image and/or version.", + "type": "object", + "properties": { + "imageType": { + "description": "The desired image type for the node pool.", + "type": "string" + }, + "nodeVersion": { + "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.", + "type": "string" + } + }, + "id": "UpdateNodePoolRequest" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "canonicalName": "Container", @@ -2509,5 +1166,1348 @@ }, "rootUrl": "https://container.googleapis.com/", "ownerDomain": "google.com", - "name": "container" + "name": "container", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Container Engine API", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "zones": { + "methods": { + "getServerconfig": { + "response": { + "$ref": "ServerConfig" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "GET", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/serverconfig", + "path": "v1/projects/{projectId}/zones/{zone}/serverconfig", + "id": "container.projects.zones.getServerconfig", + "description": "Returns configuration info about the Kubernetes Engine service." + } + }, + "resources": { + "operations": { + "methods": { + "list": { + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/operations", + "path": "v1/projects/{projectId}/zones/{zone}/operations", + "id": "container.projects.zones.operations.list", + "description": "Lists all operations in a project in a specific zone or all zones." + }, + "get": { + "description": "Gets the specified operation.", + "httpMethod": "GET", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "operationId" + ], + "parameters": { + "operationId": { + "description": "The server-assigned `name` of the operation.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}", + "id": "container.projects.zones.operations.get", + "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}" + }, + "cancel": { + "request": { + "$ref": "CancelOperationRequest" + }, + "description": "Cancels the specified operation.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "projectId", + "zone", + "operationId" + ], + "httpMethod": "POST", + "parameters": { + "operationId": { + "description": "The server-assigned `name` of the operation.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", + "path": "v1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", + "id": "container.projects.zones.operations.cancel" + } + } + }, + "clusters": { + "methods": { + "startIpRotation": { + "description": "Start master IP rotation.", + "request": { + "$ref": "StartIPRotationRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", + "id": "container.projects.zones.clusters.startIpRotation" + }, + "addons": { + "request": { + "$ref": "SetAddonsConfigRequest" + }, + "description": "Sets the addons of a specific cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", + "id": "container.projects.zones.clusters.addons", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons" + }, + "setMaintenancePolicy": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", + "id": "container.projects.zones.clusters.setMaintenancePolicy", + "request": { + "$ref": "SetMaintenancePolicyRequest" + }, + "description": "Sets the maintenance policy for a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to update.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to delete.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "id": "container.projects.zones.clusters.delete", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time." + }, + "locations": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", + "id": "container.projects.zones.clusters.locations", + "request": { + "$ref": "SetLocationsRequest" + }, + "description": "Sets the locations of a specific cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "id": "container.projects.zones.clusters.update", + "description": "Updates the settings of a specific cluster.", + "request": { + "$ref": "UpdateClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string", + "location": "path" + } + } + }, + "monitoring": { + "description": "Sets the monitoring service of a specific cluster.", + "request": { + "$ref": "SetMonitoringServiceRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", + "id": "container.projects.zones.clusters.monitoring" + }, + "master": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", + "id": "container.projects.zones.clusters.master", + "description": "Updates the master of a specific cluster.", + "request": { + "$ref": "UpdateMasterRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string" + } + } + }, + "setMasterAuth": { + "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set the password.", + "request": { + "$ref": "SetMasterAuthRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", + "id": "container.projects.zones.clusters.setMasterAuth" + }, + "logging": { + "request": { + "$ref": "SetLoggingServiceRequest" + }, + "description": "Sets the logging service of a specific cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", + "id": "container.projects.zones.clusters.logging" + }, + "list": { + "response": { + "$ref": "ListClustersResponse" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", + "path": "v1/projects/{projectId}/zones/{zone}/clusters", + "id": "container.projects.zones.clusters.list", + "description": "Lists all clusters owned by a project in either the specified zone or all\nzones." + }, + "create": { + "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.", + "request": { + "$ref": "CreateClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters", + "path": "v1/projects/{projectId}/zones/{zone}/clusters", + "id": "container.projects.zones.clusters.create" + }, + "resourceLabels": { + "description": "Sets labels on a cluster.", + "request": { + "$ref": "SetLabelsRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", + "id": "container.projects.zones.clusters.resourceLabels" + }, + "completeIpRotation": { + "description": "Completes master IP rotation.", + "request": { + "$ref": "CompleteIPRotationRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", + "id": "container.projects.zones.clusters.completeIpRotation" + }, + "get": { + "description": "Gets the details of a specific cluster.", + "httpMethod": "GET", + "response": { + "$ref": "Cluster" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to retrieve.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "id": "container.projects.zones.clusters.get", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}" + }, + "legacyAbac": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to update.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", + "id": "container.projects.zones.clusters.legacyAbac", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", + "request": { + "$ref": "SetLegacyAbacRequest" + }, + "description": "Enables or disables the ABAC authorization mechanism on a cluster." + }, + "setNetworkPolicy": { + "description": "Enables/Disables Network Policy for a cluster.", + "request": { + "$ref": "SetNetworkPolicyRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", + "id": "container.projects.zones.clusters.setNetworkPolicy" + } + }, + "resources": { + "nodePools": { + "methods": { + "setSize": { + "description": "Sets the size of a specific node pool.", + "request": { + "$ref": "SetNodePoolSizeRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to update.", + "required": true, + "type": "string", + "location": "path" + }, + "nodePoolId": { + "description": "The name of the node pool to update.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setSize", + "id": "container.projects.zones.clusters.nodePools.setSize" + }, + "setManagement": { + "description": "Sets the NodeManagement options for a node pool.", + "request": { + "$ref": "SetNodePoolManagementRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "nodePoolId": { + "description": "The name of the node pool to update.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to update.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", + "id": "container.projects.zones.clusters.nodePools.setManagement" + }, + "delete": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "id": "container.projects.zones.clusters.nodePools.delete", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "description": "Deletes a node pool from a cluster.", + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.", + "required": true, + "type": "string", + "location": "path" + }, + "nodePoolId": { + "description": "The name of the node pool to delete.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists the node pools for a cluster.", + "response": { + "$ref": "ListNodePoolsResponse" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "GET", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "id": "container.projects.zones.clusters.nodePools.list" + }, + "rollback": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", + "id": "container.projects.zones.clusters.nodePools.rollback", + "request": { + "$ref": "RollbackNodePoolUpgradeRequest" + }, + "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to rollback.", + "required": true, + "type": "string" + }, + "nodePoolId": { + "description": "The name of the node pool to rollback.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "id": "container.projects.zones.clusters.nodePools.create", + "request": { + "$ref": "CreateNodePoolRequest" + }, + "description": "Creates a node pool for a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "autoscaling": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "parameters": { + "nodePoolId": { + "description": "The name of the node pool to upgrade.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", + "id": "container.projects.zones.clusters.nodePools.autoscaling", + "request": { + "$ref": "SetNodePoolAutoscalingRequest" + }, + "description": "Sets the autoscaling settings of a specific node pool." + }, + "get": { + "httpMethod": "GET", + "response": { + "$ref": "NodePool" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "parameters": { + "nodePoolId": { + "location": "path", + "description": "The name of the node pool.", + "required": true, + "type": "string" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "id": "container.projects.zones.clusters.nodePools.get", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "description": "Retrieves the node pool requested." + }, + "update": { + "flatPath": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", + "path": "v1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", + "id": "container.projects.zones.clusters.nodePools.update", + "description": "Updates the version and/or image type of a specific node pool.", + "request": { + "$ref": "UpdateNodePoolRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.", + "required": true, + "type": "string", + "location": "path" + }, + "nodePoolId": { + "location": "path", + "description": "The name of the node pool to upgrade.", + "required": true, + "type": "string" + } + } + } + } + } + } + } + } + } + } + } + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + } + }, + "version": "v1" }
diff --git a/container/v1beta1/container-api.json b/container/v1beta1/container-api.json index a3ff981..1a7983a 100644 --- a/container/v1beta1/container-api.json +++ b/container/v1beta1/container-api.json
@@ -1,2293 +1,4 @@ { - "canonicalName": "Container", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "rootUrl": "https://container.googleapis.com/", - "ownerDomain": "google.com", - "name": "container", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Container Engine API", - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "zones": { - "methods": { - "getServerconfig": { - "description": "Returns configuration info about the Kubernetes Engine service.", - "response": { - "$ref": "ServerConfig" - }, - "parameterOrder": [ - "projectId", - "zone" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.", - "type": "string", - "location": "query" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig", - "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig", - "id": "container.projects.zones.getServerconfig" - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "projectId", - "zone", - "operationId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "operationId": { - "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", - "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", - "id": "container.projects.zones.operations.cancel", - "description": "Cancels the specified operation.", - "request": { - "$ref": "CancelOperationRequest" - } - }, - "list": { - "description": "Lists all operations in a project in a specific zone or all zones.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "projectId", - "zone" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string" - }, - "parent": { - "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations", - "path": "v1beta1/projects/{projectId}/zones/{zone}/operations", - "id": "container.projects.zones.operations.list" - }, - "get": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}", - "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}", - "id": "container.projects.zones.operations.get", - "description": "Gets the specified operation.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "operationId" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "query", - "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", - "type": "string" - }, - "operationId": { - "location": "path", - "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "clusters": { - "methods": { - "master": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", - "id": "container.projects.zones.clusters.master", - "request": { - "$ref": "UpdateMasterRequest" - }, - "description": "Updates the master of a specific cluster." - }, - "setMasterAuth": { - "request": { - "$ref": "SetMasterAuthRequest" - }, - "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", - "id": "container.projects.zones.clusters.setMasterAuth" - }, - "logging": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", - "id": "container.projects.zones.clusters.logging", - "description": "Sets the logging service of a specific cluster.", - "request": { - "$ref": "SetLoggingServiceRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - } - }, - "list": { - "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", - "response": { - "$ref": "ListClustersResponse" - }, - "parameterOrder": [ - "projectId", - "zone" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string", - "location": "path" - }, - "parent": { - "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters", - "id": "container.projects.zones.clusters.list" - }, - "create": { - "request": { - "$ref": "CreateClusterRequest" - }, - "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters", - "id": "container.projects.zones.clusters.create" - }, - "resourceLabels": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", - "id": "container.projects.zones.clusters.resourceLabels", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", - "request": { - "$ref": "SetLabelsRequest" - }, - "description": "Sets labels on a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "completeIpRotation": { - "request": { - "$ref": "CompleteIPRotationRequest" - }, - "description": "Completes master IP rotation.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", - "id": "container.projects.zones.clusters.completeIpRotation" - }, - "legacyAbac": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", - "id": "container.projects.zones.clusters.legacyAbac", - "request": { - "$ref": "SetLegacyAbacRequest" - }, - "description": "Enables or disables the ABAC authorization mechanism on a cluster." - }, - "setNetworkPolicy": { - "request": { - "$ref": "SetNetworkPolicyRequest" - }, - "description": "Enables/Disables Network Policy for a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", - "id": "container.projects.zones.clusters.setNetworkPolicy", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy" - }, - "get": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "id": "container.projects.zones.clusters.get", - "description": "Gets the details of a specific cluster.", - "response": { - "$ref": "Cluster" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "name": { - "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string", - "location": "query" - } - } - }, - "startIpRotation": { - "description": "Start master IP rotation.", - "request": { - "$ref": "StartIPRotationRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", - "id": "container.projects.zones.clusters.startIpRotation" - }, - "setMaintenancePolicy": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to update.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", - "id": "container.projects.zones.clusters.setMaintenancePolicy", - "description": "Sets the maintenance policy for a cluster.", - "request": { - "$ref": "SetMaintenancePolicyRequest" - } - }, - "addons": { - "description": "Sets the addons of a specific cluster.", - "request": { - "$ref": "SetAddonsConfigRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", - "id": "container.projects.zones.clusters.addons" - }, - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "location": "query", - "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "id": "container.projects.zones.clusters.delete", - "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time." - }, - "locations": { - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", - "id": "container.projects.zones.clusters.locations", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", - "request": { - "$ref": "SetLocationsRequest" - }, - "description": "Sets the locations of a specific cluster." - }, - "update": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", - "id": "container.projects.zones.clusters.update", - "description": "Updates the settings of a specific cluster.", - "request": { - "$ref": "UpdateClusterRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "monitoring": { - "description": "Sets the monitoring service of a specific cluster.", - "request": { - "$ref": "SetMonitoringServiceRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", - "id": "container.projects.zones.clusters.monitoring" - } - }, - "resources": { - "nodePools": { - "methods": { - "setManagement": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "nodePoolId": { - "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", - "id": "container.projects.zones.clusters.nodePools.setManagement", - "request": { - "$ref": "SetNodePoolManagementRequest" - }, - "description": "Sets the NodeManagement options for a node pool." - }, - "delete": { - "description": "Deletes a node pool from a cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "DELETE", - "parameters": { - "nodePoolId": { - "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "type": "string", - "location": "query" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "id": "container.projects.zones.clusters.nodePools.delete" - }, - "list": { - "description": "Lists the node pools for a cluster.", - "response": { - "$ref": "ListNodePoolsResponse" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string", - "location": "path" - }, - "parent": { - "location": "query", - "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "id": "container.projects.zones.clusters.nodePools.list" - }, - "rollback": { - "request": { - "$ref": "RollbackNodePoolUpgradeRequest" - }, - "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "nodePoolId": { - "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", - "id": "container.projects.zones.clusters.nodePools.rollback", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback" - }, - "create": { - "request": { - "$ref": "CreateNodePoolRequest" - }, - "description": "Creates a node pool for a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.\nThis field is deprecated, use parent instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", - "id": "container.projects.zones.clusters.nodePools.create", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools" - }, - "autoscaling": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", - "id": "container.projects.zones.clusters.nodePools.autoscaling", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", - "request": { - "$ref": "SetNodePoolAutoscalingRequest" - }, - "description": "Sets the autoscaling settings of a specific node pool.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "nodePoolId": { - "location": "path", - "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "description": "Retrieves the node pool requested.", - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "response": { - "$ref": "NodePool" - }, - "parameters": { - "nodePoolId": { - "description": "The name of the node pool.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "type": "string", - "location": "query" - }, - "projectId": { - "location": "path", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterId": { - "location": "path", - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", - "id": "container.projects.zones.clusters.nodePools.get", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}" - }, - "update": { - "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", - "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", - "id": "container.projects.zones.clusters.nodePools.update", - "description": "Updates the version and/or iamge type of a specific node pool.", - "request": { - "$ref": "UpdateNodePoolRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "zone", - "clusterId", - "nodePoolId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "nodePoolId": { - "location": "path", - "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - }, - "zone": { - "location": "path", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "required": true, - "type": "string", - "location": "path" - } - } - } - } - } - } - } - } - }, - "locations": { - "methods": { - "getServerConfig": { - "response": { - "$ref": "ServerConfig" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - }, - "zone": { - "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - }, - "name": { - "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig", - "path": "v1beta1/{+name}/serverConfig", - "id": "container.projects.locations.getServerConfig", - "description": "Returns configuration info about the Kubernetes Engine service." - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", - "path": "v1beta1/{+name}:cancel", - "id": "container.projects.locations.operations.cancel", - "request": { - "$ref": "CancelOperationRequest" - }, - "description": "Cancels the specified operation." - }, - "list": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", - "path": "v1beta1/{+parent}/operations", - "id": "container.projects.locations.operations.list", - "description": "Lists all operations in a project in a specific zone or all zones.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "query", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.", - "type": "string", - "location": "query" - }, - "parent": { - "location": "path", - "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - } - } - }, - "get": { - "httpMethod": "GET", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "operationId": { - "location": "query", - "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - }, - "zone": { - "location": "query", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "name": { - "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "id": "container.projects.locations.operations.get", - "path": "v1beta1/{+name}", - "description": "Gets the specified operation." - } - } - }, - "clusters": { - "methods": { - "completeIpRotation": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation", - "path": "v1beta1/{+name}:completeIpRotation", - "id": "container.projects.locations.clusters.completeIpRotation", - "description": "Completes master IP rotation.", - "request": { - "$ref": "CompleteIPRotationRequest" - } - }, - "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Cluster" - }, - "parameters": { - "name": { - "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - }, - "projectId": { - "location": "query", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "zone": { - "location": "query", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", - "id": "container.projects.locations.clusters.get", - "path": "v1beta1/{+name}", - "description": "Gets the details of a specific cluster." - }, - "setNetworkPolicy": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy", - "id": "container.projects.locations.clusters.setNetworkPolicy", - "path": "v1beta1/{+name}:setNetworkPolicy", - "request": { - "$ref": "SetNetworkPolicyRequest" - }, - "description": "Enables/Disables Network Policy for a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setAddons": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons", - "path": "v1beta1/{+name}:setAddons", - "id": "container.projects.locations.clusters.setAddons", - "description": "Sets the addons of a specific cluster.", - "request": { - "$ref": "SetAddonsConfigRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - } - }, - "setMonitoring": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring", - "path": "v1beta1/{+name}:setMonitoring", - "id": "container.projects.locations.clusters.setMonitoring", - "request": { - "$ref": "SetMonitoringServiceRequest" - }, - "description": "Sets the monitoring service of a specific cluster." - }, - "startIpRotation": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation", - "id": "container.projects.locations.clusters.startIpRotation", - "path": "v1beta1/{+name}:startIpRotation", - "request": { - "$ref": "StartIPRotationRequest" - }, - "description": "Start master IP rotation.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setMaintenancePolicy": { - "request": { - "$ref": "SetMaintenancePolicyRequest" - }, - "description": "Sets the maintenance policy for a cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy", - "id": "container.projects.locations.clusters.setMaintenancePolicy", - "path": "v1beta1/{+name}:setMaintenancePolicy" - }, - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "projectId": { - "location": "query", - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "zone": { - "location": "query", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "location": "query", - "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "name": { - "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", - "path": "v1beta1/{+name}", - "id": "container.projects.locations.clusters.delete", - "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time." - }, - "setLegacyAbac": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac", - "path": "v1beta1/{+name}:setLegacyAbac", - "id": "container.projects.locations.clusters.setLegacyAbac", - "description": "Enables or disables the ABAC authorization mechanism on a cluster.", - "request": { - "$ref": "SetLegacyAbacRequest" - } - }, - "setResourceLabels": { - "request": { - "$ref": "SetLabelsRequest" - }, - "description": "Sets labels on a cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels", - "path": "v1beta1/{+name}:setResourceLabels", - "id": "container.projects.locations.clusters.setResourceLabels" - }, - "setLocations": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", - "path": "v1beta1/{+name}:setLocations", - "id": "container.projects.locations.clusters.setLocations", - "description": "Sets the locations of a specific cluster.", - "request": { - "$ref": "SetLocationsRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - } - }, - "updateMaster": { - "request": { - "$ref": "UpdateMasterRequest" - }, - "description": "Updates the master of a specific cluster.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster", - "id": "container.projects.locations.clusters.updateMaster", - "path": "v1beta1/{+name}:updateMaster" - }, - "update": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", - "path": "v1beta1/{+name}", - "id": "container.projects.locations.clusters.update", - "description": "Updates the settings of a specific cluster.", - "request": { - "$ref": "UpdateClusterRequest" - } - }, - "setMasterAuth": { - "request": { - "$ref": "SetMasterAuthRequest" - }, - "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth", - "id": "container.projects.locations.clusters.setMasterAuth", - "path": "v1beta1/{+name}:setMasterAuth" - }, - "setLogging": { - "request": { - "$ref": "SetLoggingServiceRequest" - }, - "description": "Sets the logging service of a specific cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging", - "path": "v1beta1/{+name}:setLogging", - "id": "container.projects.locations.clusters.setLogging" - }, - "list": { - "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", - "response": { - "$ref": "ListClustersResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", - "type": "string", - "location": "query" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.", - "type": "string", - "location": "query" - }, - "parent": { - "location": "path", - "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", - "path": "v1beta1/{+parent}/clusters", - "id": "container.projects.locations.clusters.list" - }, - "create": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", - "path": "v1beta1/{+parent}/clusters", - "id": "container.projects.locations.clusters.create", - "request": { - "$ref": "CreateClusterRequest" - }, - "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, - "resources": { - "nodePools": { - "methods": { - "setManagement": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement", - "path": "v1beta1/{+name}:setManagement", - "id": "container.projects.locations.clusters.nodePools.setManagement", - "description": "Sets the NodeManagement options for a node pool.", - "request": { - "$ref": "SetNodePoolManagementRequest" - } - }, - "delete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "nodePoolId": { - "location": "query", - "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "name": { - "location": "path", - "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - }, - "zone": { - "location": "query", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", - "path": "v1beta1/{+name}", - "id": "container.projects.locations.clusters.nodePools.delete", - "description": "Deletes a node pool from a cluster." - }, - "list": { - "description": "Lists the node pools for a cluster.", - "response": { - "$ref": "ListNodePoolsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "location": "query", - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", - "type": "string", - "location": "query" - }, - "parent": { - "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - }, - "clusterId": { - "location": "query", - "description": "The name of the cluster.\nThis field is deprecated, use parent instead.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", - "path": "v1beta1/{+parent}/nodePools", - "id": "container.projects.locations.clusters.nodePools.list" - }, - "rollback": { - "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.", - "request": { - "$ref": "RollbackNodePoolUpgradeRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback", - "path": "v1beta1/{+name}:rollback", - "id": "container.projects.locations.clusters.nodePools.rollback" - }, - "create": { - "request": { - "$ref": "CreateNodePoolRequest" - }, - "description": "Creates a node pool for a cluster.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", - "path": "v1beta1/{+parent}/nodePools", - "id": "container.projects.locations.clusters.nodePools.create" - }, - "get": { - "description": "Retrieves the node pool requested.", - "response": { - "$ref": "NodePool" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - }, - "zone": { - "location": "query", - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "type": "string", - "location": "query" - }, - "nodePoolId": { - "location": "query", - "description": "The name of the node pool.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "name": { - "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", - "path": "v1beta1/{+name}", - "id": "container.projects.locations.clusters.nodePools.get" - }, - "update": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", - "id": "container.projects.locations.clusters.nodePools.update", - "path": "v1beta1/{+name}", - "request": { - "$ref": "UpdateNodePoolRequest" - }, - "description": "Updates the version and/or iamge type of a specific node pool.", - "httpMethod": "PUT", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setAutoscaling": { - "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling", - "path": "v1beta1/{+name}:setAutoscaling", - "id": "container.projects.locations.clusters.nodePools.setAutoscaling", - "description": "Sets the autoscaling settings of a specific node pool.", - "request": { - "$ref": "SetNodePoolAutoscalingRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$" - } - } - } - } - } - } - } - } - } - } - } - }, - "parameters": { - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "alt": { - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - } - }, - "version": "v1beta1", - "baseUrl": "https://container.googleapis.com/", "kind": "discovery#restDescription", "description": "The Google Kubernetes Engine API is used for building and managing container based applications, powered by the open source Kubernetes technology.", "servicePath": "", @@ -2298,6 +9,418 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { + "ClientCertificateConfig": { + "description": "Configuration for client certificates on the cluster.", + "type": "object", + "properties": { + "issueClientCertificate": { + "description": "Issue a client certificate.", + "type": "boolean" + } + }, + "id": "ClientCertificateConfig" + }, + "MaintenancePolicy": { + "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.", + "type": "object", + "properties": { + "window": { + "description": "Specifies the maintenance window in which maintenance may be performed.", + "$ref": "MaintenanceWindow" + } + }, + "id": "MaintenancePolicy" + }, + "SetLoggingServiceRequest": { + "description": "SetLoggingServiceRequest sets the logging service of a cluster.", + "type": "object", + "properties": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "loggingService": { + "description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster", + "type": "string" + }, + "name": { + "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + }, + "id": "SetLoggingServiceRequest" + }, + "SetMaintenancePolicyRequest": { + "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.", + "type": "object", + "properties": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to update.", + "type": "string" + }, + "maintenancePolicy": { + "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy.", + "$ref": "MaintenancePolicy" + }, + "name": { + "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + }, + "id": "SetMaintenancePolicyRequest" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "ListNodePoolsResponse": { + "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.", + "type": "object", + "properties": { + "nodePools": { + "description": "A list of node pools for a cluster.", + "type": "array", + "items": { + "$ref": "NodePool" + } + } + }, + "id": "ListNodePoolsResponse" + }, + "CompleteIPRotationRequest": { + "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", + "type": "object", + "properties": { + "name": { + "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "type": "string" + } + }, + "id": "CompleteIPRotationRequest" + }, + "StartIPRotationRequest": { + "description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.", + "type": "object", + "properties": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "name": { + "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + }, + "id": "StartIPRotationRequest" + }, + "NodePool": { + "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.", + "type": "object", + "properties": { + "status": { + "description": "[Output only] The status of the nodes in this pool instance.", + "type": "string", + "enumDescriptions": [ + "Not set.", + "The PROVISIONING state indicates the node pool is being created.", + "The RUNNING state indicates the node pool has been created\nand is fully usable.", + "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.", + "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.", + "The STOPPING state indicates the node pool is being deleted.", + "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "PROVISIONING", + "RUNNING", + "RUNNING_WITH_ERROR", + "RECONCILING", + "STOPPING", + "ERROR" + ] + }, + "config": { + "description": "The node configuration of the pool.", + "$ref": "NodeConfig" + }, + "statusMessage": { + "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.", + "type": "string" + }, + "name": { + "description": "The name of the node pool.", + "type": "string" + }, + "autoscaling": { + "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present.", + "$ref": "NodePoolAutoscaling" + }, + "initialNodeCount": { + "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.", + "format": "int32", + "type": "integer" + }, + "management": { + "$ref": "NodeManagement", + "description": "NodeManagement configuration for this NodePool." + }, + "selfLink": { + "description": "[Output only] Server-defined URL for the resource.", + "type": "string" + }, + "version": { + "description": "The version of the Kubernetes of this node.", + "type": "string" + }, + "instanceGroupUrls": { + "description": "[Output only] The resource URLs of the [managed instance\ngroups](/compute/docs/instance-groups/creating-groups-of-managed-instances)\nassociated with this node pool.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "NodePool" + }, + "SetLabelsRequest": { + "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster", + "type": "object", + "properties": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "labelFingerprint": { + "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "resourceLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels to set for that cluster.", + "type": "object" + }, + "name": { + "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + }, + "id": "SetLabelsRequest" + }, + "NodeManagement": { + "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.", + "type": "object", + "properties": { + "autoUpgrade": { + "description": "Whether the nodes will be automatically upgraded.", + "type": "boolean" + }, + "autoRepair": { + "description": "Whether the nodes will be automatically repaired.", + "type": "boolean" + }, + "upgradeOptions": { + "description": "Specifies the Auto Upgrade knobs for the node pool.", + "$ref": "AutoUpgradeOptions" + } + }, + "id": "NodeManagement" + }, + "CancelOperationRequest": { + "description": "CancelOperationRequest cancels a single operation.", + "type": "object", + "properties": { + "name": { + "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "type": "string" + }, + "operationId": { + "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.", + "type": "string" + } + }, + "id": "CancelOperationRequest" + }, + "KubernetesDashboard": { + "description": "Configuration for the Kubernetes Dashboard.", + "type": "object", + "properties": { + "disabled": { + "description": "Whether the Kubernetes Dashboard is enabled for this cluster.", + "type": "boolean" + } + }, + "id": "KubernetesDashboard" + }, + "Operation": { + "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.", + "type": "object", + "properties": { + "selfLink": { + "description": "Server-defined URL for the resource.", + "type": "string" + }, + "detail": { + "description": "Detailed operation progress, if available.", + "type": "string" + }, + "targetLink": { + "description": "Server-defined URL for the target of the operation.", + "type": "string" + }, + "location": { + "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.", + "type": "string" + }, + "endTime": { + "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "type": "string" + }, + "operationType": { + "enumDescriptions": [ + "Not set.", + "Cluster create.", + "Cluster delete.", + "A master upgrade.", + "A node upgrade.", + "Cluster repair.", + "Cluster update.", + "Node pool create.", + "Node pool delete.", + "Set node pool management.", + "Automatic node pool repair.", + "Automatic node upgrade.", + "Set labels.", + "Set/generate master auth materials", + "Set node pool size.", + "Updates network policy for a cluster.", + "Set the maintenance policy." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "CREATE_CLUSTER", + "DELETE_CLUSTER", + "UPGRADE_MASTER", + "UPGRADE_NODES", + "REPAIR_CLUSTER", + "UPDATE_CLUSTER", + "CREATE_NODE_POOL", + "DELETE_NODE_POOL", + "SET_NODE_POOL_MANAGEMENT", + "AUTO_REPAIR_NODES", + "AUTO_UPGRADE_NODES", + "SET_LABELS", + "SET_MASTER_AUTH", + "SET_NODE_POOL_SIZE", + "SET_NETWORK_POLICY", + "SET_MAINTENANCE_POLICY" + ], + "description": "The operation type.", + "type": "string" + }, + "startTime": { + "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.\nThis field is deprecated, use location instead.", + "type": "string" + }, + "status": { + "description": "The current status of the operation.", + "type": "string", + "enumDescriptions": [ + "Not set.", + "The operation has been created.", + "The operation is currently running.", + "The operation is done, either cancelled or completed.", + "The operation is aborting." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE", + "ABORTING" + ] + }, + "statusMessage": { + "description": "If an error has occurred, a textual description of the error.", + "type": "string" + }, + "name": { + "description": "The server-assigned ID for the operation.", + "type": "string" + } + }, + "id": "Operation" + }, + "MaintenanceWindow": { + "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.", + "type": "object", + "properties": { + "dailyMaintenanceWindow": { + "$ref": "DailyMaintenanceWindow", + "description": "DailyMaintenanceWindow specifies a daily maintenance operation window." + } + }, + "id": "MaintenanceWindow" + }, "RollbackNodePoolUpgradeRequest": { "description": "RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed\nNodePool upgrade. This will be an no-op if the last upgrade successfully\ncompleted.", "type": "object", @@ -2334,6 +457,8 @@ "type": "boolean" }, "provider": { + "description": "The selected network policy provider.", + "type": "string", "enumDescriptions": [ "Not set", "Tigera (Calico Felix)." @@ -2341,9 +466,7 @@ "enum": [ "PROVIDER_UNSPECIFIED", "CALICO" - ], - "description": "The selected network policy provider.", - "type": "string" + ] } }, "id": "NetworkPolicy" @@ -2352,6 +475,10 @@ "description": "UpdateMasterRequest updates the master of the cluster.", "type": "object", "properties": { + "name": { + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + }, "projectId": { "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", "type": "string" @@ -2367,10 +494,6 @@ "clusterId": { "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", "type": "string" - }, - "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" } }, "id": "UpdateMasterRequest" @@ -2400,6 +523,14 @@ "description": "SetMonitoringServiceRequest sets the monitoring service of a cluster.", "type": "object", "properties": { + "monitoringService": { + "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster", + "type": "string" + }, + "name": { + "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + }, "projectId": { "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", "type": "string" @@ -2411,14 +542,6 @@ "clusterId": { "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", "type": "string" - }, - "monitoringService": { - "description": "The monitoring service the cluster should use to write metrics.\nCurrently available options:\n\n* \"monitoring.googleapis.com\" - the Google Cloud Monitoring service\n* \"none\" - no metrics will be exported from the cluster", - "type": "string" - }, - "name": { - "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" } }, "id": "SetMonitoringServiceRequest" @@ -2427,13 +550,13 @@ "description": "CidrBlock contains an optional name and one CIDR block.", "type": "object", "properties": { - "displayName": { - "description": "display_name is an optional field for users to identify CIDR blocks.", - "type": "string" - }, "cidrBlock": { "description": "cidr_block must be specified in CIDR notation.", "type": "string" + }, + "displayName": { + "description": "display_name is an optional field for users to identify CIDR blocks.", + "type": "string" } }, "id": "CidrBlock" @@ -2478,42 +601,6 @@ "description": "Parameters that describe the nodes in a cluster.", "type": "object", "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", - "type": "object" - }, - "diskSizeGb": { - "description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.", - "format": "int32", - "type": "integer" - }, - "accelerators": { - "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs.", - "type": "array", - "items": { - "$ref": "AcceleratorConfig" - } - }, - "machineType": { - "description": "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.", - "type": "string" - }, - "minCpuPlatform": { - "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n\u003ccode\u003eminCpuPlatform: "Intel Haswell"\u003c/code\u003e or\n\u003ccode\u003eminCpuPlatform: "Intel Sandy Bridge"\u003c/code\u003e. For more\ninformation, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", - "type": "string" - }, - "preemptible": { - "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.", - "type": "boolean" - }, - "localSsdCount": { - "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.", - "format": "int32", - "type": "integer" - }, "metadata": { "additionalProperties": { "type": "string" @@ -2549,6 +636,42 @@ "items": { "$ref": "NodeTaint" } + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The map of Kubernetes labels (key/value pairs) to be applied to each node.\nThese will added in addition to any default label(s) that\nKubernetes may apply to the node.\nIn case of conflict in label keys, the applied set may differ depending on\nthe Kubernetes version -- it's best to assume the behavior is undefined\nand conflicts should be avoided.\nFor more information, including usage and the valid values, see:\nhttps://kubernetes.io/docs/concepts/overview/working-with-objects/labels/", + "type": "object" + }, + "diskSizeGb": { + "description": "Size of the disk attached to each node, specified in GB.\nThe smallest allowed disk size is 10GB.\n\nIf unspecified, the default disk size is 100GB.", + "format": "int32", + "type": "integer" + }, + "accelerators": { + "description": "A list of hardware accelerators to be attached to each node.\nSee https://cloud.google.com/compute/docs/gpus for more information about\nsupport for GPUs.", + "type": "array", + "items": { + "$ref": "AcceleratorConfig" + } + }, + "machineType": { + "description": "The name of a Google Compute Engine [machine\ntype](/compute/docs/machine-types) (e.g.\n`n1-standard-1`).\n\nIf unspecified, the default machine type is\n`n1-standard-1`.", + "type": "string" + }, + "minCpuPlatform": { + "description": "Minimum CPU platform to be used by this instance. The instance may be\nscheduled on the specified or newer CPU platform. Applicable values are the\nfriendly names of CPU platforms, such as\n\u003ccode\u003eminCpuPlatform: "Intel Haswell"\u003c/code\u003e or\n\u003ccode\u003eminCpuPlatform: "Intel Sandy Bridge"\u003c/code\u003e. For more\ninformation, read [how to specify min CPU platform](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform)", + "type": "string" + }, + "preemptible": { + "description": "Whether the nodes are created as preemptible VM instances. See:\nhttps://cloud.google.com/compute/docs/instances/preemptible for more\ninforamtion about preemptible VM instances.", + "type": "boolean" + }, + "localSsdCount": { + "description": "The number of local SSD disks to be attached to the node.\n\nThe limit for this value is dependant upon the maximum number of\ndisks available on a machine per zone. See:\nhttps://cloud.google.com/compute/docs/disks/local-ssd#local_ssd_limits\nfor more information.", + "format": "int32", + "type": "integer" } }, "id": "NodeConfig" @@ -2615,6 +738,14 @@ "description": "SetNetworkPolicyRequest enables/disables network policy for a cluster.", "type": "object", "properties": { + "networkPolicy": { + "$ref": "NetworkPolicy", + "description": "Configuration options for the NetworkPolicy feature." + }, + "name": { + "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + }, "projectId": { "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", "type": "string" @@ -2626,14 +757,6 @@ "clusterId": { "description": "The name of the cluster.\nThis field is deprecated, use name instead.", "type": "string" - }, - "networkPolicy": { - "$ref": "NetworkPolicy", - "description": "Configuration options for the NetworkPolicy feature." - }, - "name": { - "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" } }, "id": "SetNetworkPolicyRequest" @@ -2663,6 +786,14 @@ "description": "SetMasterAuthRequest updates the admin password of a cluster.", "type": "object", "properties": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "type": "string" + }, "update": { "$ref": "MasterAuth", "description": "A description of the update." @@ -2690,14 +821,6 @@ ], "description": "The exact form of action to be taken on the master auth.", "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "type": "string" } }, "id": "SetMasterAuthRequest" @@ -2840,6 +963,10 @@ "description": "SetNodePoolManagementRequest sets the node management properties of a node\npool.", "type": "object", "properties": { + "nodePoolId": { + "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.", + "type": "string" + }, "zone": { "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", "type": "string" @@ -2859,10 +986,6 @@ "clusterId": { "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.", "type": "string" - }, - "nodePoolId": { - "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.", - "type": "string" } }, "id": "SetNodePoolManagementRequest" @@ -2880,8 +1003,8 @@ "type": "string" }, "autoscaling": { - "description": "Autoscaling configuration for the node pool.", - "$ref": "NodePoolAutoscaling" + "$ref": "NodePoolAutoscaling", + "description": "Autoscaling configuration for the node pool." }, "projectId": { "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", @@ -2941,10 +1064,6 @@ "description": "SetNodePoolVersionRequest updates the version of a node pool.", "type": "object", "properties": { - "name": { - "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", - "type": "string" - }, "projectId": { "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", "type": "string" @@ -2968,6 +1087,10 @@ "nodeVersion": { "description": "The Kubernetes version to change the nodes to (typically an\nupgrade). Use `-` to upgrade to the latest version supported by\nthe server.", "type": "string" + }, + "name": { + "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "type": "string" } }, "id": "UpdateNodePoolRequest" @@ -3034,10 +1157,6 @@ "description": "SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for\na cluster.", "type": "object", "properties": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, "enabled": { "description": "Whether ABAC authorization will be enabled in the cluster.", "type": "boolean" @@ -3053,6 +1172,10 @@ "clusterId": { "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.", "type": "string" + }, + "name": { + "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" } }, "id": "SetLegacyAbacRequest" @@ -3061,21 +1184,21 @@ "description": "Configuration for the addons that can be automatically spun up in the\ncluster, enabling additional functionality.", "type": "object", "properties": { - "horizontalPodAutoscaling": { - "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods.", - "$ref": "HorizontalPodAutoscaling" - }, - "httpLoadBalancing": { - "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster.", - "$ref": "HttpLoadBalancing" - }, "kubernetesDashboard": { - "$ref": "KubernetesDashboard", - "description": "Configuration for the Kubernetes Dashboard." + "description": "Configuration for the Kubernetes Dashboard.", + "$ref": "KubernetesDashboard" }, "networkPolicyConfig": { - "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes.", - "$ref": "NetworkPolicyConfig" + "$ref": "NetworkPolicyConfig", + "description": "Configuration for NetworkPolicy. This only tracks whether the addon\nis enabled or not on the Master, it does not track whether network policy\nis enabled for the nodes." + }, + "horizontalPodAutoscaling": { + "$ref": "HorizontalPodAutoscaling", + "description": "Configuration for the horizontal pod autoscaling feature, which\nincreases or decreases the number of replica pods a replication controller\nhas based on the resource usage of the existing pods." + }, + "httpLoadBalancing": { + "$ref": "HttpLoadBalancing", + "description": "Configuration for the HTTP (L7) load balancing controller addon, which\nmakes it easy to set up HTTP load balancers for services in a cluster." } }, "id": "AddonsConfig" @@ -3125,14 +1248,6 @@ "description": "UpdateClusterRequest updates the settings of a cluster.", "type": "object", "properties": { - "update": { - "$ref": "ClusterUpdate", - "description": "A description of the update." - }, - "name": { - "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, "projectId": { "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", "type": "string" @@ -3144,6 +1259,14 @@ "clusterId": { "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", "type": "string" + }, + "update": { + "description": "A description of the update.", + "$ref": "ClusterUpdate" + }, + "name": { + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" } }, "id": "UpdateClusterRequest" @@ -3152,21 +1275,9 @@ "description": "A Google Kubernetes Engine cluster.", "type": "object", "properties": { - "masterAuth": { - "$ref": "MasterAuth", - "description": "The authentication information for accessing the master endpoint." - }, - "currentMasterVersion": { - "description": "[Output only] The current software version of the master endpoint.", - "type": "string" - }, - "nodeConfig": { - "$ref": "NodeConfig", - "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used." - }, "podSecurityPolicyConfig": { - "description": "Configuration for the PodSecurityPolicy feature.", - "$ref": "PodSecurityPolicyConfig" + "$ref": "PodSecurityPolicyConfig", + "description": "Configuration for the PodSecurityPolicy feature." }, "addonsConfig": { "description": "Configurations for the various addons available to run in the cluster.", @@ -3213,8 +1324,8 @@ "type": "string" }, "ipAllocationPolicy": { - "$ref": "IPAllocationPolicy", - "description": "Configuration for cluster IP allocation." + "description": "Configuration for cluster IP allocation.", + "$ref": "IPAllocationPolicy" }, "location": { "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.", @@ -3309,12 +1420,24 @@ "type": "string" }, "masterAuthorizedNetworksConfig": { - "description": "The configuration options for master authorized networks feature.", - "$ref": "MasterAuthorizedNetworksConfig" + "$ref": "MasterAuthorizedNetworksConfig", + "description": "The configuration options for master authorized networks feature." }, "statusMessage": { "description": "[Output only] Additional information about the current status of this\ncluster, if available.", "type": "string" + }, + "masterAuth": { + "description": "The authentication information for accessing the master endpoint.", + "$ref": "MasterAuth" + }, + "currentMasterVersion": { + "description": "[Output only] The current software version of the master endpoint.", + "type": "string" + }, + "nodeConfig": { + "$ref": "NodeConfig", + "description": "Parameters used in creating the cluster's nodes.\nSee `nodeConfig` for the description of its properties.\nFor requests, this field should only be used in lieu of a\n\"node_pool\" object, since this configuration (along with the\n\"initial_node_count\") will be used to create a \"NodePool\" object with an\nauto-generated name. Do not use this and a node_pool at the same time.\nFor responses, this field will be populated with the node configuration of\nthe first node pool.\n\nIf unspecified, the defaults are used." } }, "id": "Cluster" @@ -3336,8 +1459,8 @@ "type": "string" }, "nodePool": { - "$ref": "NodePool", - "description": "The node pool to create." + "description": "The node pool to create.", + "$ref": "NodePool" }, "parent": { "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", @@ -3391,423 +1514,2300 @@ } }, "id": "DailyMaintenanceWindow" - }, - "ClientCertificateConfig": { - "description": "Configuration for client certificates on the cluster.", - "type": "object", - "properties": { - "issueClientCertificate": { - "description": "Issue a client certificate.", - "type": "boolean" - } - }, - "id": "ClientCertificateConfig" - }, - "MaintenancePolicy": { - "description": "MaintenancePolicy defines the maintenance policy to be used for the cluster.", - "type": "object", - "properties": { - "window": { - "$ref": "MaintenanceWindow", - "description": "Specifies the maintenance window in which maintenance may be performed." - } - }, - "id": "MaintenancePolicy" - }, - "SetLoggingServiceRequest": { - "description": "SetLoggingServiceRequest sets the logging service of a cluster.", - "type": "object", - "properties": { - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "loggingService": { - "description": "The logging service the cluster should use to write metrics.\nCurrently available options:\n\n* \"logging.googleapis.com\" - the Google Cloud Logging service\n* \"none\" - no metrics will be exported from the cluster", - "type": "string" - }, - "name": { - "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - } - }, - "id": "SetLoggingServiceRequest" - }, - "SetMaintenancePolicyRequest": { - "description": "SetMaintenancePolicyRequest sets the maintenance policy for a cluster.", - "type": "object", - "properties": { - "maintenancePolicy": { - "$ref": "MaintenancePolicy", - "description": "The maintenance policy to be set for the cluster. An empty field\nclears the existing maintenance policy." - }, - "name": { - "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster to update.", - "type": "string" - } - }, - "id": "SetMaintenancePolicyRequest" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "ListNodePoolsResponse": { - "description": "ListNodePoolsResponse is the result of ListNodePoolsRequest.", - "type": "object", - "properties": { - "nodePools": { - "description": "A list of node pools for a cluster.", - "type": "array", - "items": { - "$ref": "NodePool" - } - } - }, - "id": "ListNodePoolsResponse" - }, - "CompleteIPRotationRequest": { - "description": "CompleteIPRotationRequest moves the cluster master back into single-IP mode.", - "type": "object", - "properties": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "type": "string" - } - }, - "id": "CompleteIPRotationRequest" - }, - "StartIPRotationRequest": { - "description": "StartIPRotationRequest creates a new IP for the cluster and then performs\na node upgrade on each node pool to point to the new IP.", - "type": "object", - "properties": { - "name": { - "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "type": "string" - } - }, - "id": "StartIPRotationRequest" - }, - "NodePool": { - "description": "NodePool contains the name and configuration for a cluster's node pool.\nNode pools are a set of nodes (i.e. VM's), with a common configuration and\nspecification, under the control of the cluster master. They may have a set\nof Kubernetes labels applied to them, which may be used to reference them\nduring pod scheduling. They may also be resized up or down, to accommodate\nthe workload.", - "type": "object", - "properties": { - "status": { - "description": "[Output only] The status of the nodes in this pool instance.", - "type": "string", - "enumDescriptions": [ - "Not set.", - "The PROVISIONING state indicates the node pool is being created.", - "The RUNNING state indicates the node pool has been created\nand is fully usable.", - "The RUNNING_WITH_ERROR state indicates the node pool has been created\nand is partially usable. Some error state has occurred and some\nfunctionality may be impaired. Customer may need to reissue a request\nor trigger a new update.", - "The RECONCILING state indicates that some work is actively being done on\nthe node pool, such as upgrading node software. Details can\nbe found in the `statusMessage` field.", - "The STOPPING state indicates the node pool is being deleted.", - "The ERROR state indicates the node pool may be unusable. Details\ncan be found in the `statusMessage` field." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "PROVISIONING", - "RUNNING", - "RUNNING_WITH_ERROR", - "RECONCILING", - "STOPPING", - "ERROR" - ] - }, - "config": { - "description": "The node configuration of the pool.", - "$ref": "NodeConfig" - }, - "statusMessage": { - "description": "[Output only] Additional information about the current status of this\nnode pool instance, if available.", - "type": "string" - }, - "name": { - "description": "The name of the node pool.", - "type": "string" - }, - "autoscaling": { - "$ref": "NodePoolAutoscaling", - "description": "Autoscaler configuration for this NodePool. Autoscaler is enabled\nonly if a valid configuration is present." - }, - "initialNodeCount": { - "description": "The initial node count for the pool. You must ensure that your\nCompute Engine \u003ca href=\"/compute/docs/resource-quotas\"\u003eresource quota\u003c/a\u003e\nis sufficient for this number of instances. You must also have available\nfirewall and routes quota.", - "format": "int32", - "type": "integer" - }, - "management": { - "description": "NodeManagement configuration for this NodePool.", - "$ref": "NodeManagement" - }, - "selfLink": { - "description": "[Output only] Server-defined URL for the resource.", - "type": "string" - }, - "version": { - "description": "The version of the Kubernetes of this node.", - "type": "string" - }, - "instanceGroupUrls": { - "description": "[Output only] The resource URLs of the [managed instance\ngroups](/compute/docs/instance-groups/creating-groups-of-managed-instances)\nassociated with this node pool.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "NodePool" - }, - "SetLabelsRequest": { - "description": "SetLabelsRequest sets the Google Cloud Platform labels on a Google Container\nEngine cluster, which will in turn set them for Google Compute Engine\nresources used by that cluster", - "type": "object", - "properties": { - "labelFingerprint": { - "description": "The fingerprint of the previous set of labels for this resource,\nused to detect conflicts. The fingerprint is initially generated by\nKubernetes Engine and changes after every request to modify or update\nlabels. You must always provide an up-to-date fingerprint hash when\nupdating or changing labels. Make a \u003ccode\u003eget()\u003c/code\u003e request to the\nresource to get the latest fingerprint.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "resourceLabels": { - "description": "The labels to set for that cluster.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "name": { - "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "clusterId": { - "description": "The name of the cluster.\nThis field is deprecated, use name instead.", - "type": "string" - } - }, - "id": "SetLabelsRequest" - }, - "NodeManagement": { - "description": "NodeManagement defines the set of node management services turned on for the\nnode pool.", - "type": "object", - "properties": { - "autoUpgrade": { - "description": "Whether the nodes will be automatically upgraded.", - "type": "boolean" - }, - "autoRepair": { - "description": "Whether the nodes will be automatically repaired.", - "type": "boolean" - }, - "upgradeOptions": { - "description": "Specifies the Auto Upgrade knobs for the node pool.", - "$ref": "AutoUpgradeOptions" - } - }, - "id": "NodeManagement" - }, - "CancelOperationRequest": { - "description": "CancelOperationRequest cancels a single operation.", - "type": "object", - "properties": { - "name": { - "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", - "type": "string" - }, - "operationId": { - "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", - "type": "string" - }, - "projectId": { - "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.", - "type": "string" - } - }, - "id": "CancelOperationRequest" - }, - "KubernetesDashboard": { - "description": "Configuration for the Kubernetes Dashboard.", - "type": "object", - "properties": { - "disabled": { - "description": "Whether the Kubernetes Dashboard is enabled for this cluster.", - "type": "boolean" - } - }, - "id": "KubernetesDashboard" - }, - "Operation": { - "description": "This operation resource represents operations that may have happened or are\nhappening on the cluster. All fields are output only.", - "type": "object", - "properties": { - "detail": { - "description": "Detailed operation progress, if available.", - "type": "string" - }, - "targetLink": { - "description": "Server-defined URL for the target of the operation.", - "type": "string" - }, - "location": { - "description": "[Output only] The name of the Google Compute Engine\n[zone](/compute/docs/regions-zones/regions-zones#available) or\n[region](/compute/docs/regions-zones/regions-zones#available) in which\nthe cluster resides.", - "type": "string" - }, - "endTime": { - "description": "[Output only] The time the operation completed, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", - "type": "string" - }, - "operationType": { - "enumDescriptions": [ - "Not set.", - "Cluster create.", - "Cluster delete.", - "A master upgrade.", - "A node upgrade.", - "Cluster repair.", - "Cluster update.", - "Node pool create.", - "Node pool delete.", - "Set node pool management.", - "Automatic node pool repair.", - "Automatic node upgrade.", - "Set labels.", - "Set/generate master auth materials", - "Set node pool size.", - "Updates network policy for a cluster.", - "Set the maintenance policy." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "CREATE_CLUSTER", - "DELETE_CLUSTER", - "UPGRADE_MASTER", - "UPGRADE_NODES", - "REPAIR_CLUSTER", - "UPDATE_CLUSTER", - "CREATE_NODE_POOL", - "DELETE_NODE_POOL", - "SET_NODE_POOL_MANAGEMENT", - "AUTO_REPAIR_NODES", - "AUTO_UPGRADE_NODES", - "SET_LABELS", - "SET_MASTER_AUTH", - "SET_NODE_POOL_SIZE", - "SET_NETWORK_POLICY", - "SET_MAINTENANCE_POLICY" - ], - "description": "The operation type.", - "type": "string" - }, - "startTime": { - "description": "[Output only] The time the operation started, in\n[RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.", - "type": "string" - }, - "zone": { - "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation\nis taking place.\nThis field is deprecated, use location instead.", - "type": "string" - }, - "status": { - "description": "The current status of the operation.", - "type": "string", - "enumDescriptions": [ - "Not set.", - "The operation has been created.", - "The operation is currently running.", - "The operation is done, either cancelled or completed.", - "The operation is aborting." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "PENDING", - "RUNNING", - "DONE", - "ABORTING" - ] - }, - "statusMessage": { - "description": "If an error has occurred, a textual description of the error.", - "type": "string" - }, - "name": { - "description": "The server-assigned ID for the operation.", - "type": "string" - }, - "selfLink": { - "description": "Server-defined URL for the resource.", - "type": "string" - } - }, - "id": "Operation" - }, - "MaintenanceWindow": { - "description": "MaintenanceWindow defines the maintenance window to be used for the cluster.", - "type": "object", - "properties": { - "dailyMaintenanceWindow": { - "$ref": "DailyMaintenanceWindow", - "description": "DailyMaintenanceWindow specifies a daily maintenance operation window." - } - }, - "id": "MaintenanceWindow" } }, "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" - } + }, + "canonicalName": "Container", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "rootUrl": "https://container.googleapis.com/", + "ownerDomain": "google.com", + "name": "container", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Container Engine API", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "locations": { + "methods": { + "getServerConfig": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/serverConfig", + "path": "v1beta1/{+name}/serverConfig", + "id": "container.projects.locations.getServerConfig", + "description": "Returns configuration info about the Kubernetes Engine service.", + "response": { + "$ref": "ServerConfig" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "zone": { + "location": "query", + "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "name": { + "location": "path", + "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + } + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "request": { + "$ref": "CancelOperationRequest" + }, + "description": "Cancels the specified operation.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, operation id) of the operation to cancel.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", + "path": "v1beta1/{+name}:cancel", + "id": "container.projects.locations.operations.cancel" + }, + "list": { + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", + "type": "string", + "location": "query" + }, + "zone": { + "location": "query", + "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.", + "type": "string" + }, + "parent": { + "location": "path", + "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations", + "path": "v1beta1/{+parent}/operations", + "id": "container.projects.locations.operations.list", + "description": "Lists all operations in a project in a specific zone or all zones." + }, + "get": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "id": "container.projects.locations.operations.get", + "path": "v1beta1/{+name}", + "description": "Gets the specified operation.", + "httpMethod": "GET", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "operationId": { + "location": "query", + "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "zone": { + "location": "query", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "name": { + "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "clusters": { + "methods": { + "setLocations": { + "description": "Sets the locations of a specific cluster.", + "request": { + "$ref": "SetLocationsRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to set locations.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLocations", + "path": "v1beta1/{+name}:setLocations", + "id": "container.projects.locations.clusters.setLocations" + }, + "updateMaster": { + "request": { + "$ref": "UpdateMasterRequest" + }, + "description": "Updates the master of a specific cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:updateMaster", + "id": "container.projects.locations.clusters.updateMaster", + "path": "v1beta1/{+name}:updateMaster" + }, + "update": { + "description": "Updates the settings of a specific cluster.", + "request": { + "$ref": "UpdateClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, cluster) of the cluster to update.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "path": "v1beta1/{+name}", + "id": "container.projects.locations.clusters.update" + }, + "setMasterAuth": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to set auth.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMasterAuth", + "id": "container.projects.locations.clusters.setMasterAuth", + "path": "v1beta1/{+name}:setMasterAuth", + "request": { + "$ref": "SetMasterAuthRequest" + }, + "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server." + }, + "setLogging": { + "request": { + "$ref": "SetLoggingServiceRequest" + }, + "description": "Sets the logging service of a specific cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, cluster) of the cluster to set logging.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLogging", + "path": "v1beta1/{+name}:setLogging", + "id": "container.projects.locations.clusters.setLogging" + }, + "list": { + "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", + "response": { + "$ref": "ListClustersResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "projectId": { + "location": "query", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.", + "type": "string", + "location": "query" + }, + "parent": { + "location": "path", + "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", + "path": "v1beta1/{+parent}/clusters", + "id": "container.projects.locations.clusters.list" + }, + "create": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters", + "path": "v1beta1/{+parent}/clusters", + "id": "container.projects.locations.clusters.create", + "request": { + "$ref": "CreateClusterRequest" + }, + "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "The parent (project and location) where the cluster will be created.\nSpecified in the format 'projects/*/locations/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "completeIpRotation": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name (project, location, cluster id) of the cluster to complete IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:completeIpRotation", + "path": "v1beta1/{+name}:completeIpRotation", + "id": "container.projects.locations.clusters.completeIpRotation", + "description": "Completes master IP rotation.", + "request": { + "$ref": "CompleteIPRotationRequest" + } + }, + "get": { + "description": "Gets the details of a specific cluster.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Cluster" + }, + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "clusterId": { + "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "id": "container.projects.locations.clusters.get", + "path": "v1beta1/{+name}" + }, + "setNetworkPolicy": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setNetworkPolicy", + "id": "container.projects.locations.clusters.setNetworkPolicy", + "path": "v1beta1/{+name}:setNetworkPolicy", + "request": { + "$ref": "SetNetworkPolicyRequest" + }, + "description": "Enables/Disables Network Policy for a cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, cluster id) of the cluster to set networking policy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setAddons": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setAddons", + "path": "v1beta1/{+name}:setAddons", + "id": "container.projects.locations.clusters.setAddons", + "description": "Sets the addons of a specific cluster.", + "request": { + "$ref": "SetAddonsConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to set addons.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + } + }, + "setMonitoring": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to set monitoring.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMonitoring", + "path": "v1beta1/{+name}:setMonitoring", + "id": "container.projects.locations.clusters.setMonitoring", + "request": { + "$ref": "SetMonitoringServiceRequest" + }, + "description": "Sets the monitoring service of a specific cluster." + }, + "startIpRotation": { + "request": { + "$ref": "StartIPRotationRequest" + }, + "description": "Start master IP rotation.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "description": "The name (project, location, cluster id) of the cluster to start IP rotation.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:startIpRotation", + "id": "container.projects.locations.clusters.startIpRotation", + "path": "v1beta1/{+name}:startIpRotation" + }, + "setMaintenancePolicy": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setMaintenancePolicy", + "id": "container.projects.locations.clusters.setMaintenancePolicy", + "path": "v1beta1/{+name}:setMaintenancePolicy", + "request": { + "$ref": "SetMaintenancePolicyRequest" + }, + "description": "Sets the maintenance policy for a cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "description": "The name (project, location, cluster id) of the cluster to set maintenance\npolicy.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}", + "path": "v1beta1/{+name}", + "id": "container.projects.locations.clusters.delete", + "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + }, + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "zone": { + "location": "query", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setLegacyAbac": { + "description": "Enables or disables the ABAC authorization mechanism on a cluster.", + "request": { + "$ref": "SetLegacyAbacRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name (project, location, cluster id) of the cluster to set legacy abac.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setLegacyAbac", + "path": "v1beta1/{+name}:setLegacyAbac", + "id": "container.projects.locations.clusters.setLegacyAbac" + }, + "setResourceLabels": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}:setResourceLabels", + "path": "v1beta1/{+name}:setResourceLabels", + "id": "container.projects.locations.clusters.setResourceLabels", + "request": { + "$ref": "SetLabelsRequest" + }, + "description": "Sets labels on a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, cluster id) of the cluster to set labels.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "nodePools": { + "methods": { + "list": { + "response": { + "$ref": "ListNodePoolsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.", + "type": "string", + "location": "query" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", + "type": "string", + "location": "query" + }, + "parent": { + "location": "path", + "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" + }, + "clusterId": { + "location": "query", + "description": "The name of the cluster.\nThis field is deprecated, use parent instead.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", + "path": "v1beta1/{+parent}/nodePools", + "id": "container.projects.locations.clusters.nodePools.list", + "description": "Lists the node pools for a cluster." + }, + "rollback": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, cluster, node pool id) of the node poll to\nrollback upgrade.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:rollback", + "path": "v1beta1/{+name}:rollback", + "id": "container.projects.locations.clusters.nodePools.rollback", + "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed.", + "request": { + "$ref": "RollbackNodePoolUpgradeRequest" + } + }, + "create": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools", + "path": "v1beta1/{+parent}/nodePools", + "id": "container.projects.locations.clusters.nodePools.create", + "request": { + "$ref": "CreateNodePoolRequest" + }, + "description": "Creates a node pool for a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "location": "path", + "description": "The parent (project, location, cluster id) where the node pool will be created.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "response": { + "$ref": "NodePool" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "nodePoolId": { + "description": "The name of the node pool.\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "name": { + "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", + "location": "path" + }, + "projectId": { + "location": "query", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "clusterId": { + "location": "query", + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", + "path": "v1beta1/{+name}", + "id": "container.projects.locations.clusters.nodePools.get", + "description": "Retrieves the node pool requested." + }, + "update": { + "httpMethod": "PUT", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name (project, location, cluster, node pool) of the node pool to update.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", + "id": "container.projects.locations.clusters.nodePools.update", + "path": "v1beta1/{+name}", + "request": { + "$ref": "UpdateNodePoolRequest" + }, + "description": "Updates the version and/or iamge type of a specific node pool." + }, + "setAutoscaling": { + "description": "Sets the autoscaling settings of a specific node pool.", + "request": { + "$ref": "SetNodePoolAutoscalingRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name (project, location, cluster, node pool) of the node pool to set\nautoscaler settings. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setAutoscaling", + "path": "v1beta1/{+name}:setAutoscaling", + "id": "container.projects.locations.clusters.nodePools.setAutoscaling" + }, + "setManagement": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}:setManagement", + "path": "v1beta1/{+name}:setManagement", + "id": "container.projects.locations.clusters.nodePools.setManagement", + "description": "Sets the NodeManagement options for a node pool.", + "request": { + "$ref": "SetNodePoolManagementRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name (project, location, cluster, node pool id) of the node pool to set\nmanagement properties. Specified in the format\n'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$", + "location": "path" + } + } + }, + "delete": { + "flatPath": "v1beta1/projects/{projectsId}/locations/{locationsId}/clusters/{clustersId}/nodePools/{nodePoolsId}", + "path": "v1beta1/{+name}", + "id": "container.projects.locations.clusters.nodePools.delete", + "description": "Deletes a node pool from a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "type": "string", + "location": "query" + }, + "clusterId": { + "location": "query", + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "nodePoolId": { + "location": "query", + "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.", + "type": "string" + }, + "name": { + "location": "path", + "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/clusters/[^/]+/nodePools/[^/]+$" + } + } + } + } + } + } + } + } + }, + "zones": { + "methods": { + "getServerconfig": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig", + "path": "v1beta1/projects/{projectId}/zones/{zone}/serverconfig", + "id": "container.projects.zones.getServerconfig", + "description": "Returns configuration info about the Kubernetes Engine service.", + "response": { + "$ref": "ServerConfig" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "GET", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "name": { + "location": "query", + "description": "The name (project and location) of the server config to get\nSpecified in the format 'projects/*/locations/*'.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + }, + "resources": { + "clusters": { + "methods": { + "master": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/master", + "id": "container.projects.zones.clusters.master", + "request": { + "$ref": "UpdateMasterRequest" + }, + "description": "Updates the master of a specific cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setMasterAuth": { + "request": { + "$ref": "SetMasterAuthRequest" + }, + "description": "Used to set master auth materials. Currently supports :-\nChanging the admin password of a specific cluster.\nThis can be either via password generation or explicitly set.\nModify basic_auth.csv and reset the K8S API server.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMasterAuth", + "id": "container.projects.zones.clusters.setMasterAuth" + }, + "logging": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/logging", + "id": "container.projects.zones.clusters.logging", + "description": "Sets the logging service of a specific cluster.", + "request": { + "$ref": "SetLoggingServiceRequest" + } + }, + "list": { + "description": "Lists all clusters owned by a project in either the specified zone or all\nzones.", + "response": { + "$ref": "ListClustersResponse" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides, or \"-\" for all zones.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string" + }, + "parent": { + "location": "query", + "description": "The parent (project and location) where the clusters will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters", + "id": "container.projects.zones.clusters.list" + }, + "create": { + "request": { + "$ref": "CreateClusterRequest" + }, + "description": "Creates a cluster, consisting of the specified number and type of Google\nCompute Engine instances.\n\nBy default, the cluster is created in the project's\n[default network](/compute/docs/networks-and-firewalls#networks).\n\nOne firewall is added for the cluster. After cluster creation,\nthe cluster creates routes for each node to allow the containers\non that node to communicate with all other instances in the\ncluster.\n\nFinally, an entry is added to the project's global metadata indicating\nwhich CIDR range is being used by the cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters", + "id": "container.projects.zones.clusters.create" + }, + "resourceLabels": { + "request": { + "$ref": "SetLabelsRequest" + }, + "description": "Sets labels on a cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels", + "id": "container.projects.zones.clusters.resourceLabels", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/resourceLabels" + }, + "completeIpRotation": { + "request": { + "$ref": "CompleteIPRotationRequest" + }, + "description": "Completes master IP rotation.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:completeIpRotation", + "id": "container.projects.zones.clusters.completeIpRotation" + }, + "legacyAbac": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/legacyAbac", + "id": "container.projects.zones.clusters.legacyAbac", + "request": { + "$ref": "SetLegacyAbacRequest" + }, + "description": "Enables or disables the ABAC authorization mechanism on a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "setNetworkPolicy": { + "request": { + "$ref": "SetNetworkPolicyRequest" + }, + "description": "Enables/Disables Network Policy for a cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy", + "id": "container.projects.zones.clusters.setNetworkPolicy", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setNetworkPolicy" + }, + "get": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "id": "container.projects.zones.clusters.get", + "description": "Gets the details of a specific cluster.", + "response": { + "$ref": "Cluster" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to retrieve.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "name": { + "location": "query", + "description": "The name (project, location, cluster) of the cluster to retrieve.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + } + }, + "startIpRotation": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:startIpRotation", + "id": "container.projects.zones.clusters.startIpRotation", + "description": "Start master IP rotation.", + "request": { + "$ref": "StartIPRotationRequest" + } + }, + "setMaintenancePolicy": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}:setMaintenancePolicy", + "id": "container.projects.zones.clusters.setMaintenancePolicy", + "description": "Sets the maintenance policy for a cluster.", + "request": { + "$ref": "SetMaintenancePolicyRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to update.", + "required": true, + "type": "string", + "location": "path" + } + } + }, + "addons": { + "description": "Sets the addons of a specific cluster.", + "request": { + "$ref": "SetAddonsConfigRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/addons", + "id": "container.projects.zones.clusters.addons" + }, + "delete": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "DELETE", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to delete.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "name": { + "location": "query", + "description": "The name (project, location, cluster) of the cluster to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "id": "container.projects.zones.clusters.delete", + "description": "Deletes the cluster, including the Kubernetes endpoint and all worker\nnodes.\n\nFirewalls and routes that were configured during cluster creation\nare also deleted.\n\nOther Google Compute Engine resources that might be in use by the cluster\n(e.g. load balancer resources) will not be deleted if they weren't present\nat the initial create time." + }, + "locations": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", + "id": "container.projects.zones.clusters.locations", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/locations", + "request": { + "$ref": "SetLocationsRequest" + }, + "description": "Sets the locations of a specific cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates the settings of a specific cluster.", + "request": { + "$ref": "UpdateClusterRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}", + "id": "container.projects.zones.clusters.update" + }, + "monitoring": { + "description": "Sets the monitoring service of a specific cluster.", + "request": { + "$ref": "SetMonitoringServiceRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/monitoring", + "id": "container.projects.zones.clusters.monitoring" + } + }, + "resources": { + "nodePools": { + "methods": { + "autoscaling": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "nodePoolId": { + "location": "path", + "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", + "id": "container.projects.zones.clusters.nodePools.autoscaling", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/autoscaling", + "request": { + "$ref": "SetNodePoolAutoscalingRequest" + }, + "description": "Sets the autoscaling settings of a specific node pool." + }, + "get": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "id": "container.projects.zones.clusters.nodePools.get", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "description": "Retrieves the node pool requested.", + "httpMethod": "GET", + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "response": { + "$ref": "NodePool" + }, + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "nodePoolId": { + "description": "The name of the node pool.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "name": { + "location": "query", + "description": "The name (project, location, cluster, node pool id) of the node pool to get.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "update": { + "description": "Updates the version and/or iamge type of a specific node pool.", + "request": { + "$ref": "UpdateNodePoolRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "nodePoolId": { + "description": "The name of the node pool to upgrade.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/update", + "id": "container.projects.zones.clusters.nodePools.update" + }, + "setManagement": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}/setManagement", + "id": "container.projects.zones.clusters.nodePools.setManagement", + "request": { + "$ref": "SetNodePoolManagementRequest" + }, + "description": "Sets the NodeManagement options for a node pool.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to update.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "nodePoolId": { + "description": "The name of the node pool to update.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}", + "id": "container.projects.zones.clusters.nodePools.delete", + "description": "Deletes a node pool from a cluster.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "httpMethod": "DELETE", + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "nodePoolId": { + "description": "The name of the node pool to delete.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "name": { + "description": "The name (project, location, cluster, node pool id) of the node pool to delete.\nSpecified in the format 'projects/*/locations/*/clusters/*/nodePools/*'.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "id": "container.projects.zones.clusters.nodePools.list", + "description": "Lists the node pools for a cluster.", + "response": { + "$ref": "ListNodePoolsResponse" + }, + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + }, + "parent": { + "location": "query", + "description": "The parent (project, location, cluster id) where the node pools will be listed.\nSpecified in the format 'projects/*/locations/*/clusters/*'.", + "type": "string" + } + } + }, + "rollback": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId", + "nodePoolId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "clusterId": { + "location": "path", + "description": "The name of the cluster to rollback.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "nodePoolId": { + "location": "path", + "description": "The name of the node pool to rollback.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", + "id": "container.projects.zones.clusters.nodePools.rollback", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools/{nodePoolId}:rollback", + "request": { + "$ref": "RollbackNodePoolUpgradeRequest" + }, + "description": "Roll back the previously Aborted or Failed NodePool upgrade.\nThis will be an no-op if the last upgrade successfully completed." + }, + "create": { + "request": { + "$ref": "CreateNodePoolRequest" + }, + "description": "Creates a node pool for a cluster.", + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "zone", + "clusterId" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://developers.google.com/console/help/new/#projectnumber).\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string" + }, + "zone": { + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterId": { + "description": "The name of the cluster.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools", + "id": "container.projects.zones.clusters.nodePools.create", + "path": "v1beta1/projects/{projectId}/zones/{zone}/clusters/{clusterId}/nodePools" + } + } + } + } + }, + "operations": { + "methods": { + "list": { + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "projectId", + "zone" + ], + "httpMethod": "GET", + "parameters": { + "projectId": { + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string", + "location": "path" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine [zone](/compute/docs/zones#available)\nto return operations for, or `-` for all zones.\nThis field is deprecated, use parent instead.", + "required": true, + "type": "string" + }, + "parent": { + "location": "query", + "description": "The parent (project and location) where the operations will be listed.\nSpecified in the format 'projects/*/locations/*'.\nLocation \"-\" matches all zones and all regions.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations", + "path": "v1beta1/projects/{projectId}/zones/{zone}/operations", + "id": "container.projects.zones.operations.list", + "description": "Lists all operations in a project in a specific zone or all zones." + }, + "get": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "zone", + "operationId" + ], + "httpMethod": "GET", + "parameters": { + "operationId": { + "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the cluster\nresides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "name": { + "location": "query", + "description": "The name (project, location, operation id) of the operation to get.\nSpecified in the format 'projects/*/locations/*/operations/*'.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}", + "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}", + "id": "container.projects.zones.operations.get", + "description": "Gets the specified operation." + }, + "cancel": { + "description": "Cancels the specified operation.", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "projectId", + "zone", + "operationId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "operationId": { + "description": "The server-assigned `name` of the operation.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "The Google Developers Console [project ID or project\nnumber](https://support.google.com/cloud/answer/6158840).\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + }, + "zone": { + "location": "path", + "description": "The name of the Google Compute Engine\n[zone](/compute/docs/zones#available) in which the operation resides.\nThis field is deprecated, use name instead.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", + "path": "v1beta1/projects/{projectId}/zones/{zone}/operations/{operationId}:cancel", + "id": "container.projects.zones.operations.cancel" + } + } + } + } + } + } + } + }, + "parameters": { + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + } + }, + "version": "v1beta1", + "baseUrl": "https://container.googleapis.com/" }
diff --git a/dataflow/v1b3/dataflow-api.json b/dataflow/v1b3/dataflow-api.json index 3bffe73..94b304a 100644 --- a/dataflow/v1b3/dataflow-api.json +++ b/dataflow/v1b3/dataflow-api.json
@@ -1,23 +1,21 @@ { - "discoveryVersion": "v1", - "ownerName": "Google", "resources": { "projects": { "methods": { "workerMessages": { - "httpMethod": "POST", - "parameterOrder": [ - "projectId" - ], "response": { "$ref": "SendWorkerMessagesResponse" }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", "parameters": { "projectId": { - "required": true, - "type": "string", "location": "path", - "description": "The project to send the WorkerMessages to." + "description": "The project to send the WorkerMessages to.", + "required": true, + "type": "string" } }, "scopes": [ @@ -27,8 +25,8 @@ "https://www.googleapis.com/auth/userinfo.email" ], "flatPath": "v1b3/projects/{projectId}/WorkerMessages", - "id": "dataflow.projects.workerMessages", "path": "v1b3/projects/{projectId}/WorkerMessages", + "id": "dataflow.projects.workerMessages", "request": { "$ref": "SendWorkerMessagesRequest" }, @@ -46,75 +44,75 @@ "response": { "$ref": "LaunchTemplateResponse" }, - "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "Required. The ID of the Cloud Platform project that the job belongs to." - }, - "gcsPath": { - "type": "string", - "location": "query", - "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'." - }, - "location": { - "type": "string", - "location": "query", - "description": "The location to which to direct the request." - }, - "validateOnly": { - "type": "boolean", - "location": "query", - "description": "If true, the request is validated but not actually executed.\nDefaults to false." - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], + "parameters": { + "validateOnly": { + "location": "query", + "description": "If true, the request is validated but not actually executed.\nDefaults to false.", + "type": "boolean" + }, + "projectId": { + "description": "Required. The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "gcsPath": { + "location": "query", + "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", + "type": "string" + }, + "location": { + "location": "query", + "description": "The location to which to direct the request.", + "type": "string" + } + }, "flatPath": "v1b3/projects/{projectId}/templates:launch", "id": "dataflow.projects.templates.launch", "path": "v1b3/projects/{projectId}/templates:launch", + "description": "Launch a template.", "request": { "$ref": "LaunchTemplateParameters" - }, - "description": "Launch a template." + } }, "get": { - "httpMethod": "GET", "response": { "$ref": "GetTemplateResponse" }, "parameterOrder": [ "projectId" ], + "httpMethod": "GET", "parameters": { "projectId": { + "description": "Required. The ID of the Cloud Platform project that the job belongs to.", "required": true, "type": "string", - "location": "path", - "description": "Required. The ID of the Cloud Platform project that the job belongs to." + "location": "path" }, "view": { - "location": "query", "enum": [ "METADATA_ONLY" ], "description": "The view to retrieve. Defaults to METADATA_ONLY.", - "type": "string" + "type": "string", + "location": "query" }, "gcsPath": { - "location": "query", "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", - "type": "string" + "type": "string", + "location": "query" }, "location": { - "type": "string", "location": "query", - "description": "The location to which to direct the request." + "description": "The location to which to direct the request.", + "type": "string" } }, "scopes": [ @@ -124,86 +122,51 @@ "https://www.googleapis.com/auth/userinfo.email" ], "flatPath": "v1b3/projects/{projectId}/templates:get", - "id": "dataflow.projects.templates.get", "path": "v1b3/projects/{projectId}/templates:get", + "id": "dataflow.projects.templates.get", "description": "Get the template associated with a template." }, "create": { - "flatPath": "v1b3/projects/{projectId}/templates", - "path": "v1b3/projects/{projectId}/templates", - "id": "dataflow.projects.templates.create", + "description": "Creates a Cloud Dataflow job from a template.", "request": { "$ref": "CreateJobFromTemplateRequest" }, - "description": "Creates a Cloud Dataflow job from a template.", - "response": { - "$ref": "Job" - }, + "httpMethod": "POST", "parameterOrder": [ "projectId" ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Cloud Platform project that the job belongs to.", - "required": true, - "type": "string" - } + "response": { + "$ref": "Job" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" - ] + ], + "parameters": { + "projectId": { + "description": "Required. The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1b3/projects/{projectId}/templates", + "id": "dataflow.projects.templates.create", + "path": "v1b3/projects/{projectId}/templates" } } }, "locations": { - "methods": { - "workerMessages": { - "response": { - "$ref": "SendWorkerMessagesResponse" - }, - "parameterOrder": [ - "projectId", - "location" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The project to send the WorkerMessages to.", - "required": true, - "type": "string" - }, - "location": { - "required": true, - "type": "string", - "location": "path", - "description": "The location which contains the job" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" - ], - "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages", - "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages", - "id": "dataflow.projects.locations.workerMessages", - "request": { - "$ref": "SendWorkerMessagesRequest" - }, - "description": "Send a worker_message to the service." - } - }, "resources": { "templates": { "methods": { "launch": { + "request": { + "$ref": "LaunchTemplateParameters" + }, + "description": "Launch a template.", "response": { "$ref": "LaunchTemplateResponse" }, @@ -212,73 +175,22 @@ "location" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" - ], "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "Required. The ID of the Cloud Platform project that the job belongs to." - }, - "gcsPath": { - "location": "query", - "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", - "type": "string" - }, - "location": { - "required": true, - "type": "string", - "location": "path", - "description": "The location to which to direct the request." - }, "validateOnly": { - "type": "boolean", "location": "query", - "description": "If true, the request is validated but not actually executed.\nDefaults to false." - } - }, - "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch", - "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch", - "id": "dataflow.projects.locations.templates.launch", - "description": "Launch a template.", - "request": { - "$ref": "LaunchTemplateParameters" - } - }, - "get": { - "description": "Get the template associated with a template.", - "response": { - "$ref": "GetTemplateResponse" - }, - "parameterOrder": [ - "projectId", - "location" - ], - "httpMethod": "GET", - "parameters": { + "description": "If true, the request is validated but not actually executed.\nDefaults to false.", + "type": "boolean" + }, "projectId": { "location": "path", "description": "Required. The ID of the Cloud Platform project that the job belongs to.", "required": true, "type": "string" }, - "view": { - "location": "query", - "enum": [ - "METADATA_ONLY" - ], - "description": "The view to retrieve. Defaults to METADATA_ONLY.", - "type": "string" - }, "gcsPath": { + "description": "Required. A Cloud Storage path to the template from which to create\nthe job.\nMust be valid Cloud Storage URL, beginning with 'gs://'.", "type": "string", - "location": "query", - "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`." + "location": "query" }, "location": { "location": "path", @@ -293,52 +205,101 @@ "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], - "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get", - "path": "v1b3/projects/{projectId}/locations/{location}/templates:get", - "id": "dataflow.projects.locations.templates.get" + "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:launch", + "path": "v1b3/projects/{projectId}/locations/{location}/templates:launch", + "id": "dataflow.projects.locations.templates.launch" }, - "create": { - "request": { - "$ref": "CreateJobFromTemplateRequest" + "get": { + "description": "Get the template associated with a template.", + "response": { + "$ref": "GetTemplateResponse" }, - "description": "Creates a Cloud Dataflow job from a template.", - "httpMethod": "POST", "parameterOrder": [ "projectId", "location" ], - "response": { - "$ref": "Job" - }, - "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "Required. The ID of the Cloud Platform project that the job belongs to." - }, - "location": { - "required": true, - "type": "string", - "location": "path", - "description": "The location to which to direct the request." - } - }, + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], + "parameters": { + "gcsPath": { + "location": "query", + "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", + "type": "string" + }, + "location": { + "description": "The location to which to direct the request.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "view": { + "location": "query", + "enum": [ + "METADATA_ONLY" + ], + "description": "The view to retrieve. Defaults to METADATA_ONLY.", + "type": "string" + } + }, + "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates:get", + "path": "v1b3/projects/{projectId}/locations/{location}/templates:get", + "id": "dataflow.projects.locations.templates.get" + }, + "create": { + "response": { + "$ref": "Job" + }, + "parameterOrder": [ + "projectId", + "location" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly", + "https://www.googleapis.com/auth/userinfo.email" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "Required. The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "location": { + "location": "path", + "description": "The location to which to direct the request.", + "required": true, + "type": "string" + } + }, "flatPath": "v1b3/projects/{projectId}/locations/{location}/templates", + "path": "v1b3/projects/{projectId}/locations/{location}/templates", "id": "dataflow.projects.locations.templates.create", - "path": "v1b3/projects/{projectId}/locations/{location}/templates" + "description": "Creates a Cloud Dataflow job from a template.", + "request": { + "$ref": "CreateJobFromTemplateRequest" + } } } }, "jobs": { "methods": { "getMetrics": { + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics", + "id": "dataflow.projects.locations.jobs.getMetrics", "description": "Request the job status.", "response": { "$ref": "JobMetrics" @@ -356,36 +317,38 @@ "https://www.googleapis.com/auth/userinfo.email" ], "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "A project id." - }, - "jobId": { - "required": true, - "type": "string", - "location": "path", - "description": "The job to get messages for." - }, - "location": { - "required": true, - "type": "string", - "location": "path", - "description": "The location which contains the job specified by job_id." - }, "startTime": { - "type": "string", "location": "query", "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", - "format": "google-datetime" + "format": "google-datetime", + "type": "string" + }, + "projectId": { + "location": "path", + "description": "A project id.", + "required": true, + "type": "string" + }, + "jobId": { + "location": "path", + "description": "The job to get messages for.", + "required": true, + "type": "string" + }, + "location": { + "location": "path", + "description": "The location which contains the job specified by job_id.", + "required": true, + "type": "string" } }, - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics", - "id": "dataflow.projects.locations.jobs.getMetrics" + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/metrics" }, "get": { + "id": "dataflow.projects.locations.jobs.get", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", + "description": "Gets the state of the specified Cloud Dataflow job.", + "httpMethod": "GET", "response": { "$ref": "Job" }, @@ -394,19 +357,12 @@ "location", "jobId" ], - "httpMethod": "GET", "parameters": { - "location": { - "location": "path", - "description": "The location that contains this job.", - "required": true, - "type": "string" - }, "projectId": { + "description": "The ID of the Cloud Platform project that the job belongs to.", "required": true, "type": "string", - "location": "path", - "description": "The ID of the Cloud Platform project that the job belongs to." + "location": "path" }, "jobId": { "location": "path", @@ -415,7 +371,6 @@ "type": "string" }, "view": { - "type": "string", "location": "query", "enum": [ "JOB_VIEW_UNKNOWN", @@ -423,7 +378,14 @@ "JOB_VIEW_ALL", "JOB_VIEW_DESCRIPTION" ], - "description": "The level of information requested in response." + "description": "The level of information requested in response.", + "type": "string" + }, + "location": { + "description": "The location that contains this job.", + "required": true, + "type": "string", + "location": "path" } }, "scopes": [ @@ -432,16 +394,9 @@ "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", - "id": "dataflow.projects.locations.jobs.get", - "description": "Gets the state of the specified Cloud Dataflow job." + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}" }, "list": { - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs", - "id": "dataflow.projects.locations.jobs.list", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs", - "description": "List the jobs of a project in a given region.", "httpMethod": "GET", "response": { "$ref": "ListJobsResponse" @@ -451,42 +406,18 @@ "location" ], "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "The project which owns the jobs." - }, - "filter": { - "type": "string", - "location": "query", - "enum": [ - "UNKNOWN", - "ALL", - "TERMINATED", - "ACTIVE" - ], - "description": "The kind of filter to use." - }, - "location": { - "required": true, - "type": "string", - "location": "path", - "description": "The location that contains this job." - }, "pageToken": { - "type": "string", "location": "query", - "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list." + "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.", + "type": "string" }, "pageSize": { - "type": "integer", "location": "query", "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.", - "format": "int32" + "format": "int32", + "type": "integer" }, "view": { - "location": "query", "enum": [ "JOB_VIEW_UNKNOWN", "JOB_VIEW_SUMMARY", @@ -494,6 +425,30 @@ "JOB_VIEW_DESCRIPTION" ], "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", + "type": "string", + "location": "query" + }, + "projectId": { + "location": "path", + "description": "The project which owns the jobs.", + "required": true, + "type": "string" + }, + "filter": { + "enum": [ + "UNKNOWN", + "ALL", + "TERMINATED", + "ACTIVE" + ], + "description": "The kind of filter to use.", + "type": "string", + "location": "query" + }, + "location": { + "location": "path", + "description": "The location that contains this job.", + "required": true, "type": "string" } }, @@ -502,16 +457,13 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" - ] + ], + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs", + "id": "dataflow.projects.locations.jobs.list", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs", + "description": "List the jobs of a project in a given region." }, "update": { - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", - "id": "dataflow.projects.locations.jobs.update", - "description": "Updates the state of an existing Cloud Dataflow job.", - "request": { - "$ref": "Job" - }, "response": { "$ref": "Job" }, @@ -528,40 +480,54 @@ "https://www.googleapis.com/auth/userinfo.email" ], "parameters": { - "projectId": { + "location": { + "description": "The location that contains this job.", "required": true, "type": "string", + "location": "path" + }, + "projectId": { "location": "path", - "description": "The ID of the Cloud Platform project that the job belongs to." + "description": "The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" }, "jobId": { + "description": "The job ID.", "required": true, "type": "string", - "location": "path", - "description": "The job ID." - }, - "location": { - "required": true, - "type": "string", - "location": "path", - "description": "The location that contains this job." + "location": "path" } + }, + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}", + "id": "dataflow.projects.locations.jobs.update", + "description": "Updates the state of an existing Cloud Dataflow job.", + "request": { + "$ref": "Job" } }, "create": { + "path": "v1b3/projects/{projectId}/locations/{location}/jobs", + "id": "dataflow.projects.locations.jobs.create", "request": { "$ref": "Job" }, "description": "Creates a Cloud Dataflow job.", - "httpMethod": "POST", + "response": { + "$ref": "Job" + }, "parameterOrder": [ "projectId", "location" ], - "response": { - "$ref": "Job" - }, + "httpMethod": "POST", "parameters": { + "replaceJobId": { + "location": "query", + "description": "Deprecated. This field is now in the Job message.", + "type": "string" + }, "projectId": { "location": "path", "description": "The ID of the Cloud Platform project that the job belongs to.", @@ -580,15 +546,10 @@ "type": "string" }, "location": { + "description": "The location that contains this job.", "required": true, "type": "string", - "location": "path", - "description": "The location that contains this job." - }, - "replaceJobId": { - "type": "string", - "location": "query", - "description": "Deprecated. This field is now in the Job message." + "location": "path" } }, "scopes": [ @@ -597,15 +558,17 @@ "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs", - "id": "dataflow.projects.locations.jobs.create", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs" + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs" } }, "resources": { "debug": { "methods": { "getConfig": { + "description": "Get encoded debug configuration for component. Not cacheable.", + "request": { + "$ref": "GetDebugConfigRequest" + }, "response": { "$ref": "GetDebugConfigResponse" }, @@ -622,59 +585,49 @@ "https://www.googleapis.com/auth/userinfo.email" ], "parameters": { + "location": { + "description": "The location which contains the job specified by job_id.", + "required": true, + "type": "string", + "location": "path" + }, "projectId": { - "location": "path", "description": "The project id.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "jobId": { - "required": true, - "type": "string", "location": "path", - "description": "The job id." - }, - "location": { + "description": "The job id.", "required": true, - "type": "string", - "location": "path", - "description": "The location which contains the job specified by job_id." + "type": "string" } }, "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig", "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/getConfig", - "id": "dataflow.projects.locations.jobs.debug.getConfig", - "description": "Get encoded debug configuration for component. Not cacheable.", - "request": { - "$ref": "GetDebugConfigRequest" - } + "id": "dataflow.projects.locations.jobs.debug.getConfig" }, "sendCapture": { - "description": "Send encoded debug capture data for component.", "request": { "$ref": "SendDebugCaptureRequest" }, - "response": { - "$ref": "SendDebugCaptureResponse" - }, + "description": "Send encoded debug capture data for component.", + "httpMethod": "POST", "parameterOrder": [ "projectId", "location", "jobId" ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" - ], + "response": { + "$ref": "SendDebugCaptureResponse" + }, "parameters": { "projectId": { - "required": true, - "type": "string", "location": "path", - "description": "The project id." + "description": "The project id.", + "required": true, + "type": "string" }, "jobId": { "location": "path", @@ -689,68 +642,36 @@ "type": "string" } }, - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture", - "id": "dataflow.projects.locations.jobs.debug.sendCapture" - } - } - }, - "workItems": { - "methods": { - "lease": { - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease", - "id": "dataflow.projects.locations.jobs.workItems.lease", - "request": { - "$ref": "LeaseWorkItemRequest" - }, - "description": "Leases a dataflow WorkItem to run.", - "response": { - "$ref": "LeaseWorkItemResponse" - }, - "parameterOrder": [ - "projectId", - "location", - "jobId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "Identifies the project this worker belongs to." - }, - "jobId": { - "location": "path", - "description": "Identifies the workflow job this worker belongs to.", - "required": true, - "type": "string" - }, - "location": { - "location": "path", - "description": "The location which contains the WorkItem's job.", - "required": true, - "type": "string" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" - ] - }, + ], + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture", + "id": "dataflow.projects.locations.jobs.debug.sendCapture", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/debug/sendCapture" + } + } + }, + "workItems": { + "methods": { "reportStatus": { - "response": { - "$ref": "ReportWorkItemStatusResponse" + "id": "dataflow.projects.locations.jobs.workItems.reportStatus", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus", + "request": { + "$ref": "ReportWorkItemStatusRequest" }, + "description": "Reports the status of dataflow WorkItems leased by a worker.", + "httpMethod": "POST", "parameterOrder": [ "projectId", "location", "jobId" ], - "httpMethod": "POST", + "response": { + "$ref": "ReportWorkItemStatusResponse" + }, "parameters": { "location": { "location": "path", @@ -759,10 +680,10 @@ "type": "string" }, "projectId": { - "location": "path", "description": "The project which owns the WorkItem's job.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "jobId": { "location": "path", @@ -777,23 +698,57 @@ "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus", - "id": "dataflow.projects.locations.jobs.workItems.reportStatus", - "request": { - "$ref": "ReportWorkItemStatusRequest" + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:reportStatus" + }, + "lease": { + "response": { + "$ref": "LeaseWorkItemResponse" }, - "description": "Reports the status of dataflow WorkItems leased by a worker." + "parameterOrder": [ + "projectId", + "location", + "jobId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly", + "https://www.googleapis.com/auth/userinfo.email" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "Identifies the project this worker belongs to.", + "required": true, + "type": "string" + }, + "jobId": { + "location": "path", + "description": "Identifies the workflow job this worker belongs to.", + "required": true, + "type": "string" + }, + "location": { + "location": "path", + "description": "The location which contains the WorkItem's job.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/workItems:lease", + "id": "dataflow.projects.locations.jobs.workItems.lease", + "description": "Leases a dataflow WorkItem to run.", + "request": { + "$ref": "LeaseWorkItemRequest" + } } } }, "messages": { "methods": { "list": { - "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages", - "id": "dataflow.projects.locations.jobs.messages.list", - "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages", - "description": "Request the job status.", "httpMethod": "GET", "parameterOrder": [ "projectId", @@ -803,25 +758,18 @@ "response": { "$ref": "ListJobMessagesResponse" }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly", + "https://www.googleapis.com/auth/userinfo.email" + ], "parameters": { - "minimumImportance": { - "location": "query", - "enum": [ - "JOB_MESSAGE_IMPORTANCE_UNKNOWN", - "JOB_MESSAGE_DEBUG", - "JOB_MESSAGE_DETAILED", - "JOB_MESSAGE_BASIC", - "JOB_MESSAGE_WARNING", - "JOB_MESSAGE_ERROR" - ], - "description": "Filter to only get messages with importance \u003e= level", - "type": "string" - }, "jobId": { + "description": "The job to get messages about.", "required": true, "type": "string", - "location": "path", - "description": "The job to get messages about." + "location": "path" }, "projectId": { "location": "path", @@ -829,53 +777,102 @@ "required": true, "type": "string" }, + "location": { + "location": "path", + "description": "The location which contains the job specified by job_id.", + "required": true, + "type": "string" + }, "endTime": { "location": "query", "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).", "format": "google-datetime", "type": "string" }, - "location": { - "location": "path", - "description": "The location which contains the job specified by job_id.", - "required": true, - "type": "string" - }, "startTime": { - "type": "string", "location": "query", "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).", - "format": "google-datetime" + "format": "google-datetime", + "type": "string" }, "pageToken": { + "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.", "type": "string", - "location": "query", - "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned." + "location": "query" }, "pageSize": { "location": "query", "description": "If specified, determines the maximum number of messages to\nreturn. If unspecified, the service may choose an appropriate\ndefault, or may return an arbitrarily large number of results.", "format": "int32", "type": "integer" + }, + "minimumImportance": { + "enum": [ + "JOB_MESSAGE_IMPORTANCE_UNKNOWN", + "JOB_MESSAGE_DEBUG", + "JOB_MESSAGE_DETAILED", + "JOB_MESSAGE_BASIC", + "JOB_MESSAGE_WARNING", + "JOB_MESSAGE_ERROR" + ], + "description": "Filter to only get messages with importance \u003e= level", + "type": "string", + "location": "query" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" - ] + "flatPath": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages", + "id": "dataflow.projects.locations.jobs.messages.list", + "path": "v1b3/projects/{projectId}/locations/{location}/jobs/{jobId}/messages", + "description": "Request the job status." } } } } } + }, + "methods": { + "workerMessages": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId", + "location" + ], + "response": { + "$ref": "SendWorkerMessagesResponse" + }, + "parameters": { + "location": { + "description": "The location which contains the job", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "The project to send the WorkerMessages to.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly", + "https://www.googleapis.com/auth/userinfo.email" + ], + "flatPath": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages", + "id": "dataflow.projects.locations.workerMessages", + "path": "v1b3/projects/{projectId}/locations/{location}/WorkerMessages", + "request": { + "$ref": "SendWorkerMessagesRequest" + }, + "description": "Send a worker_message to the service." + } } }, "jobs": { "methods": { "aggregated": { - "flatPath": "v1b3/projects/{projectId}/jobs:aggregated", "path": "v1b3/projects/{projectId}/jobs:aggregated", "id": "dataflow.projects.jobs.aggregated", "description": "List the jobs of a project across all regions.", @@ -894,7 +891,6 @@ "type": "string" }, "filter": { - "type": "string", "location": "query", "enum": [ "UNKNOWN", @@ -902,34 +898,35 @@ "TERMINATED", "ACTIVE" ], - "description": "The kind of filter to use." + "description": "The kind of filter to use.", + "type": "string" }, "location": { + "description": "The location that contains this job.", "type": "string", - "location": "query", - "description": "The location that contains this job." + "location": "query" }, "pageToken": { + "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list.", "type": "string", - "location": "query", - "description": "Set this to the 'next_page_token' field of a previous response\nto request additional results in a long list." + "location": "query" }, "pageSize": { - "type": "integer", "location": "query", "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.", - "format": "int32" + "format": "int32", + "type": "integer" }, "view": { - "type": "string", - "location": "query", "enum": [ "JOB_VIEW_UNKNOWN", "JOB_VIEW_SUMMARY", "JOB_VIEW_ALL", "JOB_VIEW_DESCRIPTION" ], - "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`." + "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", + "type": "string", + "location": "query" } }, "scopes": [ @@ -937,10 +934,10 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" - ] + ], + "flatPath": "v1b3/projects/{projectId}/jobs:aggregated" }, "list": { - "description": "List the jobs of a project in a given region.", "httpMethod": "GET", "response": { "$ref": "ListJobsResponse" @@ -949,12 +946,6 @@ "projectId" ], "parameters": { - "projectId": { - "location": "path", - "description": "The project which owns the jobs.", - "required": true, - "type": "string" - }, "filter": { "location": "query", "enum": [ @@ -977,13 +968,12 @@ "type": "string" }, "pageSize": { - "type": "integer", - "location": "query", "description": "If there are many jobs, limit response to at most this many.\nThe actual number of jobs returned will be the lesser of max_responses\nand an unspecified server-defined limit.", - "format": "int32" + "format": "int32", + "type": "integer", + "location": "query" }, "view": { - "type": "string", "location": "query", "enum": [ "JOB_VIEW_UNKNOWN", @@ -991,7 +981,14 @@ "JOB_VIEW_ALL", "JOB_VIEW_DESCRIPTION" ], - "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`." + "description": "Level of information requested in response. Default is `JOB_VIEW_SUMMARY`.", + "type": "string" + }, + "projectId": { + "description": "The project which owns the jobs.", + "required": true, + "type": "string", + "location": "path" } }, "scopes": [ @@ -1002,71 +999,20 @@ ], "flatPath": "v1b3/projects/{projectId}/jobs", "id": "dataflow.projects.jobs.list", - "path": "v1b3/projects/{projectId}/jobs" + "path": "v1b3/projects/{projectId}/jobs", + "description": "List the jobs of a project in a given region." }, "create": { - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" - ], - "parameters": { - "location": { - "location": "query", - "description": "The location that contains this job.", - "type": "string" - }, - "replaceJobId": { - "location": "query", - "description": "Deprecated. This field is now in the Job message.", - "type": "string" - }, - "projectId": { - "location": "path", - "description": "The ID of the Cloud Platform project that the job belongs to.", - "required": true, - "type": "string" - }, - "view": { - "type": "string", - "location": "query", - "enum": [ - "JOB_VIEW_UNKNOWN", - "JOB_VIEW_SUMMARY", - "JOB_VIEW_ALL", - "JOB_VIEW_DESCRIPTION" - ], - "description": "The level of information requested in response." - } - }, - "flatPath": "v1b3/projects/{projectId}/jobs", - "path": "v1b3/projects/{projectId}/jobs", - "id": "dataflow.projects.jobs.create", "description": "Creates a Cloud Dataflow job.", "request": { "$ref": "Job" - } - }, - "getMetrics": { - "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics", - "id": "dataflow.projects.jobs.getMetrics", - "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics", - "description": "Request the job status.", - "httpMethod": "GET", + }, + "httpMethod": "POST", "parameterOrder": [ - "projectId", - "jobId" + "projectId" ], "response": { - "$ref": "JobMetrics" + "$ref": "Job" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -1075,53 +1021,17 @@ "https://www.googleapis.com/auth/userinfo.email" ], "parameters": { - "projectId": { - "location": "path", - "description": "A project id.", - "required": true, - "type": "string" - }, - "jobId": { - "required": true, + "replaceJobId": { + "description": "Deprecated. This field is now in the Job message.", "type": "string", - "location": "path", - "description": "The job to get messages for." + "location": "query" }, - "location": { - "type": "string", - "location": "query", - "description": "The location which contains the job specified by job_id." - }, - "startTime": { - "type": "string", - "location": "query", - "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", - "format": "google-datetime" - } - } - }, - "get": { - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId", - "jobId" - ], - "httpMethod": "GET", - "parameters": { "projectId": { "location": "path", "description": "The ID of the Cloud Platform project that the job belongs to.", "required": true, "type": "string" }, - "jobId": { - "required": true, - "type": "string", - "location": "path", - "description": "The job ID." - }, "view": { "location": "query", "enum": [ @@ -1134,8 +1044,47 @@ "type": "string" }, "location": { - "location": "query", "description": "The location that contains this job.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1b3/projects/{projectId}/jobs", + "id": "dataflow.projects.jobs.create", + "path": "v1b3/projects/{projectId}/jobs" + }, + "getMetrics": { + "description": "Request the job status.", + "httpMethod": "GET", + "response": { + "$ref": "JobMetrics" + }, + "parameterOrder": [ + "projectId", + "jobId" + ], + "parameters": { + "startTime": { + "description": "Return only metric data that has changed since this time.\nDefault is to return all information about all metrics for the job.", + "format": "google-datetime", + "type": "string", + "location": "query" + }, + "projectId": { + "location": "path", + "description": "A project id.", + "required": true, + "type": "string" + }, + "jobId": { + "description": "The job to get messages for.", + "required": true, + "type": "string", + "location": "path" + }, + "location": { + "location": "query", + "description": "The location which contains the job specified by job_id.", "type": "string" } }, @@ -1145,12 +1094,65 @@ "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], + "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/metrics", + "id": "dataflow.projects.jobs.getMetrics", + "path": "v1b3/projects/{projectId}/jobs/{jobId}/metrics" + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "projectId", + "jobId" + ], + "response": { + "$ref": "Job" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly", + "https://www.googleapis.com/auth/userinfo.email" + ], + "parameters": { + "location": { + "location": "query", + "description": "The location that contains this job.", + "type": "string" + }, + "projectId": { + "description": "The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "jobId": { + "description": "The job ID.", + "required": true, + "type": "string", + "location": "path" + }, + "view": { + "location": "query", + "enum": [ + "JOB_VIEW_UNKNOWN", + "JOB_VIEW_SUMMARY", + "JOB_VIEW_ALL", + "JOB_VIEW_DESCRIPTION" + ], + "description": "The level of information requested in response.", + "type": "string" + } + }, "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}", - "path": "v1b3/projects/{projectId}/jobs/{jobId}", "id": "dataflow.projects.jobs.get", + "path": "v1b3/projects/{projectId}/jobs/{jobId}", "description": "Gets the state of the specified Cloud Dataflow job." }, "update": { + "description": "Updates the state of an existing Cloud Dataflow job.", + "request": { + "$ref": "Job" + }, "response": { "$ref": "Job" }, @@ -1159,65 +1161,54 @@ "jobId" ], "httpMethod": "PUT", - "parameters": { - "location": { - "location": "query", - "description": "The location that contains this job.", - "type": "string" - }, - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "The ID of the Cloud Platform project that the job belongs to." - }, - "jobId": { - "location": "path", - "description": "The job ID.", - "required": true, - "type": "string" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], + "parameters": { + "projectId": { + "description": "The ID of the Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "jobId": { + "description": "The job ID.", + "required": true, + "type": "string", + "location": "path" + }, + "location": { + "location": "query", + "description": "The location that contains this job.", + "type": "string" + } + }, "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}", "path": "v1b3/projects/{projectId}/jobs/{jobId}", - "id": "dataflow.projects.jobs.update", - "request": { - "$ref": "Job" - }, - "description": "Updates the state of an existing Cloud Dataflow job." + "id": "dataflow.projects.jobs.update" } }, "resources": { "debug": { "methods": { "getConfig": { - "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig", - "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig", - "id": "dataflow.projects.jobs.debug.getConfig", - "request": { - "$ref": "GetDebugConfigRequest" - }, - "description": "Get encoded debug configuration for component. Not cacheable.", - "response": { - "$ref": "GetDebugConfigResponse" - }, + "httpMethod": "POST", "parameterOrder": [ "projectId", "jobId" ], - "httpMethod": "POST", + "response": { + "$ref": "GetDebugConfigResponse" + }, "parameters": { "projectId": { + "description": "The project id.", "required": true, "type": "string", - "location": "path", - "description": "The project id." + "location": "path" }, "jobId": { "location": "path", @@ -1231,12 +1222,16 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" - ] + ], + "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig", + "id": "dataflow.projects.jobs.debug.getConfig", + "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/getConfig", + "request": { + "$ref": "GetDebugConfigRequest" + }, + "description": "Get encoded debug configuration for component. Not cacheable." }, "sendCapture": { - "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture", - "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture", - "id": "dataflow.projects.jobs.debug.sendCapture", "request": { "$ref": "SendDebugCaptureRequest" }, @@ -1251,16 +1246,16 @@ "httpMethod": "POST", "parameters": { "projectId": { - "location": "path", "description": "The project id.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "jobId": { - "location": "path", "description": "The job id.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ @@ -1268,50 +1263,57 @@ "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" - ] + ], + "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture", + "path": "v1b3/projects/{projectId}/jobs/{jobId}/debug/sendCapture", + "id": "dataflow.projects.jobs.debug.sendCapture" } } }, "workItems": { "methods": { "reportStatus": { - "response": { - "$ref": "ReportWorkItemStatusResponse" - }, + "httpMethod": "POST", "parameterOrder": [ "projectId", "jobId" ], - "httpMethod": "POST", + "response": { + "$ref": "ReportWorkItemStatusResponse" + }, + "parameters": { + "projectId": { + "description": "The project which owns the WorkItem's job.", + "required": true, + "type": "string", + "location": "path" + }, + "jobId": { + "description": "The job which the WorkItem is part of.", + "required": true, + "type": "string", + "location": "path" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute", "https://www.googleapis.com/auth/compute.readonly", "https://www.googleapis.com/auth/userinfo.email" ], - "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "The project which owns the WorkItem's job." - }, - "jobId": { - "location": "path", - "description": "The job which the WorkItem is part of.", - "required": true, - "type": "string" - } - }, "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus", - "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus", "id": "dataflow.projects.jobs.workItems.reportStatus", - "description": "Reports the status of dataflow WorkItems leased by a worker.", + "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:reportStatus", "request": { "$ref": "ReportWorkItemStatusRequest" - } + }, + "description": "Reports the status of dataflow WorkItems leased by a worker." }, "lease": { + "request": { + "$ref": "LeaseWorkItemRequest" + }, + "description": "Leases a dataflow WorkItem to run.", "httpMethod": "POST", "parameterOrder": [ "projectId", @@ -1328,10 +1330,10 @@ "type": "string" }, "jobId": { - "required": true, - "type": "string", "location": "path", - "description": "Identifies the workflow job this worker belongs to." + "description": "Identifies the workflow job this worker belongs to.", + "required": true, + "type": "string" } }, "scopes": [ @@ -1342,18 +1344,13 @@ ], "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease", "id": "dataflow.projects.jobs.workItems.lease", - "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease", - "request": { - "$ref": "LeaseWorkItemRequest" - }, - "description": "Leases a dataflow WorkItem to run." + "path": "v1b3/projects/{projectId}/jobs/{jobId}/workItems:lease" } } }, "messages": { "methods": { "list": { - "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages", "path": "v1b3/projects/{projectId}/jobs/{jobId}/messages", "id": "dataflow.projects.jobs.messages.list", "description": "Request the job status.", @@ -1365,45 +1362,39 @@ "jobId" ], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly", - "https://www.googleapis.com/auth/userinfo.email" - ], "parameters": { - "projectId": { - "required": true, - "type": "string", - "location": "path", - "description": "A project id." - }, "jobId": { - "location": "path", "description": "The job to get messages about.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, - "location": { - "location": "query", - "description": "The location which contains the job specified by job_id.", - "type": "string" + "projectId": { + "description": "A project id.", + "required": true, + "type": "string", + "location": "path" }, "endTime": { - "location": "query", "description": "Return only messages with timestamps \u003c end_time. The default is now\n(i.e. return up to the latest messages available).", "format": "google-datetime", - "type": "string" - }, - "pageToken": { "type": "string", - "location": "query", - "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned." + "location": "query" + }, + "location": { + "description": "The location which contains the job specified by job_id.", + "type": "string", + "location": "query" }, "startTime": { - "location": "query", "description": "If specified, return only messages with timestamps \u003e= start_time.\nThe default is the job creation time (i.e. beginning of messages).", "format": "google-datetime", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "If supplied, this should be the value of next_page_token returned\nby an earlier call. This will cause the next page of results to\nbe returned.", "type": "string" }, "pageSize": { @@ -1413,8 +1404,6 @@ "type": "integer" }, "minimumImportance": { - "type": "string", - "location": "query", "enum": [ "JOB_MESSAGE_IMPORTANCE_UNKNOWN", "JOB_MESSAGE_DEBUG", @@ -1423,9 +1412,18 @@ "JOB_MESSAGE_WARNING", "JOB_MESSAGE_ERROR" ], - "description": "Filter to only get messages with importance \u003e= level" + "description": "Filter to only get messages with importance \u003e= level", + "type": "string", + "location": "query" } - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly", + "https://www.googleapis.com/auth/userinfo.email" + ], + "flatPath": "v1b3/projects/{projectId}/jobs/{jobId}/messages" } } } @@ -1435,50 +1433,54 @@ } }, "parameters": { - "pp": { - "type": "boolean", - "default": "true", + "quotaUser": { "location": "query", - "description": "Pretty-print response." + "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.", + "type": "string" }, - "bearer_token": { - "type": "string", + "pp": { "location": "query", - "description": "OAuth bearer token." + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" }, "oauth_token": { - "location": "query", "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", "type": "string" }, "upload_protocol": { - "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query", - "description": "Returns response with indentations and line breaks." - }, - "uploadType": { - "type": "string", - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." + "default": "true" }, "fields": { - "type": "string", "location": "query", - "description": "Selector specifying which fields to include in a partial response." + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" }, "callback": { + "description": "JSONP", "type": "string", - "location": "query", - "description": "JSONP" + "location": "query" }, "$.xgafv": { - "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -1488,9 +1490,11 @@ "1", "2" ], - "description": "V1 error format." + "description": "V1 error format.", + "type": "string" }, "alt": { + "description": "Data format for response.", "default": "json", "enum": [ "json", @@ -1503,1258 +1507,22 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], + "location": "query" + }, + "access_token": { "location": "query", - "description": "Data format for response." + "description": "OAuth access token.", + "type": "string" }, "key": { "location": "query", "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.", "type": "string" - }, - "access_token": { - "type": "string", - "location": "query", - "description": "OAuth access token." - }, - "quotaUser": { - "type": "string", - "location": "query", - "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." } }, "schemas": { - "WorkItemStatus": { - "type": "object", - "properties": { - "reportedProgress": { - "$ref": "ApproximateReportedProgress", - "description": "The worker's progress through this WorkItem." - }, - "sourceFork": { - "$ref": "SourceFork", - "description": "DEPRECATED in favor of dynamic_source_split." - }, - "totalThrottlerWaitTimeSeconds": { - "type": "number", - "description": "Total time the worker spent being throttled by external systems.", - "format": "double" - }, - "counterUpdates": { - "description": "Worker output counters for this WorkItem.", - "type": "array", - "items": { - "$ref": "CounterUpdate" - } - }, - "workItemId": { - "description": "Identifies the WorkItem.", - "type": "string" - }, - "metricUpdates": { - "description": "DEPRECATED in favor of counter_updates.", - "type": "array", - "items": { - "$ref": "MetricUpdate" - } - }, - "errors": { - "type": "array", - "items": { - "$ref": "Status" - }, - "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed." - }, - "dynamicSourceSplit": { - "$ref": "DynamicSourceSplit", - "description": "See documentation of stop_position." - }, - "sourceOperationResponse": { - "$ref": "SourceOperationResponse", - "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation." - }, - "progress": { - "$ref": "ApproximateProgress", - "description": "DEPRECATED in favor of reported_progress." - }, - "requestedLeaseDuration": { - "type": "string", - "description": "Amount of time the worker requests for its lease.", - "format": "google-duration" - }, - "reportIndex": { - "type": "string", - "description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.", - "format": "int64" - }, - "stopPosition": { - "$ref": "Position", - "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc." - }, - "completed": { - "description": "True if the WorkItem was completed (successfully or unsuccessfully).", - "type": "boolean" - } - }, - "id": "WorkItemStatus", - "description": "Conveys a worker's progress through the work described by a WorkItem." - }, - "ComponentSource": { - "type": "object", - "properties": { - "originalTransformOrCollection": { - "type": "string", - "description": "User name for the original user transform or collection with which this\nsource is most closely associated." - }, - "name": { - "type": "string", - "description": "Dataflow service generated name for this source." - }, - "userName": { - "type": "string", - "description": "Human-readable name for this transform; may be user or system generated." - } - }, - "id": "ComponentSource", - "description": "Description of an interstitial value between transforms in an execution\nstage." - }, - "Histogram": { - "type": "object", - "properties": { - "firstBucketOffset": { - "description": "Starting index of first stored bucket. The non-inclusive upper-bound of\nthe ith bucket is given by:\n pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]", - "format": "int32", - "type": "integer" - }, - "bucketCounts": { - "type": "array", - "items": { - "format": "int64", - "type": "string" - }, - "description": "Counts of values in each bucket. For efficiency, prefix and trailing\nbuckets with count = 0 are elided. Buckets can store the full range of\nvalues of an unsigned long, with ULLONG_MAX falling into the 59th bucket\nwith range [1e19, 2e19)." - } - }, - "id": "Histogram", - "description": "Histogram of value counts for a distribution.\n\nBuckets have an inclusive lower bound and exclusive upper bound and use\n\"1,2,5 bucketing\": The first bucket range is from [0,1) and all subsequent\nbucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket\nboundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ...\nNegative values are not supported." - }, - "WorkItemServiceState": { - "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.", - "type": "object", - "properties": { - "suggestedStopPoint": { - "$ref": "ApproximateProgress", - "description": "DEPRECATED in favor of split_request." - }, - "splitRequest": { - "$ref": "ApproximateSplitRequest", - "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task." - }, - "suggestedStopPosition": { - "$ref": "Position", - "description": "Obsolete, always empty." - }, - "reportStatusInterval": { - "type": "string", - "description": "New recommended reporting interval.", - "format": "google-duration" - }, - "harnessData": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Other data returned by the service, specific to the particular\nworker harness.", - "type": "object" - }, - "leaseExpireTime": { - "description": "Time at which the current lease will expire.", - "format": "google-datetime", - "type": "string" - }, - "metricShortId": { - "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics.", - "type": "array", - "items": { - "$ref": "MetricShortId" - } - }, - "nextReportIndex": { - "type": "string", - "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.", - "format": "int64" - } - }, - "id": "WorkItemServiceState" - }, - "MetricStructuredName": { - "description": "Identifies a metric, by describing the source which generated the\nmetric.", - "type": "object", - "properties": { - "context": { - "additionalProperties": { - "type": "string" - }, - "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.", - "type": "object" - }, - "origin": { - "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.", - "type": "string" - }, - "name": { - "description": "Worker-defined metric name.", - "type": "string" - } - }, - "id": "MetricStructuredName" - }, - "SeqMapTaskOutputInfo": { - "description": "Information about an output of a SeqMapTask.", - "type": "object", - "properties": { - "sink": { - "$ref": "Sink", - "description": "The sink to write the output value to." - }, - "tag": { - "description": "The id of the TupleTag the user code will tag the output value by.", - "type": "string" - } - }, - "id": "SeqMapTaskOutputInfo" - }, - "JobExecutionStageInfo": { - "type": "object", - "properties": { - "stepName": { - "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "JobExecutionStageInfo", - "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed." - }, - "KeyRangeLocation": { - "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.", - "type": "object", - "properties": { - "start": { - "type": "string", - "description": "The start (inclusive) of the key range." - }, - "dataDisk": { - "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", - "type": "string" - }, - "end": { - "type": "string", - "description": "The end (exclusive) of the key range." - }, - "deprecatedPersistentDirectory": { - "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.", - "type": "string" - }, - "deliveryEndpoint": { - "type": "string", - "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery." - } - }, - "id": "KeyRangeLocation" - }, - "SourceGetMetadataRequest": { - "description": "A request to compute the SourceMetadata of a Source.", - "type": "object", - "properties": { - "source": { - "$ref": "Source", - "description": "Specification of the source whose metadata should be computed." - } - }, - "id": "SourceGetMetadataRequest" - }, - "SeqMapTask": { - "description": "Describes a particular function to invoke.", - "type": "object", - "properties": { - "stageName": { - "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.", - "type": "string" - }, - "systemName": { - "type": "string", - "description": "System-defined name of the SeqDo operation.\nUnique across the workflow." - }, - "userFn": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "The user function to invoke." - }, - "name": { - "description": "The user-provided name of the SeqDo operation.", - "type": "string" - }, - "outputInfos": { - "description": "Information about each of the outputs.", - "type": "array", - "items": { - "$ref": "SeqMapTaskOutputInfo" - } - }, - "inputs": { - "description": "Information about each of the inputs.", - "type": "array", - "items": { - "$ref": "SideInputInfo" - } - } - }, - "id": "SeqMapTask" - }, - "NameAndKind": { - "description": "Basic metadata about a counter.", - "type": "object", - "properties": { - "name": { - "description": "Name of the counter.", - "type": "string" - }, - "kind": { - "enum": [ - "INVALID", - "SUM", - "MAX", - "MIN", - "MEAN", - "OR", - "AND", - "SET", - "DISTRIBUTION" - ], - "description": "Counter aggregation kind.", - "type": "string", - "enumDescriptions": [ - "Counter aggregation kind was not set.", - "Aggregated value is the sum of all contributed values.", - "Aggregated value is the max of all contributed values.", - "Aggregated value is the min of all contributed values.", - "Aggregated value is the mean of all contributed values.", - "Aggregated value represents the logical 'or' of all contributed values.", - "Aggregated value represents the logical 'and' of all contributed values.", - "Aggregated value is a set of unique contributed values.", - "Aggregated value captures statistics about a distribution." - ] - } - }, - "id": "NameAndKind" - }, - "WorkerMessageCode": { - "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).", - "type": "object", - "properties": { - "code": { - "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.", - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages." - } - }, - "id": "WorkerMessageCode" - }, - "CustomSourceLocation": { - "description": "Identifies the location of a custom souce.", - "type": "object", - "properties": { - "stateful": { - "description": "Whether this source is stateful.", - "type": "boolean" - } - }, - "id": "CustomSourceLocation" - }, - "MapTask": { - "type": "object", - "properties": { - "systemName": { - "type": "string", - "description": "System-defined name of this MapTask.\nUnique across the workflow." - }, - "stageName": { - "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.", - "type": "string" - }, - "instructions": { - "description": "The instructions in the MapTask.", - "type": "array", - "items": { - "$ref": "ParallelInstruction" - } - } - }, - "id": "MapTask", - "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output." - }, - "FloatingPointMean": { - "type": "object", - "properties": { - "count": { - "$ref": "SplitInt64", - "description": "The number of values being aggregated." - }, - "sum": { - "description": "The sum of all values being aggregated.", - "format": "double", - "type": "number" - } - }, - "id": "FloatingPointMean", - "description": "A representation of a floating point mean metric contribution." - }, - "ReportWorkItemStatusResponse": { - "type": "object", - "properties": { - "workItemServiceStates": { - "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.", - "type": "array", - "items": { - "$ref": "WorkItemServiceState" - } - } - }, - "id": "ReportWorkItemStatusResponse", - "description": "Response from a request to report the status of WorkItems." - }, - "InstructionOutput": { - "type": "object", - "properties": { - "systemName": { - "description": "System-defined name of this output.\nUnique across the workflow.", - "type": "string" - }, - "onlyCountKeyBytes": { - "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.", - "type": "boolean" - }, - "onlyCountValueBytes": { - "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.", - "type": "boolean" - }, - "codec": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "The codec to use to encode data being written via this output." - }, - "name": { - "type": "string", - "description": "The user-provided name of this output." - }, - "originalName": { - "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.", - "type": "string" - } - }, - "id": "InstructionOutput", - "description": "An output of an instruction." - }, - "CreateJobFromTemplateRequest": { - "type": "object", - "properties": { - "location": { - "description": "The location to which to direct the request.", - "type": "string" - }, - "parameters": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "The runtime parameters to pass to the job." - }, - "jobName": { - "type": "string", - "description": "Required. The job name to use for the created job." - }, - "gcsPath": { - "type": "string", - "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`." - }, - "environment": { - "$ref": "RuntimeEnvironment", - "description": "The runtime environment for the job." - } - }, - "id": "CreateJobFromTemplateRequest", - "description": "A request to create a Cloud Dataflow job from a template." - }, - "IntegerMean": { - "description": "A representation of an integer mean metric contribution.", - "type": "object", - "properties": { - "count": { - "$ref": "SplitInt64", - "description": "The number of values being aggregated." - }, - "sum": { - "$ref": "SplitInt64", - "description": "The sum of all values being aggregated." - } - }, - "id": "IntegerMean" - }, - "ListJobsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "description": "Set if there may be more results than fit in this response." - }, - "failedLocation": { - "type": "array", - "items": { - "$ref": "FailedLocation" - }, - "description": "Zero or more messages describing locations that failed to respond." - }, - "jobs": { - "type": "array", - "items": { - "$ref": "Job" - }, - "description": "A subset of the requested job information." - } - }, - "id": "ListJobsResponse", - "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest." - }, - "ComputationTopology": { - "type": "object", - "properties": { - "systemStageName": { - "description": "The system stage name.", - "type": "string" - }, - "computationId": { - "description": "The ID of the computation.", - "type": "string" - }, - "inputs": { - "description": "The inputs to the computation.", - "type": "array", - "items": { - "$ref": "StreamLocation" - } - }, - "keyRanges": { - "description": "The key ranges processed by the computation.", - "type": "array", - "items": { - "$ref": "KeyRangeLocation" - } - }, - "stateFamilies": { - "type": "array", - "items": { - "$ref": "StateFamilyConfig" - }, - "description": "The state family values." - }, - "outputs": { - "type": "array", - "items": { - "$ref": "StreamLocation" - }, - "description": "The outputs from the computation." - } - }, - "id": "ComputationTopology", - "description": "All configuration data for a particular Computation." - }, - "RuntimeEnvironment": { - "type": "object", - "properties": { - "additionalExperiments": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Additional experiment flags for the job." - }, - "maxWorkers": { - "type": "integer", - "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.", - "format": "int32" - }, - "serviceAccountEmail": { - "description": "The email address of the service account to run the job as.", - "type": "string" - }, - "tempLocation": { - "type": "string", - "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`." - }, - "bypassTempDirValidation": { - "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.", - "type": "boolean" - }, - "machineType": { - "type": "string", - "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified." - }, - "zone": { - "type": "string", - "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline." - } - }, - "id": "RuntimeEnvironment", - "description": "The environment values to set at runtime." - }, - "StreamingSideInputLocation": { - "description": "Identifies the location of a streaming side input.", - "type": "object", - "properties": { - "stateFamily": { - "description": "Identifies the state family where this side input is stored.", - "type": "string" - }, - "tag": { - "description": "Identifies the particular side input within the streaming Dataflow job.", - "type": "string" - } - }, - "id": "StreamingSideInputLocation" - }, - "MountedDataDisk": { - "description": "Describes mounted data disk.", - "type": "object", - "properties": { - "dataDisk": { - "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", - "type": "string" - } - }, - "id": "MountedDataDisk" - }, - "LaunchTemplateResponse": { - "type": "object", - "properties": { - "job": { - "$ref": "Job", - "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched." - } - }, - "id": "LaunchTemplateResponse", - "description": "Response to the request to launch a template." - }, - "DerivedSource": { - "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.", - "type": "object", - "properties": { - "derivationMode": { - "type": "string", - "enumDescriptions": [ - "The source derivation is unknown, or unspecified.", - "Produce a completely independent Source with no base.", - "Produce a Source based on the Source being split.", - "Produce a Source based on the base of the Source being split." - ], - "enum": [ - "SOURCE_DERIVATION_MODE_UNKNOWN", - "SOURCE_DERIVATION_MODE_INDEPENDENT", - "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", - "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" - ], - "description": "What source to base the produced source on (if any)." - }, - "source": { - "$ref": "Source", - "description": "Specification of the source." - } - }, - "id": "DerivedSource" - }, - "DynamicSourceSplit": { - "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.", - "type": "object", - "properties": { - "primary": { - "$ref": "DerivedSource", - "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current." - }, - "residual": { - "$ref": "DerivedSource", - "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source." - } - }, - "id": "DynamicSourceSplit" - }, - "Job": { - "description": "Defines a job to be run by the Cloud Dataflow service.", - "type": "object", - "properties": { - "replacedByJobId": { - "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.", - "type": "string" - }, - "steps": { - "type": "array", - "items": { - "$ref": "Step" - }, - "description": "The top-level steps that constitute the entire job." - }, - "id": { - "type": "string", - "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job." - }, - "executionInfo": { - "$ref": "JobExecutionInfo", - "description": "Deprecated." - }, - "currentState": { - "type": "string", - "enumDescriptions": [ - "The job's run state isn't specified.", - "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.", - "`JOB_STATE_RUNNING` indicates that the job is currently running.", - "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.", - "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.", - "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.", - "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.", - "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.", - "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.", - "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.", - "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'." - ], - "enum": [ - "JOB_STATE_UNKNOWN", - "JOB_STATE_STOPPED", - "JOB_STATE_RUNNING", - "JOB_STATE_DONE", - "JOB_STATE_FAILED", - "JOB_STATE_CANCELLED", - "JOB_STATE_UPDATED", - "JOB_STATE_DRAINING", - "JOB_STATE_DRAINED", - "JOB_STATE_PENDING", - "JOB_STATE_CANCELLING" - ], - "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it." - }, - "location": { - "type": "string", - "description": "The location that contains this job." - }, - "currentStateTime": { - "description": "The timestamp associated with the current state.", - "format": "google-datetime", - "type": "string" - }, - "transformNameMapping": { - "additionalProperties": { - "type": "string" - }, - "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.", - "type": "object" - }, - "createTime": { - "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.", - "format": "google-datetime", - "type": "string" - }, - "environment": { - "$ref": "Environment", - "description": "The environment for the job." - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize." - }, - "stageStates": { - "type": "array", - "items": { - "$ref": "ExecutionStageState" - }, - "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it." - }, - "projectId": { - "description": "The ID of the Cloud Platform project that the job belongs to.", - "type": "string" - }, - "type": { - "enum": [ - "JOB_TYPE_UNKNOWN", - "JOB_TYPE_BATCH", - "JOB_TYPE_STREAMING" - ], - "description": "The type of Cloud Dataflow job.", - "type": "string", - "enumDescriptions": [ - "The type of the job is unspecified, or unknown.", - "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.", - "A continuously streaming job with no end: data is read,\nprocessed, and written continuously." - ] - }, - "pipelineDescription": { - "$ref": "PipelineDescription", - "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL." - }, - "replaceJobId": { - "type": "string", - "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job." - }, - "requestedState": { - "type": "string", - "enumDescriptions": [ - "The job's run state isn't specified.", - "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.", - "`JOB_STATE_RUNNING` indicates that the job is currently running.", - "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.", - "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.", - "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.", - "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.", - "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.", - "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.", - "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.", - "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'." - ], - "enum": [ - "JOB_STATE_UNKNOWN", - "JOB_STATE_STOPPED", - "JOB_STATE_RUNNING", - "JOB_STATE_DONE", - "JOB_STATE_FAILED", - "JOB_STATE_CANCELLED", - "JOB_STATE_UPDATED", - "JOB_STATE_DRAINING", - "JOB_STATE_DRAINED", - "JOB_STATE_PENDING", - "JOB_STATE_CANCELLING" - ], - "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state." - }, - "tempFiles": { - "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", - "type": "array", - "items": { - "type": "string" - } - }, - "clientRequestId": { - "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.", - "type": "string" - }, - "name": { - "type": "string", - "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`" - } - }, - "id": "Job" - }, - "SourceOperationResponse": { - "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.", - "type": "object", - "properties": { - "split": { - "$ref": "SourceSplitResponse", - "description": "A response to a request to split a source." - }, - "getMetadata": { - "$ref": "SourceGetMetadataResponse", - "description": "A response to a request to get metadata about a source." - } - }, - "id": "SourceOperationResponse" - }, - "SendDebugCaptureResponse": { - "type": "object", - "properties": {}, - "id": "SendDebugCaptureResponse", - "description": "Response to a send capture request.\nnothing" - }, - "SideInputInfo": { - "description": "Information about a side input of a DoFn or an input of a SeqDoFn.", - "type": "object", - "properties": { - "sources": { - "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.", - "type": "array", - "items": { - "$ref": "Source" - } - }, - "kind": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "How to interpret the source element(s) as a side input value." - }, - "tag": { - "type": "string", - "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo." - } - }, - "id": "SideInputInfo" - }, - "CounterStructuredNameAndMetadata": { - "type": "object", - "properties": { - "metadata": { - "$ref": "CounterMetadata", - "description": "Metadata associated with a counter" - }, - "name": { - "$ref": "CounterStructuredName", - "description": "Structured name of the counter." - } - }, - "id": "CounterStructuredNameAndMetadata", - "description": "A single message which encapsulates structured name and metadata for a given\ncounter." - }, - "ConcatPosition": { - "type": "object", - "properties": { - "position": { - "$ref": "Position", - "description": "Position within the inner source." - }, - "index": { - "type": "integer", - "description": "Index of the inner source.", - "format": "int32" - } - }, - "id": "ConcatPosition", - "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources." - }, - "WriteInstruction": { - "description": "An instruction that writes records.\nTakes one input, produces no outputs.", - "type": "object", - "properties": { - "input": { - "$ref": "InstructionInput", - "description": "The input." - }, - "sink": { - "$ref": "Sink", - "description": "The sink to write to." - } - }, - "id": "WriteInstruction" - }, - "AutoscalingSettings": { - "description": "Settings for WorkerPool autoscaling.", - "type": "object", - "properties": { - "algorithm": { - "type": "string", - "enumDescriptions": [ - "The algorithm is unknown, or unspecified.", - "Disable autoscaling.", - "Increase worker count over time to reduce job execution time." - ], - "enum": [ - "AUTOSCALING_ALGORITHM_UNKNOWN", - "AUTOSCALING_ALGORITHM_NONE", - "AUTOSCALING_ALGORITHM_BASIC" - ], - "description": "The algorithm to use for autoscaling." - }, - "maxNumWorkers": { - "type": "integer", - "description": "The maximum number of workers to cap scaling at.", - "format": "int32" - } - }, - "id": "AutoscalingSettings" - }, - "StreamingComputationRanges": { - "description": "Describes full or partial data disk assignment information of the computation\nranges.", - "type": "object", - "properties": { - "rangeAssignments": { - "type": "array", - "items": { - "$ref": "KeyRangeDataDiskAssignment" - }, - "description": "Data disk assignments for ranges from this computation." - }, - "computationId": { - "type": "string", - "description": "The ID of the computation." - } - }, - "id": "StreamingComputationRanges" - }, - "ExecutionStageSummary": { - "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.", - "type": "object", - "properties": { - "componentSource": { - "type": "array", - "items": { - "$ref": "ComponentSource" - }, - "description": "Collections produced and consumed by component transforms of this stage." - }, - "kind": { - "enum": [ - "UNKNOWN_KIND", - "PAR_DO_KIND", - "GROUP_BY_KEY_KIND", - "FLATTEN_KIND", - "READ_KIND", - "WRITE_KIND", - "CONSTANT_KIND", - "SINGLETON_KIND", - "SHUFFLE_KIND" - ], - "description": "Type of tranform this stage is executing.", - "type": "string", - "enumDescriptions": [ - "Unrecognized transform type.", - "ParDo transform.", - "Group By Key transform.", - "Flatten transform.", - "Read transform.", - "Write transform.", - "Constructs from a constant value, such as with Create.of.", - "Creates a Singleton view of a collection.", - "Opening or closing a shuffle session, often as part of a GroupByKey." - ] - }, - "outputSource": { - "description": "Output sources for this stage.", - "type": "array", - "items": { - "$ref": "StageSource" - } - }, - "name": { - "type": "string", - "description": "Dataflow service generated name for this stage." - }, - "inputSource": { - "type": "array", - "items": { - "$ref": "StageSource" - }, - "description": "Input sources for this stage." - }, - "id": { - "type": "string", - "description": "Dataflow service generated id for this stage." - }, - "componentTransform": { - "type": "array", - "items": { - "$ref": "ComponentTransform" - }, - "description": "Transforms that comprise this execution stage." - } - }, - "id": "ExecutionStageSummary" - }, - "SendWorkerMessagesRequest": { - "type": "object", - "properties": { - "workerMessages": { - "type": "array", - "items": { - "$ref": "WorkerMessage" - }, - "description": "The WorkerMessages to send." - }, - "location": { - "description": "The location which contains the job", - "type": "string" - } - }, - "id": "SendWorkerMessagesRequest", - "description": "A request for sending worker messages to the service." - }, - "SourceSplitShard": { - "description": "DEPRECATED in favor of DerivedSource.", - "type": "object", - "properties": { - "source": { - "$ref": "Source", - "description": "DEPRECATED" - }, - "derivationMode": { - "enum": [ - "SOURCE_DERIVATION_MODE_UNKNOWN", - "SOURCE_DERIVATION_MODE_INDEPENDENT", - "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", - "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" - ], - "description": "DEPRECATED", - "type": "string", - "enumDescriptions": [ - "The source derivation is unknown, or unspecified.", - "Produce a completely independent Source with no base.", - "Produce a Source based on the Source being split.", - "Produce a Source based on the base of the Source being split." - ] - } - }, - "id": "SourceSplitShard" - }, - "CPUTime": { - "type": "object", - "properties": { - "rate": { - "type": "number", - "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.", - "format": "double" - }, - "timestamp": { - "type": "string", - "description": "Timestamp of the measurement.", - "format": "google-datetime" - }, - "totalMs": { - "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.", - "format": "uint64", - "type": "string" - } - }, - "id": "CPUTime", - "description": "Modeled after information exposed by /proc/stat." - }, - "Environment": { - "description": "Describes the environment in which a Dataflow Job runs.", - "type": "object", - "properties": { - "clusterManagerApiService": { - "type": "string", - "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\"." - }, - "tempStoragePrefix": { - "type": "string", - "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}" - }, - "workerPools": { - "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.", - "type": "array", - "items": { - "$ref": "WorkerPool" - } - }, - "dataset": { - "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}", - "type": "string" - }, - "experiments": { - "description": "The list of experiments to enable.", - "type": "array", - "items": { - "type": "string" - } - }, - "version": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "A structure describing which components and their versions of the service\nare required in order to run the job.", - "type": "object" - }, - "internalExperiments": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Experimental settings." - }, - "serviceAccountEmail": { - "type": "string", - "description": "Identity to run virtual machines as. Defaults to the default account." - }, - "userAgent": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "A description of the process that generated the request.", - "type": "object" - }, - "sdkPipelineOptions": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way." - } - }, - "id": "Environment" - }, - "StreamingComputationTask": { - "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.", - "type": "object", - "properties": { - "computationRanges": { - "description": "Contains ranges of a streaming computation this task should apply to.", - "type": "array", - "items": { - "$ref": "StreamingComputationRanges" - } - }, - "dataDisks": { - "description": "Describes the set of data disks this task should apply to.", - "type": "array", - "items": { - "$ref": "MountedDataDisk" - } - }, - "taskType": { - "type": "string", - "enumDescriptions": [ - "The streaming computation task is unknown, or unspecified.", - "Stop processing specified streaming computation range(s).", - "Start processing specified streaming computation range(s)." - ], - "enum": [ - "STREAMING_COMPUTATION_TASK_UNKNOWN", - "STREAMING_COMPUTATION_TASK_STOP", - "STREAMING_COMPUTATION_TASK_START" - ], - "description": "A type of streaming computation task." - } - }, - "id": "StreamingComputationTask" - }, "SendDebugCaptureRequest": { - "type": "object", "properties": { - "location": { - "description": "The location which contains the job specified by job_id.", - "type": "string" - }, - "data": { - "description": "The encoded debug information.", - "type": "string" - }, "componentId": { "description": "The internal component id for which debug information is sent.", "type": "string" @@ -2762,13 +1530,21 @@ "workerId": { "description": "The worker id, i.e., VM hostname.", "type": "string" + }, + "location": { + "description": "The location which contains the job specified by job_id.", + "type": "string" + }, + "data": { + "description": "The encoded debug information.", + "type": "string" } }, "id": "SendDebugCaptureRequest", - "description": "Request to send encoded debug information." + "description": "Request to send encoded debug information.", + "type": "object" }, "GetDebugConfigResponse": { - "type": "object", "properties": { "config": { "description": "The encoded debug configuration for the requested component.", @@ -2776,33 +1552,40 @@ } }, "id": "GetDebugConfigResponse", - "description": "Response to a get debug configuration request." + "description": "Response to a get debug configuration request.", + "type": "object" }, "ComponentTransform": { - "type": "object", "properties": { "originalTransform": { - "type": "string", - "description": "User name for the original user transform with which this transform is\nmost closely associated." + "description": "User name for the original user transform with which this transform is\nmost closely associated.", + "type": "string" }, "name": { - "type": "string", - "description": "Dataflow service generated name for this source." + "description": "Dataflow service generated name for this source.", + "type": "string" }, "userName": { - "type": "string", - "description": "Human-readable name for this transform; may be user or system generated." + "description": "Human-readable name for this transform; may be user or system generated.", + "type": "string" } }, "id": "ComponentTransform", - "description": "Description of a transform executed as part of an execution stage." + "description": "Description of a transform executed as part of an execution stage.", + "type": "object" }, "StreamingSetupTask": { + "description": "A task which initializes part of a streaming Dataflow job.", "type": "object", "properties": { + "receiveWorkPort": { + "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.", + "format": "int32", + "type": "integer" + }, "streamingComputationTopology": { - "$ref": "TopologyConfig", - "description": "The global topology of the streaming Dataflow job." + "description": "The global topology of the streaming Dataflow job.", + "$ref": "TopologyConfig" }, "workerHarnessPort": { "description": "The TCP port used by the worker to communicate with the Dataflow\nworker harness.", @@ -2810,32 +1593,17 @@ "type": "integer" }, "drain": { - "type": "boolean", - "description": "The user has requested drain." - }, - "receiveWorkPort": { - "type": "integer", - "description": "The TCP port on which the worker should listen for messages from\nother streaming computation workers.", - "format": "int32" + "description": "The user has requested drain.", + "type": "boolean" } }, - "id": "StreamingSetupTask", - "description": "A task which initializes part of a streaming Dataflow job." + "id": "StreamingSetupTask" }, "PubsubLocation": { - "type": "object", "properties": { - "dropLateData": { - "type": "boolean", - "description": "Indicates whether the pipeline allows late-arriving data." - }, - "trackingSubscription": { - "type": "string", - "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation." - }, "withAttributes": { - "type": "boolean", - "description": "If true, then the client has requested to get pubsub attributes." + "description": "If true, then the client has requested to get pubsub attributes.", + "type": "boolean" }, "idLabel": { "description": "If set, contains a pubsub label from which to extract record ids.\nIf left empty, record deduplication will be strictly best effort.", @@ -2850,12 +1618,21 @@ "type": "string" }, "subscription": { - "type": "string", - "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"" + "description": "A pubsub subscription, in the form of\n\"pubsub.googleapis.com/subscriptions/\u003cproject-id\u003e/\u003csubscription-name\u003e\"", + "type": "string" + }, + "dropLateData": { + "description": "Indicates whether the pipeline allows late-arriving data.", + "type": "boolean" + }, + "trackingSubscription": { + "description": "If set, specifies the pubsub subscription that will be used for tracking\ncustom time timestamps for watermark estimation.", + "type": "string" } }, "id": "PubsubLocation", - "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job." + "description": "Identifies a pubsub location to use for transferring data into or\nout of a streaming Dataflow job.", + "type": "object" }, "WorkerHealthReport": { "description": "WorkerHealthReport contains information about the health of a worker.\n\nThe VM should be identified by the labels attached to the WorkerMessage that\nthis health ping belongs to.", @@ -2865,38 +1642,45 @@ "description": "The pods running on the worker. See:\nhttp://kubernetes.io/v1.1/docs/api-reference/v1/definitions.html#_v1_pod\n\nThis field is used by the worker to send the status of the indvidual\ncontainers running on each worker.", "type": "array", "items": { - "type": "object", "additionalProperties": { - "type": "any", - "description": "Properties of the object." - } + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" } }, "vmStartupTime": { - "type": "string", "description": "The time the VM was booted.", - "format": "google-datetime" + "format": "google-datetime", + "type": "string" }, "vmIsHealthy": { - "type": "boolean", - "description": "Whether the VM is healthy." + "description": "Whether the VM is healthy.", + "type": "boolean" }, "reportInterval": { - "type": "string", "description": "The interval at which the worker is sending health reports.\nThe default value of 0 should be interpreted as the field is not being\nexplicitly set by the worker.", - "format": "google-duration" + "format": "google-duration", + "type": "string" } }, "id": "WorkerHealthReport" }, "JobMessage": { - "type": "object", "properties": { "messageText": { "description": "The text of the message.", "type": "string" }, "messageImportance": { + "enumDescriptions": [ + "The message importance isn't specified, or is unknown.", + "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.", + "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.", + "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.", + "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.", + "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI." + ], "enum": [ "JOB_MESSAGE_IMPORTANCE_UNKNOWN", "JOB_MESSAGE_DEBUG", @@ -2906,15 +1690,7 @@ "JOB_MESSAGE_ERROR" ], "description": "Importance level of the message.", - "type": "string", - "enumDescriptions": [ - "The message importance isn't specified, or is unknown.", - "The message is at the 'debug' level: typically only useful for\nsoftware engineers working on the code the job is running.\nTypically, Dataflow pipeline runners do not display log messages\nat this level by default.", - "The message is at the 'detailed' level: somewhat verbose, but\npotentially useful to users. Typically, Dataflow pipeline\nrunners do not display log messages at this level by default.\nThese messages are displayed by default in the Dataflow\nmonitoring UI.", - "The message is at the 'basic' level: useful for keeping\ntrack of the execution of a Dataflow pipeline. Typically,\nDataflow pipeline runners display log messages at this level by\ndefault, and these messages are displayed by default in the\nDataflow monitoring UI.", - "The message is at the 'warning' level: indicating a condition\npertaining to a job which may require human intervention.\nTypically, Dataflow pipeline runners display log messages at this\nlevel by default, and these messages are displayed by default in\nthe Dataflow monitoring UI.", - "The message is at the 'error' level: indicating a condition\npreventing a job from succeeding. Typically, Dataflow pipeline\nrunners display log messages at this level by default, and these\nmessages are displayed by default in the Dataflow monitoring UI." - ] + "type": "string" }, "time": { "description": "The timestamp of the message.", @@ -2922,53 +1698,54 @@ "type": "string" }, "id": { - "type": "string", - "description": "Deprecated." + "description": "Deprecated.", + "type": "string" } }, "id": "JobMessage", - "description": "A particular message pertaining to a Dataflow job." + "description": "A particular message pertaining to a Dataflow job.", + "type": "object" }, "ParameterMetadata": { - "description": "Metadata for a specific parameter.", - "type": "object", "properties": { + "label": { + "description": "Required. The label to display for the parameter.", + "type": "string" + }, "helpText": { - "type": "string", - "description": "Required. The help text to display for the parameter." + "description": "Required. The help text to display for the parameter.", + "type": "string" }, "isOptional": { "description": "Optional. Whether the parameter is optional. Defaults to false.", "type": "boolean" }, "name": { - "type": "string", - "description": "Required. The name of the parameter." + "description": "Required. The name of the parameter.", + "type": "string" }, "regexes": { + "description": "Optional. Regexes that the parameter must match.", "type": "array", "items": { "type": "string" - }, - "description": "Optional. Regexes that the parameter must match." - }, - "label": { - "type": "string", - "description": "Required. The label to display for the parameter." + } } }, - "id": "ParameterMetadata" + "id": "ParameterMetadata", + "description": "Metadata for a specific parameter.", + "type": "object" }, "MultiOutputInfo": { + "description": "Information about an output of a multi-output DoFn.", "type": "object", "properties": { "tag": { - "type": "string", - "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo." + "description": "The id of the tag the user code will emit to this output by; this\nshould correspond to the tag of some SideInputInfo.", + "type": "string" } }, - "id": "MultiOutputInfo", - "description": "Information about an output of a multi-output DoFn." + "id": "MultiOutputInfo" }, "SourceSplitRequest": { "type": "object", @@ -2986,6 +1763,7 @@ "description": "Represents the operation to split a high-level Source specification\ninto bundles (parts for parallel processing).\n\nAt a high level, splitting of a source into bundles happens as follows:\nSourceSplitRequest is applied to the source. If it returns\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, no further splitting happens and the source\nis used \"as is\". Otherwise, splitting is applied recursively to each\nproduced DerivedSource.\n\nAs an optimization, for any Source, if its does_not_need_splitting is\ntrue, the framework assumes that splitting this source would return\nSOURCE_SPLIT_OUTCOME_USE_CURRENT, and doesn't initiate a SourceSplitRequest.\nThis applies both to the initial source being split and to bundles\nproduced from it." }, "SourceGetMetadataResponse": { + "description": "The result of a SourceGetMetadataOperation.", "type": "object", "properties": { "metadata": { @@ -2993,49 +1771,39 @@ "description": "The computed metadata." } }, - "id": "SourceGetMetadataResponse", - "description": "The result of a SourceGetMetadataOperation." - }, - "ShellTask": { - "type": "object", - "properties": { - "exitCode": { - "type": "integer", - "description": "Exit code for the task.", - "format": "int32" - }, - "command": { - "type": "string", - "description": "The shell command to run." - } - }, - "id": "ShellTask", - "description": "A task which consists of a shell command for the worker to execute." - }, - "MetricShortId": { - "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest", - "type": "object", - "properties": { - "shortId": { - "type": "string", - "description": "The service-generated short identifier for the metric.", - "format": "int64" - }, - "metricIndex": { - "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.", - "format": "int32", - "type": "integer" - } - }, - "id": "MetricShortId" + "id": "SourceGetMetadataResponse" }, "AutoscalingEvent": { + "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice.", "type": "object", "properties": { - "currentNumWorkers": { + "targetNumWorkers": { + "description": "The target number of workers the worker pool wants to resize to use.", + "format": "int64", + "type": "string" + }, + "eventType": { "type": "string", + "enumDescriptions": [ + "Default type for the enum. Value should never be returned.", + "The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event\nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na change in the target_num_workers.", + "The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker\npool size has been changed, but the target_num_workers has not changed.", + "The ACTUATION_FAILURE type should be used when we want to report\nan error to the user indicating why the current number of workers\nin the pool could not be changed.\nDisplayed in the current status and history widgets.", + "Used when we want to report to the user a reason why we are\nnot currently adjusting the number of workers.\nShould specify both target_num_workers, current_num_workers and a\ndecision_message." + ], + "enum": [ + "TYPE_UNKNOWN", + "TARGET_NUM_WORKERS_CHANGED", + "CURRENT_NUM_WORKERS_CHANGED", + "ACTUATION_FAILURE", + "NO_CHANGE" + ], + "description": "The type of autoscaling event to report." + }, + "currentNumWorkers": { "description": "The current number of workers the job has.", - "format": "int64" + "format": "int64", + "type": "string" }, "description": { "$ref": "StructuredMessage", @@ -3045,65 +1813,50 @@ "type": "string", "description": "The time this event was emitted to indicate a new target or current\nnum_workers value.", "format": "google-datetime" - }, - "targetNumWorkers": { - "type": "string", - "description": "The target number of workers the worker pool wants to resize to use.", - "format": "int64" - }, - "eventType": { - "enum": [ - "TYPE_UNKNOWN", - "TARGET_NUM_WORKERS_CHANGED", - "CURRENT_NUM_WORKERS_CHANGED", - "ACTUATION_FAILURE", - "NO_CHANGE" - ], - "description": "The type of autoscaling event to report.", - "type": "string", - "enumDescriptions": [ - "Default type for the enum. Value should never be returned.", - "The TARGET_NUM_WORKERS_CHANGED type should be used when the target\nworker pool size has changed at the start of an actuation. An event\nshould always be specified as TARGET_NUM_WORKERS_CHANGED if it reflects\na change in the target_num_workers.", - "The CURRENT_NUM_WORKERS_CHANGED type should be used when actual worker\npool size has been changed, but the target_num_workers has not changed.", - "The ACTUATION_FAILURE type should be used when we want to report\nan error to the user indicating why the current number of workers\nin the pool could not be changed.\nDisplayed in the current status and history widgets.", - "Used when we want to report to the user a reason why we are\nnot currently adjusting the number of workers.\nShould specify both target_num_workers, current_num_workers and a\ndecision_message." - ] } }, - "id": "AutoscalingEvent", - "description": "A structured message reporting an autoscaling decision made by the Dataflow\nservice." + "id": "AutoscalingEvent" + }, + "MetricShortId": { + "type": "object", + "properties": { + "metricIndex": { + "type": "integer", + "description": "The index of the corresponding metric in\nthe ReportWorkItemStatusRequest. Required.", + "format": "int32" + }, + "shortId": { + "description": "The service-generated short identifier for the metric.", + "format": "int64", + "type": "string" + } + }, + "id": "MetricShortId", + "description": "The metric short id is returned to the user alongside an offset into\nReportWorkItemStatusRequest" + }, + "ShellTask": { + "description": "A task which consists of a shell command for the worker to execute.", + "type": "object", + "properties": { + "exitCode": { + "description": "Exit code for the task.", + "format": "int32", + "type": "integer" + }, + "command": { + "type": "string", + "description": "The shell command to run." + } + }, + "id": "ShellTask" }, "TaskRunnerSettings": { "description": "Taskrunner configuration settings.", "type": "object", "properties": { - "baseUrl": { - "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"", - "type": "string" - }, - "logToSerialconsole": { - "type": "boolean", - "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole." - }, - "continueOnException": { - "type": "boolean", - "description": "Whether to continue taskrunner if an exception is hit." - }, - "parallelWorkerSettings": { - "$ref": "WorkerSettings", - "description": "The settings to pass to the parallel worker harness." - }, - "taskUser": { - "type": "string", - "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\"." - }, - "vmId": { - "type": "string", - "description": "The ID string of the VM." - }, "alsologtostderr": { - "description": "Whether to also send taskrunner log info to stderr.", - "type": "boolean" + "type": "boolean", + "description": "Whether to also send taskrunner log info to stderr." }, "taskGroup": { "type": "string", @@ -3114,12 +1867,8 @@ "description": "The command to launch the worker harness." }, "logDir": { - "description": "The directory on the VM to store logs.", - "type": "string" - }, - "dataflowApiVersion": { "type": "string", - "description": "The API version of endpoint, e.g. \"v1b3\"" + "description": "The directory on the VM to store logs." }, "oauthScopes": { "description": "The OAuth2 scopes to be requested by the taskrunner in order to\naccess the Cloud Dataflow API.", @@ -3128,33 +1877,61 @@ "type": "string" } }, - "streamingWorkerMainClass": { - "description": "The streaming worker main class name.", - "type": "string" + "dataflowApiVersion": { + "type": "string", + "description": "The API version of endpoint, e.g. \"v1b3\"" }, "logUploadLocation": { - "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", + "type": "string", + "description": "Indicates where to put logs. If this is not specified, the logs\nwill not be uploaded.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}" + }, + "streamingWorkerMainClass": { + "description": "The streaming worker main class name.", "type": "string" }, "workflowFileName": { "type": "string", "description": "The file to store the workflow in." }, - "baseTaskDir": { - "type": "string", - "description": "The location on the worker for task-specific subdirectories." + "commandlinesFileName": { + "description": "The file to store preprocessing commands in.", + "type": "string" + }, + "languageHint": { + "description": "The suggested backend language.", + "type": "string" }, "tempStoragePrefix": { "description": "The prefix of the resources the taskrunner should use for\ntemporary storage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", "type": "string" }, - "languageHint": { + "baseTaskDir": { "type": "string", - "description": "The suggested backend language." + "description": "The location on the worker for task-specific subdirectories." }, - "commandlinesFileName": { + "baseUrl": { "type": "string", - "description": "The file to store preprocessing commands in." + "description": "The base URL for the taskrunner to use when accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"" + }, + "logToSerialconsole": { + "type": "boolean", + "description": "Whether to send taskrunner log info to Google Compute Engine VM serial\nconsole." + }, + "continueOnException": { + "description": "Whether to continue taskrunner if an exception is hit.", + "type": "boolean" + }, + "parallelWorkerSettings": { + "$ref": "WorkerSettings", + "description": "The settings to pass to the parallel worker harness." + }, + "taskUser": { + "type": "string", + "description": "The UNIX user ID on the worker VM to use for tasks launched by\ntaskrunner; e.g. \"root\"." + }, + "vmId": { + "description": "The ID string of the VM.", + "type": "string" } }, "id": "TaskRunnerSettings" @@ -3162,14 +1939,18 @@ "Position": { "type": "object", "properties": { + "key": { + "description": "Position is a string key, ordered lexicographically.", + "type": "string" + }, "recordIndex": { "type": "string", "description": "Position is a record index.", "format": "int64" }, "shufflePosition": { - "type": "string", - "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding)." + "description": "CloudPosition is a base64 encoded BatchShufflePosition (with FIXED\nsharding).", + "type": "string" }, "concatPosition": { "$ref": "ConcatPosition", @@ -3183,24 +1964,52 @@ "end": { "description": "Position is past all other positions. Also useful for the end\nposition of an unbounded range.", "type": "boolean" - }, - "key": { - "description": "Position is a string key, ordered lexicographically.", - "type": "string" } }, "id": "Position", "description": "Position defines a position within a collection of data. The value\ncan be either the end position, a key (used with ordered\ncollections), a byte offset, or a record index." }, + "SplitInt64": { + "type": "object", + "properties": { + "lowBits": { + "description": "The low order bits: n & 0xffffffff.", + "format": "uint32", + "type": "integer" + }, + "highBits": { + "type": "integer", + "description": "The high order bits, including the sign: n \u003e\u003e 32.", + "format": "int32" + } + }, + "id": "SplitInt64", + "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON." + }, "Source": { "description": "A source that records can be read and decoded from.", "type": "object", "properties": { + "metadata": { + "$ref": "SourceMetadata", + "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated." + }, + "baseSpecs": { + "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs).", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "type": "object" + } + }, "codec": { "type": "object", "additionalProperties": { - "type": "any", - "description": "Properties of the object." + "description": "Properties of the object.", + "type": "any" }, "description": "The codec to use to decode data read from the source." }, @@ -3210,50 +2019,74 @@ }, "spec": { "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "type": "any", + "description": "Properties of the object." }, "description": "The source to read from, plus its parameters.", "type": "object" - }, - "metadata": { - "$ref": "SourceMetadata", - "description": "Optionally, metadata for this source can be supplied right away,\navoiding a SourceGetMetadataOperation roundtrip\n(see SourceOperationRequest).\n\nThis field is meaningful only in the Source objects populated\nby the user (e.g. when filling in a DerivedSource).\nSource objects supplied by the framework to the user don't have\nthis field populated." - }, - "baseSpecs": { - "type": "array", - "items": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "type": "object" - }, - "description": "While splitting, sources may specify the produced bundles\nas differences against another source, in order to save backend-side\nmemory and allow bigger jobs. For details, see SourceSplitRequest.\nTo support this use case, the full set of parameters of the source\nis logically obtained by taking the latest explicitly specified value\nof each parameter in the order:\nbase_specs (later items win), spec (overrides anything in base_specs)." } }, "id": "Source" }, - "SplitInt64": { - "description": "A representation of an int64, n, that is immune to precision loss when\nencoded in JSON.", - "type": "object", - "properties": { - "highBits": { - "type": "integer", - "description": "The high order bits, including the sign: n \u003e\u003e 32.", - "format": "int32" - }, - "lowBits": { - "description": "The low order bits: n & 0xffffffff.", - "format": "uint32", - "type": "integer" - } - }, - "id": "SplitInt64" - }, "WorkerPool": { "type": "object", "properties": { + "packages": { + "type": "array", + "items": { + "$ref": "Package" + }, + "description": "Packages to be installed on workers." + }, + "teardownPolicy": { + "type": "string", + "enumDescriptions": [ + "The teardown policy isn't specified, or is unknown.", + "Always teardown the resource.", + "Teardown the resource on success. This is useful for debugging\nfailures.", + "Never teardown the resource. This is useful for debugging and\ndevelopment." + ], + "enum": [ + "TEARDOWN_POLICY_UNKNOWN", + "TEARDOWN_ALWAYS", + "TEARDOWN_ON_SUCCESS", + "TEARDOWN_NEVER" + ], + "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault." + }, + "onHostMaintenance": { + "type": "string", + "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API." + }, + "poolArgs": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Extra arguments for this worker pool." + }, + "diskSizeGb": { + "type": "integer", + "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.", + "format": "int32" + }, + "workerHarnessContainerImage": { + "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry.", + "type": "string" + }, + "diskType": { + "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default.", + "type": "string" + }, + "machineType": { + "type": "string", + "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default." + }, + "kind": { + "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.", + "type": "string" + }, "dataDisks": { "type": "array", "items": { @@ -3262,8 +2095,8 @@ "description": "Data disks that are used by a VM in this workflow." }, "subnetwork": { - "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\".", - "type": "string" + "type": "string", + "description": "Subnetwork to which VMs will be assigned, if desired. Expected to be of\nthe form \"regions/REGION/subnetworks/SUBNETWORK\"." }, "ipConfiguration": { "enum": [ @@ -3288,35 +2121,35 @@ "description": "Settings for autoscaling of this WorkerPool." }, "metadata": { - "type": "object", "additionalProperties": { "type": "string" }, - "description": "Metadata to set on the Google Compute Engine VMs." + "description": "Metadata to set on the Google Compute Engine VMs.", + "type": "object" }, "defaultPackageSet": { - "type": "string", - "enumDescriptions": [ - "The default set of packages to stage is unknown, or unspecified.", - "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.", - "Stage packages typically useful to workers written in Java.", - "Stage pacakges typically useful to workers written in Python." - ], "enum": [ "DEFAULT_PACKAGE_SET_UNKNOWN", "DEFAULT_PACKAGE_SET_NONE", "DEFAULT_PACKAGE_SET_JAVA", "DEFAULT_PACKAGE_SET_PYTHON" ], - "description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language." + "description": "The default package set to install. This allows the service to\nselect a default set of packages which are useful to worker\nharnesses written in a particular language.", + "type": "string", + "enumDescriptions": [ + "The default set of packages to stage is unknown, or unspecified.", + "Indicates that no packages should be staged at the worker unless\nexplicitly specified by the job.", + "Stage packages typically useful to workers written in Java.", + "Stage pacakges typically useful to workers written in Python." + ] }, "network": { "description": "Network to which VMs will be assigned. If empty or unspecified,\nthe service will use the network \"default\".", "type": "string" }, "zone": { - "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default.", - "type": "string" + "type": "string", + "description": "Zone to run the worker pools in. If empty or unspecified, the service\nwill attempt to choose a reasonable default." }, "numWorkers": { "type": "integer", @@ -3324,90 +2157,33 @@ "format": "int32" }, "numThreadsPerWorker": { + "type": "integer", "description": "The number of threads per worker harness. If empty or unspecified, the\nservice will choose a number of threads (according to the number of cores\non the selected machine type for batch, or 1 by convention for streaming).", - "format": "int32", - "type": "integer" + "format": "int32" }, "diskSourceImage": { "description": "Fully qualified source image for disks.", "type": "string" - }, - "packages": { - "description": "Packages to be installed on workers.", - "type": "array", - "items": { - "$ref": "Package" - } - }, - "teardownPolicy": { - "enum": [ - "TEARDOWN_POLICY_UNKNOWN", - "TEARDOWN_ALWAYS", - "TEARDOWN_ON_SUCCESS", - "TEARDOWN_NEVER" - ], - "description": "Sets the policy for determining when to turndown worker pool.\nAllowed values are: `TEARDOWN_ALWAYS`, `TEARDOWN_ON_SUCCESS`, and\n`TEARDOWN_NEVER`.\n`TEARDOWN_ALWAYS` means workers are always torn down regardless of whether\nthe job succeeds. `TEARDOWN_ON_SUCCESS` means workers are torn down\nif the job succeeds. `TEARDOWN_NEVER` means the workers are never torn\ndown.\n\nIf the workers are not torn down by the service, they will\ncontinue to run and use Google Compute Engine VM resources in the\nuser's project until they are explicitly terminated by the user.\nBecause of this, Google recommends using the `TEARDOWN_ALWAYS`\npolicy except for small, manually supervised test jobs.\n\nIf unknown or unspecified, the service will attempt to choose a reasonable\ndefault.", - "type": "string", - "enumDescriptions": [ - "The teardown policy isn't specified, or is unknown.", - "Always teardown the resource.", - "Teardown the resource on success. This is useful for debugging\nfailures.", - "Never teardown the resource. This is useful for debugging and\ndevelopment." - ] - }, - "onHostMaintenance": { - "description": "The action to take on host maintenance, as defined by the Google\nCompute Engine API.", - "type": "string" - }, - "poolArgs": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Extra arguments for this worker pool.", - "type": "object" - }, - "diskSizeGb": { - "description": "Size of root disk for VMs, in GB. If zero or unspecified, the service will\nattempt to choose a reasonable default.", - "format": "int32", - "type": "integer" - }, - "workerHarnessContainerImage": { - "type": "string", - "description": "Required. Docker container image that executes the Cloud Dataflow worker\nharness, residing in Google Container Registry." - }, - "machineType": { - "description": "Machine type (e.g. \"n1-standard-1\"). If empty or unspecified, the\nservice will attempt to choose a reasonable default.", - "type": "string" - }, - "diskType": { - "type": "string", - "description": "Type of root disk for VMs. If empty or unspecified, the service will\nattempt to choose a reasonable default." - }, - "kind": { - "description": "The kind of the worker pool; currently only `harness` and `shuffle`\nare supported.", - "type": "string" } }, "id": "WorkerPool", "description": "Describes one particular pool of Cloud Dataflow workers to be\ninstantiated by the Cloud Dataflow service in order to perform the\ncomputations required by a job. Note that a workflow job may use\nmultiple pools, in order to match the various computational\nrequirements of the various stages of the job." }, "SourceOperationRequest": { - "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification.", "type": "object", "properties": { "originalName": { "type": "string", "description": "System-defined name for the Read instruction for this source\nin the original workflow graph." }, - "systemName": { - "type": "string", - "description": "System-defined name of the Read instruction for this source.\nUnique across the workflow." - }, "stageName": { "type": "string", "description": "System-defined name of the stage containing the source operation.\nUnique across the workflow." }, + "systemName": { + "description": "System-defined name of the Read instruction for this source.\nUnique across the workflow.", + "type": "string" + }, "getMetadata": { "$ref": "SourceGetMetadataRequest", "description": "Information about a request to get metadata about a source." @@ -3417,32 +2193,86 @@ "description": "Information about a request to split a source." }, "name": { - "type": "string", - "description": "User-provided name of the Read instruction for this source." + "description": "User-provided name of the Read instruction for this source.", + "type": "string" } }, - "id": "SourceOperationRequest" + "id": "SourceOperationRequest", + "description": "A work item that represents the different operations that can be\nperformed on a user-defined Source specification." + }, + "StructuredMessage": { + "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption.", + "type": "object", + "properties": { + "messageText": { + "type": "string", + "description": "Human-readable version of message." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "Parameter" + }, + "description": "The structured data associated with this message." + }, + "messageKey": { + "type": "string", + "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message." + } + }, + "id": "StructuredMessage" }, "WorkItem": { "description": "WorkItem represents basic information about a WorkItem to be executed\nin the cloud.", "type": "object", "properties": { - "streamingComputationTask": { - "$ref": "StreamingComputationTask", - "description": "Additional information for StreamingComputationTask WorkItems." + "projectId": { + "description": "Identifies the cloud project this WorkItem belongs to.", + "type": "string" + }, + "sourceOperationTask": { + "$ref": "SourceOperationRequest", + "description": "Additional information for source operation WorkItems." + }, + "streamingSetupTask": { + "$ref": "StreamingSetupTask", + "description": "Additional information for StreamingSetupTask WorkItems." + }, + "reportStatusInterval": { + "type": "string", + "description": "Recommended reporting interval.", + "format": "google-duration" + }, + "leaseExpireTime": { + "type": "string", + "description": "Time when the lease on this Work will expire.", + "format": "google-datetime" + }, + "streamingConfigTask": { + "$ref": "StreamingConfigTask", + "description": "Additional information for StreamingConfigTask WorkItems." + }, + "initialReportIndex": { + "description": "The initial index to use when reporting the status of the WorkItem.", + "format": "int64", + "type": "string" }, "shellTask": { "$ref": "ShellTask", "description": "Additional information for ShellTask WorkItems." }, + "streamingComputationTask": { + "$ref": "StreamingComputationTask", + "description": "Additional information for StreamingComputationTask WorkItems." + }, "jobId": { "description": "Identifies the workflow job this WorkItem belongs to.", "type": "string" }, "id": { + "type": "string", "description": "Identifies this WorkItem.", - "format": "int64", - "type": "string" + "format": "int64" }, "configuration": { "type": "string", @@ -3457,84 +2287,15 @@ "description": "Additional information for SeqMapTask WorkItems." }, "packages": { - "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem.", "type": "array", "items": { "$ref": "Package" - } - }, - "projectId": { - "description": "Identifies the cloud project this WorkItem belongs to.", - "type": "string" - }, - "sourceOperationTask": { - "$ref": "SourceOperationRequest", - "description": "Additional information for source operation WorkItems." - }, - "streamingSetupTask": { - "$ref": "StreamingSetupTask", - "description": "Additional information for StreamingSetupTask WorkItems." - }, - "reportStatusInterval": { - "description": "Recommended reporting interval.", - "format": "google-duration", - "type": "string" - }, - "streamingConfigTask": { - "$ref": "StreamingConfigTask", - "description": "Additional information for StreamingConfigTask WorkItems." - }, - "leaseExpireTime": { - "type": "string", - "description": "Time when the lease on this Work will expire.", - "format": "google-datetime" - }, - "initialReportIndex": { - "description": "The initial index to use when reporting the status of the WorkItem.", - "format": "int64", - "type": "string" + }, + "description": "Any required packages that need to be fetched in order to execute\nthis WorkItem." } }, "id": "WorkItem" }, - "StructuredMessage": { - "type": "object", - "properties": { - "messageKey": { - "description": "Idenfier for this message type. Used by external systems to\ninternationalize or personalize message.", - "type": "string" - }, - "messageText": { - "type": "string", - "description": "Human-readable version of message." - }, - "parameters": { - "description": "The structured data associated with this message.", - "type": "array", - "items": { - "$ref": "Parameter" - } - } - }, - "id": "StructuredMessage", - "description": "A rich message format, including a human readable string, a key for\nidentifying the message, and structured data associated with the message for\nprogrammatic consumption." - }, - "ReportedParallelism": { - "type": "object", - "properties": { - "isInfinite": { - "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.", - "type": "boolean" - }, - "value": { - "type": "number", - "description": "Specifies the level of parallelism in case it is finite.", - "format": "double" - } - }, - "id": "ReportedParallelism", - "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker." - }, "ResourceUtilizationReport": { "description": "Worker metrics exported from workers. This contains resource utilization\nmetrics accumulated from a variety of sources. For more information, see\ngo/df-resource-signals.", "type": "object", @@ -3549,21 +2310,25 @@ }, "id": "ResourceUtilizationReport" }, + "ReportedParallelism": { + "description": "Represents the level of parallelism in a WorkItem's input,\nreported by the worker.", + "type": "object", + "properties": { + "isInfinite": { + "description": "Specifies whether the parallelism is infinite. If true, \"value\" is\nignored.\nInfinite parallelism means the service will assume that the work item\ncan always be split into more non-empty work items by dynamic splitting.\nThis is a work-around for lack of support for infinity by the current\nJSON-based Java RPC stack.", + "type": "boolean" + }, + "value": { + "description": "Specifies the level of parallelism in case it is finite.", + "format": "double", + "type": "number" + } + }, + "id": "ReportedParallelism" + }, "TopologyConfig": { "type": "object", "properties": { - "forwardingKeyBits": { - "description": "The size (in bits) of keys that will be assigned to source messages.", - "format": "int32", - "type": "integer" - }, - "userStageToComputationNameMap": { - "additionalProperties": { - "type": "string" - }, - "description": "Maps user stage names to stable computation names.", - "type": "object" - }, "computations": { "description": "The computations associated with a streaming Dataflow job.", "type": "array", @@ -3572,22 +2337,35 @@ } }, "dataDiskAssignments": { - "description": "The disks assigned to a streaming Dataflow job.", "type": "array", "items": { "$ref": "DataDiskAssignment" - } + }, + "description": "The disks assigned to a streaming Dataflow job." }, "persistentStateVersion": { + "type": "integer", "description": "Version number for persistent state.", - "format": "int32", - "type": "integer" + "format": "int32" + }, + "forwardingKeyBits": { + "type": "integer", + "description": "The size (in bits) of keys that will be assigned to source messages.", + "format": "int32" + }, + "userStageToComputationNameMap": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Maps user stage names to stable computation names." } }, "id": "TopologyConfig", "description": "Global topology of the streaming Dataflow job, including all\ncomputations and their sharded locations." }, "SourceSplitOptions": { + "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest.", "type": "object", "properties": { "desiredBundleSizeBytes": { @@ -3596,13 +2374,12 @@ "type": "string" }, "desiredShardSizeBytes": { + "type": "string", "description": "DEPRECATED in favor of desired_bundle_size_bytes.", - "format": "int64", - "type": "string" + "format": "int64" } }, - "id": "SourceSplitOptions", - "description": "Hints for splitting a Source into bundles (parts for parallel\nprocessing) using SourceSplitRequest." + "id": "SourceSplitOptions" }, "ReadInstruction": { "description": "An instruction that reads records.\nTakes no inputs, produces one output.", @@ -3618,64 +2395,65 @@ "WorkerSettings": { "type": "object", "properties": { - "shuffleServicePath": { - "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\".", - "type": "string" - }, - "workerId": { - "type": "string", - "description": "The ID of the worker running this pipeline." - }, "tempStoragePrefix": { "type": "string", "description": "The prefix of the resources the system should use for temporary\nstorage.\n\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}" }, - "reportingEnabled": { - "description": "Whether to send work progress updates to the service.", - "type": "boolean" - }, "baseUrl": { - "description": "The base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"", - "type": "string" + "type": "string", + "description": "The base URL for accessing Google Cloud APIs.\n\nWhen workers access Google Cloud APIs, they logically do so via\nrelative URLs. If this field is specified, it supplies the base\nURL to use for resolving these relative URLs. The normative\nalgorithm used is defined by RFC 1808, \"Relative Uniform Resource\nLocators\".\n\nIf not specified, the default value is \"http://www.googleapis.com/\"" + }, + "reportingEnabled": { + "type": "boolean", + "description": "Whether to send work progress updates to the service." }, "servicePath": { + "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\".", + "type": "string" + }, + "shuffleServicePath": { "type": "string", - "description": "The Cloud Dataflow service path relative to the root URL, for example,\n\"dataflow/v1b3/projects\"." + "description": "The Shuffle service path relative to the root URL, for example,\n\"shuffle/v1beta1\"." + }, + "workerId": { + "type": "string", + "description": "The ID of the worker running this pipeline." } }, "id": "WorkerSettings", "description": "Provides data to pass through to the worker harness." }, - "StreamingStageLocation": { - "type": "object", - "properties": { - "streamId": { - "description": "Identifies the particular stream within the streaming Dataflow\njob.", - "type": "string" - } - }, - "id": "StreamingStageLocation", - "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication." - }, "DataDiskAssignment": { "description": "Data disk assignment for a given VM instance.", "type": "object", "properties": { - "vmInstance": { - "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".", - "type": "string" - }, "dataDisks": { - "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }.", "type": "array", "items": { "type": "string" - } + }, + "description": "Mounted data disks. The order is important a data disk's 0-based index in\nthis list defines which persistent directory the disk is mounted to, for\nexample the list of { \"myproject-1014-104817-4c2-harness-0-disk-0\" },\n{ \"myproject-1014-104817-4c2-harness-0-disk-1\" }." + }, + "vmInstance": { + "description": "VM instance name the data disks mounted to, for example\n\"myproject-1014-104817-4c2-harness-0\".", + "type": "string" } }, "id": "DataDiskAssignment" }, + "StreamingStageLocation": { + "description": "Identifies the location of a streaming computation stage, for\nstage-to-stage communication.", + "type": "object", + "properties": { + "streamId": { + "type": "string", + "description": "Identifies the particular stream within the streaming Dataflow\njob." + } + }, + "id": "StreamingStageLocation" + }, "ApproximateSplitRequest": { + "description": "A suggestion by the service to the worker to dynamically split the WorkItem.", "type": "object", "properties": { "position": { @@ -3688,38 +2466,36 @@ "format": "double" } }, - "id": "ApproximateSplitRequest", - "description": "A suggestion by the service to the worker to dynamically split the WorkItem." + "id": "ApproximateSplitRequest" }, "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.", "type": "object", "properties": { "code": { - "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" + "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": "string", + "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." }, "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { "type": "object", "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" } - }, - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." + } } }, "id": "Status" }, "ExecutionStageState": { - "description": "A message describing the state of a particular execution stage.", "type": "object", "properties": { "currentStateTime": { @@ -3762,9 +2538,11 @@ "type": "string" } }, - "id": "ExecutionStageState" + "id": "ExecutionStageState", + "description": "A message describing the state of a particular execution stage." }, "StreamLocation": { + "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job.", "type": "object", "properties": { "customSourceLocation": { @@ -3784,8 +2562,7 @@ "description": "The stream is a streaming side input." } }, - "id": "StreamLocation", - "description": "Describes a stream of data, either as input to be processed or as\noutput of a streaming Dataflow job." + "id": "StreamLocation" }, "SendWorkerMessagesResponse": { "description": "The response to the worker messages.", @@ -3802,19 +2579,20 @@ "id": "SendWorkerMessagesResponse" }, "StreamingComputationConfig": { + "description": "Configuration information for a single streaming computation.", "type": "object", "properties": { "computationId": { - "type": "string", - "description": "Unique identifier for this computation." + "description": "Unique identifier for this computation.", + "type": "string" }, "systemName": { "type": "string", "description": "System defined name for this computation." }, "stageName": { - "description": "Stage name of this computation.", - "type": "string" + "type": "string", + "description": "Stage name of this computation." }, "instructions": { "description": "Instructions that comprise the computation.", @@ -3824,10 +2602,10 @@ } } }, - "id": "StreamingComputationConfig", - "description": "Configuration information for a single streaming computation." + "id": "StreamingComputationConfig" }, "TransformSummary": { + "description": "Description of the type, names/ids, and input/outputs for a transform.", "type": "object", "properties": { "inputCollectionName": { @@ -3838,8 +2616,8 @@ } }, "name": { - "type": "string", - "description": "User provided name for this transform instance." + "description": "User provided name for this transform instance.", + "type": "string" }, "id": { "description": "SDK generated id of this transform instance.", @@ -3886,10 +2664,10 @@ "description": "Type of transform." } }, - "id": "TransformSummary", - "description": "Description of the type, names/ids, and input/outputs for a transform." + "id": "TransformSummary" }, "LeaseWorkItemResponse": { + "description": "Response to a request to lease WorkItems.", "type": "object", "properties": { "workItems": { @@ -3900,55 +2678,55 @@ } } }, - "id": "LeaseWorkItemResponse", - "description": "Response to a request to lease WorkItems." + "id": "LeaseWorkItemResponse" }, "LaunchTemplateParameters": { "type": "object", "properties": { - "parameters": { - "additionalProperties": { - "type": "string" - }, - "description": "The runtime parameters to pass to the job.", - "type": "object" - }, "jobName": { - "type": "string", - "description": "Required. The job name to use for the created job." + "description": "Required. The job name to use for the created job.", + "type": "string" }, "environment": { "$ref": "RuntimeEnvironment", "description": "The runtime environment for the job." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The runtime parameters to pass to the job." } }, "id": "LaunchTemplateParameters", "description": "Parameters to provide to the template being launched." }, "Sink": { + "description": "A sink that records can be encoded and written to.", "type": "object", "properties": { "codec": { - "type": "object", "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "type": "any", + "description": "Properties of the object." }, - "description": "The codec to use to encode data written to the sink." + "description": "The codec to use to encode data written to the sink.", + "type": "object" }, "spec": { - "type": "object", "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "type": "any", + "description": "Properties of the object." }, - "description": "The sink to write to, plus its parameters." + "description": "The sink to write to, plus its parameters.", + "type": "object" } }, - "id": "Sink", - "description": "A sink that records can be encoded and written to." + "id": "Sink" }, "FlattenInstruction": { + "description": "An instruction that copies its inputs (zero or more) to its (single) output.", "type": "object", "properties": { "inputs": { @@ -3959,36 +2737,11 @@ } } }, - "id": "FlattenInstruction", - "description": "An instruction that copies its inputs (zero or more) to its (single) output." + "id": "FlattenInstruction" }, "PartialGroupByKeyInstruction": { "type": "object", "properties": { - "input": { - "$ref": "InstructionInput", - "description": "Describes the input to the partial group-by-key instruction." - }, - "inputElementCodec": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "The codec to use for interpreting an element in the input PTable.", - "type": "object" - }, - "valueCombiningFn": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object." - }, - "description": "The value combining function to invoke." - }, - "originalCombineValuesInputStoreName": { - "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues.", - "type": "string" - }, "sideInputs": { "description": "Zero or more side inputs.", "type": "array", @@ -3999,12 +2752,37 @@ "originalCombineValuesStepName": { "type": "string", "description": "If this instruction includes a combining function, this is the name of the\nCombineValues instruction lifted into this instruction." + }, + "input": { + "$ref": "InstructionInput", + "description": "Describes the input to the partial group-by-key instruction." + }, + "inputElementCodec": { + "type": "object", + "additionalProperties": { + "type": "any", + "description": "Properties of the object." + }, + "description": "The codec to use for interpreting an element in the input PTable." + }, + "valueCombiningFn": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The value combining function to invoke.", + "type": "object" + }, + "originalCombineValuesInputStoreName": { + "type": "string", + "description": "If this instruction includes a combining function this is the name of the\nintermediate store between the GBK and the CombineValues." } }, "id": "PartialGroupByKeyInstruction", "description": "An instruction that does a partial group-by-key.\nOne input and one output." }, "StageSource": { + "description": "Description of an input or output of an execution stage.", "type": "object", "properties": { "originalTransformOrCollection": { @@ -4012,23 +2790,23 @@ "description": "User name for the original user transform or collection with which this\nsource is most closely associated." }, "name": { - "type": "string", - "description": "Dataflow service generated name for this source." + "description": "Dataflow service generated name for this source.", + "type": "string" }, "sizeBytes": { - "type": "string", "description": "Size of the source, if measurable.", - "format": "int64" + "format": "int64", + "type": "string" }, "userName": { - "type": "string", - "description": "Human-readable name for this source; may be user or system generated." + "description": "Human-readable name for this source; may be user or system generated.", + "type": "string" } }, - "id": "StageSource", - "description": "Description of an input or output of an execution stage." + "id": "StageSource" }, "InstructionInput": { + "description": "An input of an instruction, as a reference to an output of a\nproducer instruction.", "type": "object", "properties": { "producerInstructionIndex": { @@ -4037,13 +2815,12 @@ "format": "int32" }, "outputNum": { + "type": "integer", "description": "The output index (origin zero) within the producer.", - "format": "int32", - "type": "integer" + "format": "int32" } }, - "id": "InstructionInput", - "description": "An input of an instruction, as a reference to an output of a\nproducer instruction." + "id": "InstructionInput" }, "StringList": { "description": "A metric value representing a list of strings.", @@ -4063,8 +2840,34 @@ "description": "Data provided with a pipeline or transform to provide descriptive info.", "type": "object", "properties": { + "label": { + "type": "string", + "description": "An optional label to display in a dax UI for the element." + }, + "url": { + "description": "An optional full URL.", + "type": "string" + }, + "timestampValue": { + "type": "string", + "description": "Contains value if the data is of timestamp type.", + "format": "google-datetime" + }, + "javaClassValue": { + "description": "Contains value if the data is of java class type.", + "type": "string" + }, + "boolValue": { + "type": "boolean", + "description": "Contains value if the data is of a boolean type." + }, "strValue": { - "description": "Contains value if the data is of string type.", + "type": "string", + "description": "Contains value if the data is of string type." + }, + "durationValue": { + "description": "Contains value if the data is of duration type.", + "format": "google-duration", "type": "string" }, "int64Value": { @@ -4072,48 +2875,22 @@ "description": "Contains value if the data is of int64 type.", "format": "int64" }, - "durationValue": { - "type": "string", - "description": "Contains value if the data is of duration type.", - "format": "google-duration" - }, "namespace": { "type": "string", "description": "The namespace for the key. This is usually a class name or programming\nlanguage namespace (i.e. python module) which defines the display data.\nThis allows a dax monitoring system to specially handle the data\nand perform custom rendering." }, "floatValue": { + "type": "number", "description": "Contains value if the data is of float type.", - "format": "float", - "type": "number" + "format": "float" }, "key": { - "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system.", - "type": "string" + "type": "string", + "description": "The key identifying the display data.\nThis is intended to be used as a label for the display data\nwhen viewed in a dax monitoring system." }, "shortStrValue": { "description": "A possible additional shorter value to display.\nFor example a java_class_name_value of com.mypackage.MyDoFn\nwill be stored with MyDoFn as the short_str_value and\ncom.mypackage.MyDoFn as the java_class_name value.\nshort_str_value can be displayed and java_class_name_value\nwill be displayed as a tooltip.", "type": "string" - }, - "url": { - "description": "An optional full URL.", - "type": "string" - }, - "label": { - "type": "string", - "description": "An optional label to display in a dax UI for the element." - }, - "timestampValue": { - "type": "string", - "description": "Contains value if the data is of timestamp type.", - "format": "google-datetime" - }, - "boolValue": { - "type": "boolean", - "description": "Contains value if the data is of a boolean type." - }, - "javaClassValue": { - "type": "string", - "description": "Contains value if the data is of java class type." } }, "id": "DisplayData" @@ -4122,8 +2899,8 @@ "type": "object", "properties": { "location": { - "description": "The location which contains the job specified by job_id.", - "type": "string" + "type": "string", + "description": "The location which contains the job specified by job_id." }, "componentId": { "description": "The internal component id for which debug configuration is\nrequested.", @@ -4152,20 +2929,20 @@ "description": "The location which contains the WorkItem's job." }, "workerCapabilities": { - "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities.", "type": "array", "items": { "type": "string" - } + }, + "description": "Worker capabilities. WorkItems might be limited to workers with specific\ncapabilities." }, "workerId": { - "type": "string", - "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker." + "description": "Identifies the worker leasing work -- typically the ID of the\nvirtual machine running the worker.", + "type": "string" }, "requestedLeaseDuration": { + "type": "string", "description": "The initial lease period.", - "format": "google-duration", - "type": "string" + "format": "google-duration" }, "currentWorkerTime": { "description": "The current timestamp at the worker.", @@ -4177,21 +2954,22 @@ "description": "Request to lease WorkItems." }, "GetTemplateResponse": { + "description": "The response to a GetTemplate request.", "type": "object", "properties": { - "metadata": { - "$ref": "TemplateMetadata", - "description": "The template metadata describing the template name, available\nparameters, etc." - }, "status": { "$ref": "Status", "description": "The status of the get template request. Any problems with the\nrequest will be indicated in the error_details." + }, + "metadata": { + "$ref": "TemplateMetadata", + "description": "The template metadata describing the template name, available\nparameters, etc." } }, - "id": "GetTemplateResponse", - "description": "The response to a GetTemplate request." + "id": "GetTemplateResponse" }, "Parameter": { + "description": "Structured data associated with this message.", "type": "object", "properties": { "value": { @@ -4203,10 +2981,10 @@ "description": "Key or name for this parameter." } }, - "id": "Parameter", - "description": "Structured data associated with this message." + "id": "Parameter" }, "ReportWorkItemStatusRequest": { + "description": "Request to report the status of WorkItems.", "type": "object", "properties": { "location": { @@ -4214,11 +2992,11 @@ "description": "The location which contains the WorkItem's job." }, "workItemStatuses": { + "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here.", "type": "array", "items": { "$ref": "WorkItemStatus" - }, - "description": "The order is unimportant, except that the order of the\nWorkItemServiceState messages in the ReportWorkItemStatusResponse\ncorresponds to the order of WorkItemStatus messages here." + } }, "workerId": { "type": "string", @@ -4230,27 +3008,26 @@ "format": "google-datetime" } }, - "id": "ReportWorkItemStatusRequest", - "description": "Request to report the status of WorkItems." + "id": "ReportWorkItemStatusRequest" }, "StreamingConfigTask": { "type": "object", "properties": { "windmillServicePort": { - "type": "string", "description": "If present, the worker must use this port to communicate with Windmill\nService dispatchers. Only applicable when windmill_service_endpoint is\nspecified.", - "format": "int64" + "format": "int64", + "type": "string" }, "streamingComputationConfigs": { - "description": "Set of computation configuration information.", "type": "array", "items": { "$ref": "StreamingComputationConfig" - } + }, + "description": "Set of computation configuration information." }, "windmillServiceEndpoint": { - "type": "string", - "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using." + "description": "If present, the worker must use this endpoint to communicate with Windmill\nService dispatchers, otherwise the worker must continue to use whatever\nendpoint it had been using.", + "type": "string" }, "userStepToStateFamilyNameMap": { "additionalProperties": { @@ -4264,21 +3041,15 @@ "description": "A task that carries configuration information for streaming computations." }, "PipelineDescription": { + "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics.", "type": "object", "properties": { - "originalPipelineTransform": { - "description": "Description of each transform in the pipeline and collections between them.", - "type": "array", - "items": { - "$ref": "TransformSummary" - } - }, "displayData": { + "description": "Pipeline level display data.", "type": "array", "items": { "$ref": "DisplayData" - }, - "description": "Pipeline level display data." + } }, "executionPipelineStage": { "type": "array", @@ -4286,33 +3057,16 @@ "$ref": "ExecutionStageSummary" }, "description": "Description of each stage of execution of the pipeline." - } - }, - "id": "PipelineDescription", - "description": "A descriptive representation of submitted pipeline as well as the executed\nform. This data is provided by the Dataflow service for ease of visualizing\nthe pipeline and interpretting Dataflow provided metrics." - }, - "Step": { - "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.", - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job." }, - "kind": { - "type": "string", - "description": "The kind of step in the Cloud Dataflow job." - }, - "properties": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" + "originalPipelineTransform": { + "type": "array", + "items": { + "$ref": "TransformSummary" }, - "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL.", - "type": "object" + "description": "Description of each transform in the pipeline and collections between them." } }, - "id": "Step" + "id": "PipelineDescription" }, "JobExecutionInfo": { "type": "object", @@ -4328,8 +3082,30 @@ "id": "JobExecutionInfo", "description": "Additional information about how a Cloud Dataflow job will be executed that\nisn't contained in the submitted job." }, + "Step": { + "description": "Defines a particular step within a Cloud Dataflow job.\n\nA job consists of multiple steps, each of which performs some\nspecific operation as part of the overall job. Data is typically\npassed from one step to another as part of the job.\n\nHere's an example of a sequence of steps which together implement a\nMap-Reduce job:\n\n * Read a collection of data from some source, parsing the\n collection's elements.\n\n * Validate the elements.\n\n * Apply a user-defined function to map each element to some value\n and extract an element-specific key value.\n\n * Group elements with the same key into a single element with\n that key, transforming a multiply-keyed collection into a\n uniquely-keyed collection.\n\n * Write the elements out to some data sink.\n\nNote that the Cloud Dataflow service may be used to run many different\ntypes of jobs, not just Map-Reduce.", + "type": "object", + "properties": { + "properties": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Named properties associated with the step. Each kind of\npredefined step has its own required set of properties.\nMust be provided on Create. Only retrieved with JOB_VIEW_ALL." + }, + "name": { + "description": "The name that identifies the step. This must be unique for each\nstep with respect to all other steps in the Cloud Dataflow job.", + "type": "string" + }, + "kind": { + "description": "The kind of step in the Cloud Dataflow job.", + "type": "string" + } + }, + "id": "Step" + }, "FailedLocation": { - "description": "Indicates which location failed to respond to a request for data.", "type": "object", "properties": { "name": { @@ -4337,10 +3113,10 @@ "description": "The name of the failed location." } }, - "id": "FailedLocation" + "id": "FailedLocation", + "description": "Indicates which location failed to respond to a request for data." }, "Disk": { - "description": "Describes the data disk used by a workflow job.", "type": "object", "properties": { "sizeGb": { @@ -4353,69 +3129,16 @@ "description": "Disk storage type, as defined by Google Compute Engine. This\nmust be a disk type appropriate to the project and zone in which\nthe workers will run. If unknown or unspecified, the service\nwill attempt to choose a reasonable default.\n\nFor example, the standard persistent disk type is a resource name\ntypically ending in \"pd-standard\". If SSD persistent disks are\navailable, the resource name typically ends with \"pd-ssd\". The\nactual valid values are defined the Google Compute Engine API,\nnot by the Cloud Dataflow API; consult the Google Compute Engine\ndocumentation for more information about determining the set of\navailable disk types for a particular project and zone.\n\nGoogle Compute Engine Disk types are local to a particular\nproject in a particular zone, and so the resource name will\ntypically look something like this:\n\ncompute.googleapis.com/projects/project-id/zones/zone/diskTypes/pd-standard" }, "mountPoint": { - "type": "string", - "description": "Directory in a VM where disk is mounted." - } - }, - "id": "Disk" - }, - "ListJobMessagesResponse": { - "description": "Response to a request to list job messages.", - "type": "object", - "properties": { - "autoscalingEvents": { - "description": "Autoscaling events in ascending timestamp order.", - "type": "array", - "items": { - "$ref": "AutoscalingEvent" - } - }, - "jobMessages": { - "type": "array", - "items": { - "$ref": "JobMessage" - }, - "description": "Messages in ascending timestamp order." - }, - "nextPageToken": { - "description": "The token to obtain the next page of results if there are more.", + "description": "Directory in a VM where disk is mounted.", "type": "string" } }, - "id": "ListJobMessagesResponse" + "id": "Disk", + "description": "Describes the data disk used by a workflow job." }, "CounterMetadata": { - "description": "CounterMetadata includes all static non-name non-value counter attributes.", "type": "object", "properties": { - "standardUnits": { - "type": "string", - "enumDescriptions": [ - "Counter returns a value in bytes.", - "Counter returns a value in bytes per second.", - "Counter returns a value in milliseconds.", - "Counter returns a value in microseconds.", - "Counter returns a value in nanoseconds.", - "Counter returns a timestamp in milliseconds.", - "Counter returns a timestamp in microseconds.", - "Counter returns a timestamp in nanoseconds." - ], - "enum": [ - "BYTES", - "BYTES_PER_SEC", - "MILLISECONDS", - "MICROSECONDS", - "NANOSECONDS", - "TIMESTAMP_MSEC", - "TIMESTAMP_USEC", - "TIMESTAMP_NSEC" - ], - "description": "System defined Units, see above enum." - }, - "otherUnits": { - "description": "A string referring to the unit type.", - "type": "string" - }, "kind": { "type": "string", "enumDescriptions": [ @@ -4445,12 +3168,65 @@ "description": { "type": "string", "description": "Human-readable description of the counter semantics." + }, + "standardUnits": { + "type": "string", + "enumDescriptions": [ + "Counter returns a value in bytes.", + "Counter returns a value in bytes per second.", + "Counter returns a value in milliseconds.", + "Counter returns a value in microseconds.", + "Counter returns a value in nanoseconds.", + "Counter returns a timestamp in milliseconds.", + "Counter returns a timestamp in microseconds.", + "Counter returns a timestamp in nanoseconds." + ], + "enum": [ + "BYTES", + "BYTES_PER_SEC", + "MILLISECONDS", + "MICROSECONDS", + "NANOSECONDS", + "TIMESTAMP_MSEC", + "TIMESTAMP_USEC", + "TIMESTAMP_NSEC" + ], + "description": "System defined Units, see above enum." + }, + "otherUnits": { + "description": "A string referring to the unit type.", + "type": "string" } }, - "id": "CounterMetadata" + "id": "CounterMetadata", + "description": "CounterMetadata includes all static non-name non-value counter attributes." + }, + "ListJobMessagesResponse": { + "description": "Response to a request to list job messages.", + "type": "object", + "properties": { + "autoscalingEvents": { + "type": "array", + "items": { + "$ref": "AutoscalingEvent" + }, + "description": "Autoscaling events in ascending timestamp order." + }, + "jobMessages": { + "type": "array", + "items": { + "$ref": "JobMessage" + }, + "description": "Messages in ascending timestamp order." + }, + "nextPageToken": { + "type": "string", + "description": "The token to obtain the next page of results if there are more." + } + }, + "id": "ListJobMessagesResponse" }, "ApproximateReportedProgress": { - "description": "A progress measurement of a WorkItem by a worker.", "type": "object", "properties": { "remainingParallelism": { @@ -4471,22 +3247,8 @@ "description": "Total amount of parallelism in the portion of input of this task that has\nalready been consumed and is no longer active. In the first two examples\nabove (see remaining_parallelism), the value should be 29 or 2\nrespectively. The sum of remaining_parallelism and consumed_parallelism\nshould equal the total amount of parallelism in this work item. If\nspecified, must be finite." } }, - "id": "ApproximateReportedProgress" - }, - "StateFamilyConfig": { - "type": "object", - "properties": { - "stateFamily": { - "type": "string", - "description": "The state family value." - }, - "isRead": { - "type": "boolean", - "description": "If true, this family corresponds to a read operation." - } - }, - "id": "StateFamilyConfig", - "description": "State family configuration." + "id": "ApproximateReportedProgress", + "description": "A progress measurement of a WorkItem by a worker." }, "IntegerList": { "description": "A metric value representing a list of integers.", @@ -4502,6 +3264,21 @@ }, "id": "IntegerList" }, + "StateFamilyConfig": { + "description": "State family configuration.", + "type": "object", + "properties": { + "stateFamily": { + "type": "string", + "description": "The state family value." + }, + "isRead": { + "type": "boolean", + "description": "If true, this family corresponds to a read operation." + } + }, + "id": "StateFamilyConfig" + }, "ResourceUtilizationReportResponse": { "type": "object", "properties": {}, @@ -4511,26 +3288,12 @@ "SourceSplitResponse": { "type": "object", "properties": { - "outcome": { - "type": "string", - "enumDescriptions": [ - "The source split outcome is unknown, or unspecified.", - "The current source should be processed \"as is\" without splitting.", - "Splitting produced a list of bundles." - ], - "enum": [ - "SOURCE_SPLIT_OUTCOME_UNKNOWN", - "SOURCE_SPLIT_OUTCOME_USE_CURRENT", - "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED" - ], - "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split." - }, "bundles": { + "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is ignored.\nThis list can be empty, which means the source represents an empty input.", "type": "array", "items": { "$ref": "DerivedSource" - }, - "description": "If outcome is SPLITTING_HAPPENED, then this is a list of bundles\ninto which the source was split. Otherwise this field is ignored.\nThis list can be empty, which means the source represents an empty input." + } }, "shards": { "description": "DEPRECATED in favor of bundles.", @@ -4538,6 +3301,20 @@ "items": { "$ref": "SourceSplitShard" } + }, + "outcome": { + "enum": [ + "SOURCE_SPLIT_OUTCOME_UNKNOWN", + "SOURCE_SPLIT_OUTCOME_USE_CURRENT", + "SOURCE_SPLIT_OUTCOME_SPLITTING_HAPPENED" + ], + "description": "Indicates whether splitting happened and produced a list of bundles.\nIf this is USE_CURRENT_SOURCE_AS_IS, the current source should\nbe processed \"as is\" without splitting. \"bundles\" is ignored in this case.\nIf this is SPLITTING_HAPPENED, then \"bundles\" contains a list of\nbundles into which the source was split.", + "type": "string", + "enumDescriptions": [ + "The source split outcome is unknown, or unspecified.", + "The current source should be processed \"as is\" without splitting.", + "Splitting produced a list of bundles." + ] } }, "id": "SourceSplitResponse", @@ -4555,8 +3332,8 @@ } }, "name": { - "description": "User-provided name of this operation.", - "type": "string" + "type": "string", + "description": "User-provided name of this operation." }, "parDo": { "$ref": "ParDoInstruction", @@ -4579,8 +3356,8 @@ "description": "Additional information for Write instructions." }, "systemName": { - "description": "System-defined name of this operation.\nUnique across the workflow.", - "type": "string" + "type": "string", + "description": "System-defined name of this operation.\nUnique across the workflow." }, "partialGroupByKey": { "$ref": "PartialGroupByKeyInstruction", @@ -4589,39 +3366,39 @@ }, "id": "ParallelInstruction" }, + "Package": { + "type": "object", + "properties": { + "location": { + "description": "The resource to read the package from. The supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}\n bucket.storage.googleapis.com/", + "type": "string" + }, + "name": { + "type": "string", + "description": "The name of the package." + } + }, + "id": "Package", + "description": "The packages that must be installed in order for a worker to run the\nsteps of the Cloud Dataflow job that will be assigned to its worker\npool.\n\nThis is the mechanism by which the Cloud Dataflow SDK causes code to\nbe loaded onto the workers. For example, the Cloud Dataflow Java SDK\nmight use this to install jars containing the user's code and all of the\nvarious dependencies (libraries, data files, etc.) required in order\nfor that code to run." + }, "KeyRangeDataDiskAssignment": { - "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.", "type": "object", "properties": { "start": { - "type": "string", - "description": "The start (inclusive) of the key range." + "description": "The start (inclusive) of the key range.", + "type": "string" }, "dataDisk": { - "type": "string", - "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\"." + "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", + "type": "string" }, "end": { "description": "The end (exclusive) of the key range.", "type": "string" } }, - "id": "KeyRangeDataDiskAssignment" - }, - "Package": { - "type": "object", - "properties": { - "location": { - "type": "string", - "description": "The resource to read the package from. The supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}\n bucket.storage.googleapis.com/" - }, - "name": { - "description": "The name of the package.", - "type": "string" - } - }, - "id": "Package", - "description": "The packages that must be installed in order for a worker to run the\nsteps of the Cloud Dataflow job that will be assigned to its worker\npool.\n\nThis is the mechanism by which the Cloud Dataflow SDK causes code to\nbe loaded onto the workers. For example, the Cloud Dataflow Java SDK\nmight use this to install jars containing the user's code and all of the\nvarious dependencies (libraries, data files, etc.) required in order\nfor that code to run." + "id": "KeyRangeDataDiskAssignment", + "description": "Data disk assignment information for a specific key-range of a sharded\ncomputation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON." }, "ParDoInstruction": { "type": "object", @@ -4639,9 +3416,9 @@ "description": "The input." }, "numOutputs": { - "type": "integer", "description": "The number of outputs.", - "format": "int32" + "format": "int32", + "type": "integer" }, "sideInputs": { "type": "array", @@ -4651,56 +3428,84 @@ "description": "Zero or more side inputs." }, "multiOutputInfos": { - "description": "Information about each of the outputs, if user_fn is a MultiDoFn.", "type": "array", "items": { "$ref": "MultiOutputInfo" - } + }, + "description": "Information about each of the outputs, if user_fn is a MultiDoFn." } }, "id": "ParDoInstruction", "description": "An instruction that does a ParDo operation.\nTakes one main input and zero or more side inputs, and produces\nzero or more outputs.\nRuns user code." }, - "WorkerShutdownNotice": { + "MetricUpdate": { + "description": "Describes the state of a metric.", "type": "object", "properties": { - "reason": { + "updateTime": { "type": "string", - "description": "The reason for the worker shutdown.\nCurrent possible values are:\n \"UNKNOWN\": shutdown reason is unknown.\n \"PREEMPTION\": shutdown reason is preemption.\nOther possible reasons may be added in the future." + "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.", + "format": "google-datetime" + }, + "name": { + "$ref": "MetricStructuredName", + "description": "Name of the metric." + }, + "distribution": { + "description": "A struct value describing properties of a distribution of numeric values.", + "type": "any" + }, + "set": { + "type": "any", + "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type." + }, + "cumulative": { + "type": "boolean", + "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem." + }, + "internal": { + "type": "any", + "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice." + }, + "kind": { + "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value.", + "type": "string" + }, + "scalar": { + "type": "any", + "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean." + }, + "meanCount": { + "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long.", + "type": "any" + }, + "meanSum": { + "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double.", + "type": "any" } }, - "id": "WorkerShutdownNotice", - "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down." + "id": "MetricUpdate" }, "CounterStructuredName": { "type": "object", "properties": { - "originalRequestingStepName": { - "description": "The step name requesting an operation, such as GBK.\nI.e. the ParDo causing a read/write from shuffle to occur, or a\nread from side inputs.", + "componentStepName": { + "description": "Name of the optimized step being executed by the workers.", "type": "string" }, - "inputIndex": { - "description": "Index of an input collection that's being read from/written to as a side\ninput.\nThe index identifies a step's side inputs starting by 1 (e.g. the first\nside input has input_index 1, the third has input_index 3).\nSide inputs are identified by a pair of (original_step_name, input_index).\nThis field helps uniquely identify them.", - "format": "int32", - "type": "integer" - }, - "componentStepName": { - "type": "string", - "description": "Name of the optimized step being executed by the workers." - }, "portion": { - "enum": [ - "ALL", - "KEY", - "VALUE" - ], - "description": "Portion of this counter, either key or value.", "type": "string", "enumDescriptions": [ "Counter portion has not been set.", "Counter reports a key.", "Counter reports a value." - ] + ], + "enum": [ + "ALL", + "KEY", + "VALUE" + ], + "description": "Portion of this counter, either key or value." }, "originalStepName": { "description": "System generated name of the original step in the user's graph, before\noptimization.", @@ -4714,100 +3519,73 @@ "type": "string", "description": "A string containing a more specific namespace of the counter's origin." }, - "origin": { + "executionStepName": { "type": "string", - "enumDescriptions": [ - "Counter was created by the Dataflow system.", - "Counter was created by the user." - ], + "description": "Name of the stage. An execution step contains multiple component steps." + }, + "name": { + "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired.", + "type": "string" + }, + "origin": { "enum": [ "SYSTEM", "USER" ], - "description": "One of the standard Origins defined above." - }, - "name": { + "description": "One of the standard Origins defined above.", "type": "string", - "description": "Counter name. Not necessarily globally-unique, but unique within the\ncontext of the other fields.\nRequired." + "enumDescriptions": [ + "Counter was created by the Dataflow system.", + "Counter was created by the user." + ] }, - "executionStepName": { - "type": "string", - "description": "Name of the stage. An execution step contains multiple component steps." + "originalRequestingStepName": { + "description": "The step name requesting an operation, such as GBK.\nI.e. the ParDo causing a read/write from shuffle to occur, or a\nread from side inputs.", + "type": "string" + }, + "inputIndex": { + "description": "Index of an input collection that's being read from/written to as a side\ninput.\nThe index identifies a step's side inputs starting by 1 (e.g. the first\nside input has input_index 1, the third has input_index 3).\nSide inputs are identified by a pair of (original_step_name, input_index).\nThis field helps uniquely identify them.", + "format": "int32", + "type": "integer" } }, "id": "CounterStructuredName", "description": "Identifies a counter within a per-job namespace. Counters whose structured\nnames are the same get merged into a single value for the job." }, - "MetricUpdate": { - "description": "Describes the state of a metric.", + "WorkerShutdownNotice": { "type": "object", "properties": { - "set": { - "type": "any", - "description": "Worker-computed aggregate value for the \"Set\" aggregation kind. The only\npossible value type is a list of Values whose type can be Long, Double,\nor String, according to the metric's type. All Values in the list must\nbe of the same type." - }, - "internal": { - "description": "Worker-computed aggregate value for internal use by the Dataflow\nservice.", - "type": "any" - }, - "cumulative": { - "description": "True if this metric is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this metric is reported\nas a delta that is not associated with any WorkItem.", - "type": "boolean" - }, - "kind": { - "type": "string", - "description": "Metric aggregation kind. The possible metric aggregation kinds are\n\"Sum\", \"Max\", \"Min\", \"Mean\", \"Set\", \"And\", \"Or\", and \"Distribution\".\nThe specified aggregation kind is case-insensitive.\n\nIf omitted, this is not an aggregated value but instead\na single metric sample value." - }, - "scalar": { - "type": "any", - "description": "Worker-computed aggregate value for aggregation kinds \"Sum\", \"Max\", \"Min\",\n\"And\", and \"Or\". The possible value types are Long, Double, and Boolean." - }, - "meanCount": { - "type": "any", - "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the count of the aggregated values and is used in combination\nwith mean_sum above to obtain the actual mean aggregate value.\nThe only possible value type is Long." - }, - "meanSum": { - "type": "any", - "description": "Worker-computed aggregate value for the \"Mean\" aggregation kind.\nThis holds the sum of the aggregated values and is used in combination\nwith mean_count below to obtain the actual mean aggregate value.\nThe only possible value types are Long and Double." - }, - "updateTime": { - "description": "Timestamp associated with the metric value. Optional when workers are\nreporting work progress; it will be filled in responses from the\nmetrics API.", - "format": "google-datetime", + "reason": { + "description": "The reason for the worker shutdown.\nCurrent possible values are:\n \"UNKNOWN\": shutdown reason is unknown.\n \"PREEMPTION\": shutdown reason is preemption.\nOther possible reasons may be added in the future.", "type": "string" - }, - "name": { - "$ref": "MetricStructuredName", - "description": "Name of the metric." - }, - "distribution": { - "type": "any", - "description": "A struct value describing properties of a distribution of numeric values." } }, - "id": "MetricUpdate" + "id": "WorkerShutdownNotice", + "description": "Shutdown notification from workers. This is to be sent by the shutdown\nscript of the worker VM so that the backend knows that the VM is being\nshut down." }, "ApproximateProgress": { "description": "Obsolete in favor of ApproximateReportedProgress and ApproximateSplitRequest.", "type": "object", "properties": { - "position": { - "$ref": "Position", - "description": "Obsolete." - }, "percentComplete": { "type": "number", "description": "Obsolete.", "format": "float" }, "remainingTime": { - "type": "string", "description": "Obsolete.", - "format": "google-duration" + "format": "google-duration", + "type": "string" + }, + "position": { + "$ref": "Position", + "description": "Obsolete." } }, "id": "ApproximateProgress" }, "WorkerMessageResponse": { + "description": "A worker_message response allows the server to pass information to the\nsender.", "type": "object", "properties": { "workerMetricsResponse": { @@ -4823,16 +3601,14 @@ "description": "The service's response to a worker's health report." } }, - "id": "WorkerMessageResponse", - "description": "A worker_message response allows the server to pass information to the\nsender." + "id": "WorkerMessageResponse" }, "TemplateMetadata": { - "description": "Metadata describing a template.", "type": "object", "properties": { "name": { - "type": "string", - "description": "Required. The name of the template." + "description": "Required. The name of the template.", + "type": "string" }, "parameters": { "type": "array", @@ -4842,27 +3618,32 @@ "description": "The parameters for the template." }, "description": { - "description": "Optional. A description of the template.", - "type": "string" + "type": "string", + "description": "Optional. A description of the template." } }, - "id": "TemplateMetadata" + "id": "TemplateMetadata", + "description": "Metadata describing a template." }, "WorkerMessage": { "type": "object", "properties": { + "workerShutdownNotice": { + "$ref": "WorkerShutdownNotice", + "description": "Shutdown notice by workers." + }, "workerHealthReport": { "$ref": "WorkerHealthReport", "description": "The health of a worker." }, - "workerMetrics": { - "$ref": "ResourceUtilizationReport", - "description": "Resource metrics reported by workers." - }, "workerMessageCode": { "$ref": "WorkerMessageCode", "description": "A worker message code." }, + "workerMetrics": { + "$ref": "ResourceUtilizationReport", + "description": "Resource metrics reported by workers." + }, "labels": { "type": "object", "additionalProperties": { @@ -4871,24 +3652,14 @@ "description": "Labels are used to group WorkerMessages.\nFor example, a worker_message about a particular container\nmight have the labels:\n{ \"JOB_ID\": \"2015-04-22\",\n \"WORKER_ID\": \"wordcount-vm-2015…\"\n \"CONTAINER_TYPE\": \"worker\",\n \"CONTAINER_ID\": \"ac1234def\"}\nLabel tags typically correspond to Label enum values. However, for ease\nof development other strings can be used as tags. LABEL_UNSPECIFIED should\nnot be used here." }, "time": { + "type": "string", "description": "The timestamp of the worker_message.", - "format": "google-datetime", - "type": "string" - }, - "workerShutdownNotice": { - "$ref": "WorkerShutdownNotice", - "description": "Shutdown notice by workers." + "format": "google-datetime" } }, "id": "WorkerMessage", "description": "WorkerMessage provides information to the backend about a worker." }, - "WorkerShutdownNoticeResponse": { - "type": "object", - "properties": {}, - "id": "WorkerShutdownNoticeResponse", - "description": "Service-side response to WorkerMessage issuing shutdown notice." - }, "JobMetrics": { "description": "JobMetrics contains a collection of metrics descibing the detailed progress\nof a Dataflow job. Metrics correspond to user-defined and system-defined\nmetrics in the job.\n\nThis resource captures only the most recent values of each metric;\ntime-series data can be queried for them (under the same metric names)\nfrom Cloud Monitoring.", "type": "object", @@ -4908,17 +3679,23 @@ }, "id": "JobMetrics" }, + "WorkerShutdownNoticeResponse": { + "type": "object", + "properties": {}, + "id": "WorkerShutdownNoticeResponse", + "description": "Service-side response to WorkerMessage issuing shutdown notice." + }, "FloatingPointList": { "description": "A metric value representing a list of floating point numbers.", "type": "object", "properties": { "elements": { - "description": "Elements of the list.", "type": "array", "items": { "type": "number", "format": "double" - } + }, + "description": "Elements of the list." } }, "id": "FloatingPointList" @@ -4927,38 +3704,21 @@ "description": "An update to a Counter sent from a worker.", "type": "object", "properties": { - "integerList": { - "$ref": "IntegerList", - "description": "List of integers, for Set." - }, - "structuredNameAndMetadata": { - "$ref": "CounterStructuredNameAndMetadata", - "description": "Counter structured name and metadata." - }, - "integerMean": { - "$ref": "IntegerMean", - "description": "Integer mean aggregation value for Mean." - }, - "floatingPoint": { - "description": "Floating point value for Sum, Max, Min.", - "format": "double", - "type": "number" - }, "internal": { - "description": "Value for internally-defined counters used by the Dataflow service.", - "type": "any" + "type": "any", + "description": "Value for internally-defined counters used by the Dataflow service." }, "cumulative": { - "type": "boolean", - "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta." + "description": "True if this counter is reported as the total cumulative aggregate\nvalue accumulated since the worker started working on this WorkItem.\nBy default this is false, indicating that this counter is reported\nas a delta.", + "type": "boolean" }, "floatingPointMean": { "$ref": "FloatingPointMean", "description": "Floating point mean aggregation value for Mean." }, "boolean": { - "type": "boolean", - "description": "Boolean value for And, Or." + "description": "Boolean value for And, Or.", + "type": "boolean" }, "nameAndKind": { "$ref": "NameAndKind", @@ -4973,9 +3733,9 @@ "description": "Distribution data" }, "shortId": { - "type": "string", "description": "The service-generated short identifier for this counter.\nThe short_id -\u003e (name, metadata) mapping is constant for the lifetime of\na job.", - "format": "int64" + "format": "int64", + "type": "string" }, "floatingPointList": { "$ref": "FloatingPointList", @@ -4984,33 +3744,59 @@ "integer": { "$ref": "SplitInt64", "description": "Integer value for Sum, Max, Min." + }, + "integerList": { + "$ref": "IntegerList", + "description": "List of integers, for Set." + }, + "structuredNameAndMetadata": { + "$ref": "CounterStructuredNameAndMetadata", + "description": "Counter structured name and metadata." + }, + "floatingPoint": { + "description": "Floating point value for Sum, Max, Min.", + "format": "double", + "type": "number" + }, + "integerMean": { + "$ref": "IntegerMean", + "description": "Integer mean aggregation value for Mean." } }, "id": "CounterUpdate" }, "SourceMetadata": { + "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc.", "type": "object", "properties": { "producesSortedKeys": { - "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order.", - "type": "boolean" + "type": "boolean", + "description": "Whether this source is known to produce key/value pairs with\nthe (encoded) keys in lexicographically sorted order." }, "infinite": { - "description": "Specifies that the size of this source is known to be infinite\n(this is a streaming source).", - "type": "boolean" + "type": "boolean", + "description": "Specifies that the size of this source is known to be infinite\n(this is a streaming source)." }, "estimatedSizeBytes": { + "type": "string", "description": "An estimate of the total size (in bytes) of the data that would be\nread from this source. This estimate is in terms of external storage\nsize, before any decompression or other processing done by the reader.", - "format": "int64", - "type": "string" + "format": "int64" } }, - "id": "SourceMetadata", - "description": "Metadata about a Source useful for automatically optimizing\nand tuning the pipeline, etc." + "id": "SourceMetadata" }, "DistributionUpdate": { + "description": "A metric value representing a distribution.", "type": "object", "properties": { + "histogram": { + "$ref": "Histogram", + "description": "(Optional) Histogram of value counts for the distribution." + }, + "max": { + "$ref": "SplitInt64", + "description": "The maximum value present in the distribution." + }, "count": { "$ref": "SplitInt64", "description": "The count of the number of elements present in the distribution." @@ -5027,22 +3813,17 @@ "sum": { "$ref": "SplitInt64", "description": "Use an int64 since we'd prefer the added precision. If overflow is a common\nproblem we can detect it and use an additional int64 or a double." - }, - "max": { - "$ref": "SplitInt64", - "description": "The maximum value present in the distribution." - }, - "histogram": { - "$ref": "Histogram", - "description": "(Optional) Histogram of value counts for the distribution." } }, - "id": "DistributionUpdate", - "description": "A metric value representing a distribution." + "id": "DistributionUpdate" }, "SourceFork": { "type": "object", "properties": { + "residual": { + "$ref": "SourceSplitShard", + "description": "DEPRECATED" + }, "residualSource": { "$ref": "DerivedSource", "description": "DEPRECATED" @@ -5054,10 +3835,6 @@ "primarySource": { "$ref": "DerivedSource", "description": "DEPRECATED" - }, - "residual": { - "$ref": "SourceSplitShard", - "description": "DEPRECATED" } }, "id": "SourceFork", @@ -5068,35 +3845,1256 @@ "type": "object", "properties": { "reportInterval": { + "type": "string", "description": "A positive value indicates the worker should change its reporting interval\nto the specified value.\n\nThe default value of zero means no change in report rate is requested by\nthe server.", - "format": "google-duration", - "type": "string" + "format": "google-duration" } }, "id": "WorkerHealthReportResponse" + }, + "WorkItemStatus": { + "description": "Conveys a worker's progress through the work described by a WorkItem.", + "type": "object", + "properties": { + "errors": { + "description": "Specifies errors which occurred during processing. If errors are\nprovided, and completed = true, then the WorkItem is considered\nto have failed.", + "type": "array", + "items": { + "$ref": "Status" + } + }, + "metricUpdates": { + "description": "DEPRECATED in favor of counter_updates.", + "type": "array", + "items": { + "$ref": "MetricUpdate" + } + }, + "dynamicSourceSplit": { + "description": "See documentation of stop_position.", + "$ref": "DynamicSourceSplit" + }, + "sourceOperationResponse": { + "description": "If the work item represented a SourceOperationRequest, and the work\nis completed, contains the result of the operation.", + "$ref": "SourceOperationResponse" + }, + "progress": { + "$ref": "ApproximateProgress", + "description": "DEPRECATED in favor of reported_progress." + }, + "requestedLeaseDuration": { + "description": "Amount of time the worker requests for its lease.", + "format": "google-duration", + "type": "string" + }, + "reportIndex": { + "description": "The report index. When a WorkItem is leased, the lease will\ncontain an initial report index. When a WorkItem's status is\nreported to the system, the report should be sent with\nthat report index, and the response will contain the index the\nworker should use for the next report. Reports received with\nunexpected index values will be rejected by the service.\n\nIn order to preserve idempotency, the worker should not alter the\ncontents of a report, even if the worker must submit the same\nreport multiple times before getting back a response. The worker\nshould not submit a subsequent report until the response for the\nprevious report had been received from the service.", + "format": "int64", + "type": "string" + }, + "stopPosition": { + "$ref": "Position", + "description": "A worker may split an active map task in two parts, \"primary\" and\n\"residual\", continuing to process the primary part and returning the\nresidual part into the pool of available work.\nThis event is called a \"dynamic split\" and is critical to the dynamic\nwork rebalancing feature. The two obtained sub-tasks are called\n\"parts\" of the split.\nThe parts, if concatenated, must represent the same input as would\nbe read by the current task if the split did not happen.\nThe exact way in which the original task is decomposed into the two\nparts is specified either as a position demarcating them\n(stop_position), or explicitly as two DerivedSources, if this\ntask consumes a user-defined source type (dynamic_source_split).\n\nThe \"current\" task is adjusted as a result of the split: after a task\nwith range [A, B) sends a stop_position update at C, its range is\nconsidered to be [A, C), e.g.:\n* Progress should be interpreted relative to the new range, e.g.\n \"75% completed\" means \"75% of [A, C) completed\"\n* The worker should interpret proposed_stop_position relative to the\n new range, e.g. \"split at 68%\" should be interpreted as\n \"split at 68% of [A, C)\".\n* If the worker chooses to split again using stop_position, only\n stop_positions in [A, C) will be accepted.\n* Etc.\ndynamic_source_split has similar semantics: e.g., if a task with\nsource S splits using dynamic_source_split into {P, R}\n(where P and R must be together equivalent to S), then subsequent\nprogress and proposed_stop_position should be interpreted relative\nto P, and in a potential subsequent dynamic_source_split into {P', R'},\nP' and R' must be together equivalent to P, etc." + }, + "completed": { + "description": "True if the WorkItem was completed (successfully or unsuccessfully).", + "type": "boolean" + }, + "reportedProgress": { + "$ref": "ApproximateReportedProgress", + "description": "The worker's progress through this WorkItem." + }, + "sourceFork": { + "description": "DEPRECATED in favor of dynamic_source_split.", + "$ref": "SourceFork" + }, + "totalThrottlerWaitTimeSeconds": { + "description": "Total time the worker spent being throttled by external systems.", + "format": "double", + "type": "number" + }, + "counterUpdates": { + "description": "Worker output counters for this WorkItem.", + "type": "array", + "items": { + "$ref": "CounterUpdate" + } + }, + "workItemId": { + "description": "Identifies the WorkItem.", + "type": "string" + } + }, + "id": "WorkItemStatus" + }, + "ComponentSource": { + "description": "Description of an interstitial value between transforms in an execution\nstage.", + "type": "object", + "properties": { + "originalTransformOrCollection": { + "description": "User name for the original user transform or collection with which this\nsource is most closely associated.", + "type": "string" + }, + "name": { + "description": "Dataflow service generated name for this source.", + "type": "string" + }, + "userName": { + "description": "Human-readable name for this transform; may be user or system generated.", + "type": "string" + } + }, + "id": "ComponentSource" + }, + "Histogram": { + "description": "Histogram of value counts for a distribution.\n\nBuckets have an inclusive lower bound and exclusive upper bound and use\n\"1,2,5 bucketing\": The first bucket range is from [0,1) and all subsequent\nbucket boundaries are powers of ten multiplied by 1, 2, or 5. Thus, bucket\nboundaries are 0, 1, 2, 5, 10, 20, 50, 100, 200, 500, 1000, ...\nNegative values are not supported.", + "type": "object", + "properties": { + "firstBucketOffset": { + "description": "Starting index of first stored bucket. The non-inclusive upper-bound of\nthe ith bucket is given by:\n pow(10,(i-first_bucket_offset)/3) * (1,2,5)[(i-first_bucket_offset)%3]", + "format": "int32", + "type": "integer" + }, + "bucketCounts": { + "description": "Counts of values in each bucket. For efficiency, prefix and trailing\nbuckets with count = 0 are elided. Buckets can store the full range of\nvalues of an unsigned long, with ULLONG_MAX falling into the 59th bucket\nwith range [1e19, 2e19).", + "type": "array", + "items": { + "format": "int64", + "type": "string" + } + } + }, + "id": "Histogram" + }, + "WorkItemServiceState": { + "description": "The Dataflow service's idea of the current state of a WorkItem\nbeing processed by a worker.", + "type": "object", + "properties": { + "leaseExpireTime": { + "description": "Time at which the current lease will expire.", + "format": "google-datetime", + "type": "string" + }, + "metricShortId": { + "description": "The short ids that workers should use in subsequent metric updates.\nWorkers should strive to use short ids whenever possible, but it is ok\nto request the short_id again if a worker lost track of it\n(e.g. if the worker is recovering from a crash).\nNOTE: it is possible that the response may have short ids for a subset\nof the metrics.", + "type": "array", + "items": { + "$ref": "MetricShortId" + } + }, + "nextReportIndex": { + "description": "The index value to use for the next report sent by the worker.\nNote: If the report call fails for whatever reason, the worker should\nreuse this index for subsequent report attempts.", + "format": "int64", + "type": "string" + }, + "suggestedStopPoint": { + "$ref": "ApproximateProgress", + "description": "DEPRECATED in favor of split_request." + }, + "splitRequest": { + "$ref": "ApproximateSplitRequest", + "description": "The progress point in the WorkItem where the Dataflow service\nsuggests that the worker truncate the task." + }, + "suggestedStopPosition": { + "$ref": "Position", + "description": "Obsolete, always empty." + }, + "reportStatusInterval": { + "description": "New recommended reporting interval.", + "format": "google-duration", + "type": "string" + }, + "harnessData": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Other data returned by the service, specific to the particular\nworker harness.", + "type": "object" + } + }, + "id": "WorkItemServiceState" + }, + "MetricStructuredName": { + "description": "Identifies a metric, by describing the source which generated the\nmetric.", + "type": "object", + "properties": { + "context": { + "additionalProperties": { + "type": "string" + }, + "description": "Zero or more labeled fields which identify the part of the job this\nmetric is associated with, such as the name of a step or collection.\n\nFor example, built-in counters associated with steps will have\ncontext['step'] = \u003cstep-name\u003e. Counters associated with PCollections\nin the SDK will have context['pcollection'] = \u003cpcollection-name\u003e.", + "type": "object" + }, + "origin": { + "description": "Origin (namespace) of metric name. May be blank for user-define metrics;\nwill be \"dataflow\" for metrics defined by the Dataflow service or SDK.", + "type": "string" + }, + "name": { + "description": "Worker-defined metric name.", + "type": "string" + } + }, + "id": "MetricStructuredName" + }, + "SeqMapTaskOutputInfo": { + "properties": { + "tag": { + "description": "The id of the TupleTag the user code will tag the output value by.", + "type": "string" + }, + "sink": { + "$ref": "Sink", + "description": "The sink to write the output value to." + } + }, + "id": "SeqMapTaskOutputInfo", + "description": "Information about an output of a SeqMapTask.", + "type": "object" + }, + "JobExecutionStageInfo": { + "properties": { + "stepName": { + "description": "The steps associated with the execution stage.\nNote that stages may have several steps, and that a given step\nmight be run by more than one stage.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "JobExecutionStageInfo", + "description": "Contains information about how a particular\ngoogle.dataflow.v1beta3.Step will be executed.", + "type": "object" + }, + "KeyRangeLocation": { + "properties": { + "deprecatedPersistentDirectory": { + "description": "DEPRECATED. The location of the persistent state for this range, as a\npersistent directory in the worker local filesystem.", + "type": "string" + }, + "deliveryEndpoint": { + "description": "The physical location of this range assignment to be used for\nstreaming computation cross-worker message delivery.", + "type": "string" + }, + "start": { + "description": "The start (inclusive) of the key range.", + "type": "string" + }, + "dataDisk": { + "description": "The name of the data disk where data for this range is stored.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", + "type": "string" + }, + "end": { + "description": "The end (exclusive) of the key range.", + "type": "string" + } + }, + "id": "KeyRangeLocation", + "description": "Location information for a specific key-range of a sharded computation.\nCurrently we only support UTF-8 character splits to simplify encoding into\nJSON.", + "type": "object" + }, + "SourceGetMetadataRequest": { + "properties": { + "source": { + "description": "Specification of the source whose metadata should be computed.", + "$ref": "Source" + } + }, + "id": "SourceGetMetadataRequest", + "description": "A request to compute the SourceMetadata of a Source.", + "type": "object" + }, + "SeqMapTask": { + "properties": { + "inputs": { + "description": "Information about each of the inputs.", + "type": "array", + "items": { + "$ref": "SideInputInfo" + } + }, + "systemName": { + "description": "System-defined name of the SeqDo operation.\nUnique across the workflow.", + "type": "string" + }, + "stageName": { + "description": "System-defined name of the stage containing the SeqDo operation.\nUnique across the workflow.", + "type": "string" + }, + "userFn": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The user function to invoke.", + "type": "object" + }, + "name": { + "description": "The user-provided name of the SeqDo operation.", + "type": "string" + }, + "outputInfos": { + "description": "Information about each of the outputs.", + "type": "array", + "items": { + "$ref": "SeqMapTaskOutputInfo" + } + } + }, + "id": "SeqMapTask", + "description": "Describes a particular function to invoke.", + "type": "object" + }, + "NameAndKind": { + "description": "Basic metadata about a counter.", + "type": "object", + "properties": { + "name": { + "description": "Name of the counter.", + "type": "string" + }, + "kind": { + "enum": [ + "INVALID", + "SUM", + "MAX", + "MIN", + "MEAN", + "OR", + "AND", + "SET", + "DISTRIBUTION" + ], + "description": "Counter aggregation kind.", + "type": "string", + "enumDescriptions": [ + "Counter aggregation kind was not set.", + "Aggregated value is the sum of all contributed values.", + "Aggregated value is the max of all contributed values.", + "Aggregated value is the min of all contributed values.", + "Aggregated value is the mean of all contributed values.", + "Aggregated value represents the logical 'or' of all contributed values.", + "Aggregated value represents the logical 'and' of all contributed values.", + "Aggregated value is a set of unique contributed values.", + "Aggregated value captures statistics about a distribution." + ] + } + }, + "id": "NameAndKind" + }, + "WorkerMessageCode": { + "description": "A message code is used to report status and error messages to the service.\nThe message codes are intended to be machine readable. The service will\ntake care of translating these into user understandable messages if\nnecessary.\n\nExample use cases:\n 1. Worker processes reporting successful startup.\n 2. Worker processes reporting specific errors (e.g. package staging\n failure).", + "type": "object", + "properties": { + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Parameters contains specific information about the code.\n\nThis is a struct to allow parameters of different types.\n\nExamples:\n 1. For a \"HARNESS_STARTED\" message parameters might provide the name\n of the worker and additional data like timing information.\n 2. For a \"GCS_DOWNLOAD_ERROR\" parameters might contain fields listing\n the GCS objects being downloaded and fields containing errors.\n\nIn general complex data structures should be avoided. If a worker\nneeds to send a specific and complicated data structure then please\nconsider defining a new proto and adding it to the data oneof in\nWorkerMessageResponse.\n\nConventions:\n Parameters should only be used for information that isn't typically passed\n as a label.\n hostname and other worker identifiers should almost always be passed\n as labels since they will be included on most messages.", + "type": "object" + }, + "code": { + "description": "The code is a string intended for consumption by a machine that identifies\nthe type of message being sent.\nExamples:\n 1. \"HARNESS_STARTED\" might be used to indicate the worker harness has\n started.\n 2. \"GCS_DOWNLOAD_ERROR\" might be used to indicate an error downloading\n a GCS file as part of the boot process of one of the worker containers.\n\nThis is a string and not an enum to make it easy to add new codes without\nwaiting for an API change.", + "type": "string" + } + }, + "id": "WorkerMessageCode" + }, + "CustomSourceLocation": { + "description": "Identifies the location of a custom souce.", + "type": "object", + "properties": { + "stateful": { + "description": "Whether this source is stateful.", + "type": "boolean" + } + }, + "id": "CustomSourceLocation" + }, + "MapTask": { + "description": "MapTask consists of an ordered set of instructions, each of which\ndescribes one particular low-level operation for the worker to\nperform in order to accomplish the MapTask's WorkItem.\n\nEach instruction must appear in the list before any instructions which\ndepends on its output.", + "type": "object", + "properties": { + "systemName": { + "description": "System-defined name of this MapTask.\nUnique across the workflow.", + "type": "string" + }, + "stageName": { + "description": "System-defined name of the stage containing this MapTask.\nUnique across the workflow.", + "type": "string" + }, + "instructions": { + "description": "The instructions in the MapTask.", + "type": "array", + "items": { + "$ref": "ParallelInstruction" + } + } + }, + "id": "MapTask" + }, + "FloatingPointMean": { + "properties": { + "sum": { + "description": "The sum of all values being aggregated.", + "format": "double", + "type": "number" + }, + "count": { + "description": "The number of values being aggregated.", + "$ref": "SplitInt64" + } + }, + "id": "FloatingPointMean", + "description": "A representation of a floating point mean metric contribution.", + "type": "object" + }, + "ReportWorkItemStatusResponse": { + "properties": { + "workItemServiceStates": { + "description": "A set of messages indicating the service-side state for each\nWorkItem whose status was reported, in the same order as the\nWorkItemStatus messages in the ReportWorkItemStatusRequest which\nresulting in this response.", + "type": "array", + "items": { + "$ref": "WorkItemServiceState" + } + } + }, + "id": "ReportWorkItemStatusResponse", + "description": "Response from a request to report the status of WorkItems.", + "type": "object" + }, + "InstructionOutput": { + "properties": { + "originalName": { + "description": "System-defined name for this output in the original workflow graph.\nOutputs that do not contribute to an original instruction do not set this.", + "type": "string" + }, + "systemName": { + "description": "System-defined name of this output.\nUnique across the workflow.", + "type": "string" + }, + "onlyCountKeyBytes": { + "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the key size.", + "type": "boolean" + }, + "onlyCountValueBytes": { + "description": "For system-generated byte and mean byte metrics, certain instructions\nshould only report the value size.", + "type": "boolean" + }, + "codec": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The codec to use to encode data being written via this output.", + "type": "object" + }, + "name": { + "description": "The user-provided name of this output.", + "type": "string" + } + }, + "id": "InstructionOutput", + "description": "An output of an instruction.", + "type": "object" + }, + "CreateJobFromTemplateRequest": { + "description": "A request to create a Cloud Dataflow job from a template.", + "type": "object", + "properties": { + "parameters": { + "additionalProperties": { + "type": "string" + }, + "description": "The runtime parameters to pass to the job.", + "type": "object" + }, + "jobName": { + "description": "Required. The job name to use for the created job.", + "type": "string" + }, + "gcsPath": { + "description": "Required. A Cloud Storage path to the template from which to\ncreate the job.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", + "type": "string" + }, + "environment": { + "description": "The runtime environment for the job.", + "$ref": "RuntimeEnvironment" + }, + "location": { + "description": "The location to which to direct the request.", + "type": "string" + } + }, + "id": "CreateJobFromTemplateRequest" + }, + "IntegerMean": { + "properties": { + "sum": { + "description": "The sum of all values being aggregated.", + "$ref": "SplitInt64" + }, + "count": { + "$ref": "SplitInt64", + "description": "The number of values being aggregated." + } + }, + "id": "IntegerMean", + "description": "A representation of an integer mean metric contribution.", + "type": "object" + }, + "ListJobsResponse": { + "properties": { + "jobs": { + "description": "A subset of the requested job information.", + "type": "array", + "items": { + "$ref": "Job" + } + }, + "nextPageToken": { + "description": "Set if there may be more results than fit in this response.", + "type": "string" + }, + "failedLocation": { + "description": "Zero or more messages describing locations that failed to respond.", + "type": "array", + "items": { + "$ref": "FailedLocation" + } + } + }, + "id": "ListJobsResponse", + "description": "Response to a request to list Cloud Dataflow jobs. This may be a partial\nresponse, depending on the page size in the ListJobsRequest.", + "type": "object" + }, + "ComputationTopology": { + "description": "All configuration data for a particular Computation.", + "type": "object", + "properties": { + "outputs": { + "description": "The outputs from the computation.", + "type": "array", + "items": { + "$ref": "StreamLocation" + } + }, + "stateFamilies": { + "description": "The state family values.", + "type": "array", + "items": { + "$ref": "StateFamilyConfig" + } + }, + "systemStageName": { + "description": "The system stage name.", + "type": "string" + }, + "computationId": { + "description": "The ID of the computation.", + "type": "string" + }, + "inputs": { + "description": "The inputs to the computation.", + "type": "array", + "items": { + "$ref": "StreamLocation" + } + }, + "keyRanges": { + "description": "The key ranges processed by the computation.", + "type": "array", + "items": { + "$ref": "KeyRangeLocation" + } + } + }, + "id": "ComputationTopology" + }, + "RuntimeEnvironment": { + "description": "The environment values to set at runtime.", + "type": "object", + "properties": { + "serviceAccountEmail": { + "description": "The email address of the service account to run the job as.", + "type": "string" + }, + "tempLocation": { + "description": "The Cloud Storage path to use for temporary files.\nMust be a valid Cloud Storage URL, beginning with `gs://`.", + "type": "string" + }, + "bypassTempDirValidation": { + "description": "Whether to bypass the safety checks for the job's temporary directory.\nUse with caution.", + "type": "boolean" + }, + "machineType": { + "description": "The machine type to use for the job. Defaults to the value from the\ntemplate if not specified.", + "type": "string" + }, + "zone": { + "description": "The Compute Engine [availability\nzone](https://cloud.google.com/compute/docs/regions-zones/regions-zones)\nfor launching worker instances to run your pipeline.", + "type": "string" + }, + "additionalExperiments": { + "description": "Additional experiment flags for the job.", + "type": "array", + "items": { + "type": "string" + } + }, + "maxWorkers": { + "description": "The maximum number of Google Compute Engine instances to be made\navailable to your pipeline during execution, from 1 to 1000.", + "format": "int32", + "type": "integer" + } + }, + "id": "RuntimeEnvironment" + }, + "StreamingSideInputLocation": { + "description": "Identifies the location of a streaming side input.", + "type": "object", + "properties": { + "tag": { + "description": "Identifies the particular side input within the streaming Dataflow job.", + "type": "string" + }, + "stateFamily": { + "description": "Identifies the state family where this side input is stored.", + "type": "string" + } + }, + "id": "StreamingSideInputLocation" + }, + "MountedDataDisk": { + "properties": { + "dataDisk": { + "description": "The name of the data disk.\nThis name is local to the Google Cloud Platform project and uniquely\nidentifies the disk within that project, for example\n\"myproject-1014-104817-4c2-harness-0-disk-1\".", + "type": "string" + } + }, + "id": "MountedDataDisk", + "description": "Describes mounted data disk.", + "type": "object" + }, + "LaunchTemplateResponse": { + "properties": { + "job": { + "$ref": "Job", + "description": "The job that was launched, if the request was not a dry run and\nthe job was successfully launched." + } + }, + "id": "LaunchTemplateResponse", + "description": "Response to the request to launch a template.", + "type": "object" + }, + "DerivedSource": { + "description": "Specification of one of the bundles produced as a result of splitting\na Source (e.g. when executing a SourceSplitRequest, or when\nsplitting an active task using WorkItemStatus.dynamic_source_split),\nrelative to the source being split.", + "type": "object", + "properties": { + "derivationMode": { + "enum": [ + "SOURCE_DERIVATION_MODE_UNKNOWN", + "SOURCE_DERIVATION_MODE_INDEPENDENT", + "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", + "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" + ], + "description": "What source to base the produced source on (if any).", + "type": "string", + "enumDescriptions": [ + "The source derivation is unknown, or unspecified.", + "Produce a completely independent Source with no base.", + "Produce a Source based on the Source being split.", + "Produce a Source based on the base of the Source being split." + ] + }, + "source": { + "description": "Specification of the source.", + "$ref": "Source" + } + }, + "id": "DerivedSource" + }, + "DynamicSourceSplit": { + "properties": { + "primary": { + "description": "Primary part (continued to be processed by worker).\nSpecified relative to the previously-current source.\nBecomes current.", + "$ref": "DerivedSource" + }, + "residual": { + "$ref": "DerivedSource", + "description": "Residual part (returned to the pool of work).\nSpecified relative to the previously-current source." + } + }, + "id": "DynamicSourceSplit", + "description": "When a task splits using WorkItemStatus.dynamic_source_split, this\nmessage describes the two parts of the split relative to the\ndescription of the current task's input.", + "type": "object" + }, + "Job": { + "description": "Defines a job to be run by the Cloud Dataflow service.", + "type": "object", + "properties": { + "stageStates": { + "description": "This field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.", + "type": "array", + "items": { + "$ref": "ExecutionStageState" + } + }, + "projectId": { + "description": "The ID of the Cloud Platform project that the job belongs to.", + "type": "string" + }, + "type": { + "enum": [ + "JOB_TYPE_UNKNOWN", + "JOB_TYPE_BATCH", + "JOB_TYPE_STREAMING" + ], + "description": "The type of Cloud Dataflow job.", + "type": "string", + "enumDescriptions": [ + "The type of the job is unspecified, or unknown.", + "A batch job with a well-defined end point: data is read, data is\nprocessed, data is written, and the job is done.", + "A continuously streaming job with no end: data is read,\nprocessed, and written continuously." + ] + }, + "pipelineDescription": { + "$ref": "PipelineDescription", + "description": "Preliminary field: The format of this data may change at any time.\nA description of the user pipeline and stages through which it is executed.\nCreated by Cloud Dataflow service. Only retrieved with\nJOB_VIEW_DESCRIPTION or JOB_VIEW_ALL." + }, + "replaceJobId": { + "description": "If this job is an update of an existing job, this field is the job ID\nof the job it replaced.\n\nWhen sending a `CreateJobRequest`, you can update a job by specifying it\nhere. The job named here is stopped, and its intermediate state is\ntransferred to this job.", + "type": "string" + }, + "requestedState": { + "enum": [ + "JOB_STATE_UNKNOWN", + "JOB_STATE_STOPPED", + "JOB_STATE_RUNNING", + "JOB_STATE_DONE", + "JOB_STATE_FAILED", + "JOB_STATE_CANCELLED", + "JOB_STATE_UPDATED", + "JOB_STATE_DRAINING", + "JOB_STATE_DRAINED", + "JOB_STATE_PENDING", + "JOB_STATE_CANCELLING" + ], + "description": "The job's requested state.\n\n`UpdateJob` may be used to switch between the `JOB_STATE_STOPPED` and\n`JOB_STATE_RUNNING` states, by setting requested_state. `UpdateJob` may\nalso be used to directly set a job's requested state to\n`JOB_STATE_CANCELLED` or `JOB_STATE_DONE`, irrevocably terminating the\njob if it has not already reached a terminal state.", + "type": "string", + "enumDescriptions": [ + "The job's run state isn't specified.", + "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.", + "`JOB_STATE_RUNNING` indicates that the job is currently running.", + "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.", + "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.", + "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.", + "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.", + "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.", + "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.", + "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.", + "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'." + ] + }, + "tempFiles": { + "description": "A set of files the system should be aware of that are used\nfor temporary storage. These temporary files will be\nremoved on job completion.\nNo duplicates are allowed.\nNo file patterns are supported.\n\nThe supported files are:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", + "type": "array", + "items": { + "type": "string" + } + }, + "clientRequestId": { + "description": "The client's unique identifier of the job, re-used across retried attempts.\nIf this field is set, the service will ensure its uniqueness.\nThe request to create a job will fail if the service has knowledge of a\npreviously submitted job with the same client's ID and job name.\nThe caller may use this field to ensure idempotence of job\ncreation across retried attempts to create a job.\nBy default, the field is empty and, in that case, the service ignores it.", + "type": "string" + }, + "name": { + "description": "The user-specified Cloud Dataflow job name.\n\nOnly one Job with a given name may exist in a project at any\ngiven time. If a caller attempts to create a Job with the same\nname as an already-existing Job, the attempt returns the\nexisting Job.\n\nThe name must match the regular expression\n`[a-z]([-a-z0-9]{0,38}[a-z0-9])?`", + "type": "string" + }, + "replacedByJobId": { + "description": "If another job is an update of this job (and thus, this job is in\n`JOB_STATE_UPDATED`), this field contains the ID of that job.", + "type": "string" + }, + "steps": { + "description": "The top-level steps that constitute the entire job.", + "type": "array", + "items": { + "$ref": "Step" + } + }, + "executionInfo": { + "$ref": "JobExecutionInfo", + "description": "Deprecated." + }, + "id": { + "description": "The unique ID of this job.\n\nThis field is set by the Cloud Dataflow service when the Job is\ncreated, and is immutable for the life of the job.", + "type": "string" + }, + "currentState": { + "enum": [ + "JOB_STATE_UNKNOWN", + "JOB_STATE_STOPPED", + "JOB_STATE_RUNNING", + "JOB_STATE_DONE", + "JOB_STATE_FAILED", + "JOB_STATE_CANCELLED", + "JOB_STATE_UPDATED", + "JOB_STATE_DRAINING", + "JOB_STATE_DRAINED", + "JOB_STATE_PENDING", + "JOB_STATE_CANCELLING" + ], + "description": "The current state of the job.\n\nJobs are created in the `JOB_STATE_STOPPED` state unless otherwise\nspecified.\n\nA job in the `JOB_STATE_RUNNING` state may asynchronously enter a\nterminal state. After a job has reached a terminal state, no\nfurther state updates may be made.\n\nThis field may be mutated by the Cloud Dataflow service;\ncallers cannot mutate it.", + "type": "string", + "enumDescriptions": [ + "The job's run state isn't specified.", + "`JOB_STATE_STOPPED` indicates that the job has not\nyet started to run.", + "`JOB_STATE_RUNNING` indicates that the job is currently running.", + "`JOB_STATE_DONE` indicates that the job has successfully completed.\nThis is a terminal job state. This state may be set by the Cloud Dataflow\nservice, as a transition from `JOB_STATE_RUNNING`. It may also be set via a\nCloud Dataflow `UpdateJob` call, if the job has not yet reached a terminal\nstate.", + "`JOB_STATE_FAILED` indicates that the job has failed. This is a\nterminal job state. This state may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_RUNNING`.", + "`JOB_STATE_CANCELLED` indicates that the job has been explicitly\ncancelled. This is a terminal job state. This state may only be\nset via a Cloud Dataflow `UpdateJob` call, and only if the job has not\nyet reached another terminal state.", + "`JOB_STATE_UPDATED` indicates that the job was successfully updated,\nmeaning that this job was stopped and another job was started, inheriting\nstate from this one. This is a terminal job state. This state may only be\nset by the Cloud Dataflow service, and only as a transition from\n`JOB_STATE_RUNNING`.", + "`JOB_STATE_DRAINING` indicates that the job is in the process of draining.\nA draining job has stopped pulling from its input sources and is processing\nany data that remains in-flight. This state may be set via a Cloud Dataflow\n`UpdateJob` call, but only as a transition from `JOB_STATE_RUNNING`. Jobs\nthat are draining may only transition to `JOB_STATE_DRAINED`,\n`JOB_STATE_CANCELLED`, or `JOB_STATE_FAILED`.", + "`JOB_STATE_DRAINED` indicates that the job has been drained.\nA drained job terminated by stopping pulling from its input sources and\nprocessing any data that remained in-flight when draining was requested.\nThis state is a terminal state, may only be set by the Cloud Dataflow\nservice, and only as a transition from `JOB_STATE_DRAINING`.", + "'JOB_STATE_PENDING' indicates that the job has been created but is not yet\nrunning. Jobs that are pending may only transition to `JOB_STATE_RUNNING`,\nor `JOB_STATE_FAILED`.", + "'JOB_STATE_CANCELLING' indicates that the job has been explicitly cancelled\nand is in the process of stopping. Jobs that are cancelling may only\ntransition to 'JOB_STATE_CANCELLED' or 'JOB_STATE_FAILED'." + ] + }, + "location": { + "description": "The location that contains this job.", + "type": "string" + }, + "currentStateTime": { + "description": "The timestamp associated with the current state.", + "format": "google-datetime", + "type": "string" + }, + "transformNameMapping": { + "additionalProperties": { + "type": "string" + }, + "description": "The map of transform name prefixes of the job to be replaced to the\ncorresponding name prefixes of the new job.", + "type": "object" + }, + "createTime": { + "description": "The timestamp when the job was initially created. Immutable and set by the\nCloud Dataflow service.", + "format": "google-datetime", + "type": "string" + }, + "environment": { + "$ref": "Environment", + "description": "The environment for the job." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "User-defined labels for this job.\n\nThe labels map can contain no more than 64 entries. Entries of the labels\nmap are UTF8 strings that comply with the following restrictions:\n\n* Keys must conform to regexp: \\p{Ll}\\p{Lo}{0,62}\n* Values must conform to regexp: [\\p{Ll}\\p{Lo}\\p{N}_-]{0,63}\n* Both keys and values are additionally constrained to be \u003c= 128 bytes in\nsize.", + "type": "object" + } + }, + "id": "Job" + }, + "SourceOperationResponse": { + "properties": { + "getMetadata": { + "$ref": "SourceGetMetadataResponse", + "description": "A response to a request to get metadata about a source." + }, + "split": { + "$ref": "SourceSplitResponse", + "description": "A response to a request to split a source." + } + }, + "id": "SourceOperationResponse", + "description": "The result of a SourceOperationRequest, specified in\nReportWorkItemStatusRequest.source_operation when the work item\nis completed.", + "type": "object" + }, + "SideInputInfo": { + "description": "Information about a side input of a DoFn or an input of a SeqDoFn.", + "type": "object", + "properties": { + "sources": { + "description": "The source(s) to read element(s) from to get the value of this side input.\nIf more than one source, then the elements are taken from the\nsources, in the specified order if order matters.\nAt least one source is required.", + "type": "array", + "items": { + "$ref": "Source" + } + }, + "kind": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "How to interpret the source element(s) as a side input value.", + "type": "object" + }, + "tag": { + "description": "The id of the tag the user code will access this side input by;\nthis should correspond to the tag of some MultiOutputInfo.", + "type": "string" + } + }, + "id": "SideInputInfo" + }, + "SendDebugCaptureResponse": { + "description": "Response to a send capture request.\nnothing", + "type": "object", + "properties": {}, + "id": "SendDebugCaptureResponse" + }, + "WriteInstruction": { + "properties": { + "input": { + "description": "The input.", + "$ref": "InstructionInput" + }, + "sink": { + "description": "The sink to write to.", + "$ref": "Sink" + } + }, + "id": "WriteInstruction", + "description": "An instruction that writes records.\nTakes one input, produces no outputs.", + "type": "object" + }, + "ConcatPosition": { + "description": "A position that encapsulates an inner position and an index for the inner\nposition. A ConcatPosition can be used by a reader of a source that\nencapsulates a set of other sources.", + "type": "object", + "properties": { + "position": { + "description": "Position within the inner source.", + "$ref": "Position" + }, + "index": { + "description": "Index of the inner source.", + "format": "int32", + "type": "integer" + } + }, + "id": "ConcatPosition" + }, + "CounterStructuredNameAndMetadata": { + "properties": { + "name": { + "$ref": "CounterStructuredName", + "description": "Structured name of the counter." + }, + "metadata": { + "$ref": "CounterMetadata", + "description": "Metadata associated with a counter" + } + }, + "id": "CounterStructuredNameAndMetadata", + "description": "A single message which encapsulates structured name and metadata for a given\ncounter.", + "type": "object" + }, + "AutoscalingSettings": { + "description": "Settings for WorkerPool autoscaling.", + "type": "object", + "properties": { + "algorithm": { + "enum": [ + "AUTOSCALING_ALGORITHM_UNKNOWN", + "AUTOSCALING_ALGORITHM_NONE", + "AUTOSCALING_ALGORITHM_BASIC" + ], + "description": "The algorithm to use for autoscaling.", + "type": "string", + "enumDescriptions": [ + "The algorithm is unknown, or unspecified.", + "Disable autoscaling.", + "Increase worker count over time to reduce job execution time." + ] + }, + "maxNumWorkers": { + "description": "The maximum number of workers to cap scaling at.", + "format": "int32", + "type": "integer" + } + }, + "id": "AutoscalingSettings" + }, + "StreamingComputationRanges": { + "properties": { + "computationId": { + "description": "The ID of the computation.", + "type": "string" + }, + "rangeAssignments": { + "description": "Data disk assignments for ranges from this computation.", + "type": "array", + "items": { + "$ref": "KeyRangeDataDiskAssignment" + } + } + }, + "id": "StreamingComputationRanges", + "description": "Describes full or partial data disk assignment information of the computation\nranges.", + "type": "object" + }, + "ExecutionStageSummary": { + "properties": { + "outputSource": { + "description": "Output sources for this stage.", + "type": "array", + "items": { + "$ref": "StageSource" + } + }, + "name": { + "description": "Dataflow service generated name for this stage.", + "type": "string" + }, + "inputSource": { + "description": "Input sources for this stage.", + "type": "array", + "items": { + "$ref": "StageSource" + } + }, + "id": { + "description": "Dataflow service generated id for this stage.", + "type": "string" + }, + "componentTransform": { + "description": "Transforms that comprise this execution stage.", + "type": "array", + "items": { + "$ref": "ComponentTransform" + } + }, + "componentSource": { + "description": "Collections produced and consumed by component transforms of this stage.", + "type": "array", + "items": { + "$ref": "ComponentSource" + } + }, + "kind": { + "enumDescriptions": [ + "Unrecognized transform type.", + "ParDo transform.", + "Group By Key transform.", + "Flatten transform.", + "Read transform.", + "Write transform.", + "Constructs from a constant value, such as with Create.of.", + "Creates a Singleton view of a collection.", + "Opening or closing a shuffle session, often as part of a GroupByKey." + ], + "enum": [ + "UNKNOWN_KIND", + "PAR_DO_KIND", + "GROUP_BY_KEY_KIND", + "FLATTEN_KIND", + "READ_KIND", + "WRITE_KIND", + "CONSTANT_KIND", + "SINGLETON_KIND", + "SHUFFLE_KIND" + ], + "description": "Type of tranform this stage is executing.", + "type": "string" + } + }, + "id": "ExecutionStageSummary", + "description": "Description of the composing transforms, names/ids, and input/outputs of a\nstage of execution. Some composing transforms and sources may have been\ngenerated by the Dataflow service during execution planning.", + "type": "object" + }, + "SendWorkerMessagesRequest": { + "description": "A request for sending worker messages to the service.", + "type": "object", + "properties": { + "workerMessages": { + "description": "The WorkerMessages to send.", + "type": "array", + "items": { + "$ref": "WorkerMessage" + } + }, + "location": { + "description": "The location which contains the job", + "type": "string" + } + }, + "id": "SendWorkerMessagesRequest" + }, + "SourceSplitShard": { + "description": "DEPRECATED in favor of DerivedSource.", + "type": "object", + "properties": { + "derivationMode": { + "enum": [ + "SOURCE_DERIVATION_MODE_UNKNOWN", + "SOURCE_DERIVATION_MODE_INDEPENDENT", + "SOURCE_DERIVATION_MODE_CHILD_OF_CURRENT", + "SOURCE_DERIVATION_MODE_SIBLING_OF_CURRENT" + ], + "description": "DEPRECATED", + "type": "string", + "enumDescriptions": [ + "The source derivation is unknown, or unspecified.", + "Produce a completely independent Source with no base.", + "Produce a Source based on the Source being split.", + "Produce a Source based on the base of the Source being split." + ] + }, + "source": { + "$ref": "Source", + "description": "DEPRECATED" + } + }, + "id": "SourceSplitShard" + }, + "CPUTime": { + "properties": { + "rate": { + "description": "Average CPU utilization rate (% non-idle cpu / second) since previous\nsample.", + "format": "double", + "type": "number" + }, + "timestamp": { + "description": "Timestamp of the measurement.", + "format": "google-datetime", + "type": "string" + }, + "totalMs": { + "description": "Total active CPU time across all cores (ie., non-idle) in milliseconds\nsince start-up.", + "format": "uint64", + "type": "string" + } + }, + "id": "CPUTime", + "description": "Modeled after information exposed by /proc/stat.", + "type": "object" + }, + "Environment": { + "properties": { + "userAgent": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "A description of the process that generated the request.", + "type": "object" + }, + "sdkPipelineOptions": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The Cloud Dataflow SDK pipeline options specified by the user. These\noptions are passed through the service and are used to recreate the\nSDK pipeline options on the worker in a language agnostic and platform\nindependent way.", + "type": "object" + }, + "clusterManagerApiService": { + "description": "The type of cluster manager API to use. If unknown or\nunspecified, the service will attempt to choose a reasonable\ndefault. This should be in the form of the API service name,\ne.g. \"compute.googleapis.com\".", + "type": "string" + }, + "tempStoragePrefix": { + "description": "The prefix of the resources the system should use for temporary\nstorage. The system will append the suffix \"/temp-{JOBNAME} to\nthis resource prefix, where {JOBNAME} is the value of the\njob_name field. The resulting bucket and object prefix is used\nas the prefix of the resources used to store temporary data\nneeded during the job execution. NOTE: This will override the\nvalue in taskrunner_settings.\nThe supported resource type is:\n\nGoogle Cloud Storage:\n\n storage.googleapis.com/{bucket}/{object}\n bucket.storage.googleapis.com/{object}", + "type": "string" + }, + "workerPools": { + "description": "The worker pools. At least one \"harness\" worker pool must be\nspecified in order for the job to have workers.", + "type": "array", + "items": { + "$ref": "WorkerPool" + } + }, + "dataset": { + "description": "The dataset for the current project where various workflow\nrelated tables are stored.\n\nThe supported resource type is:\n\nGoogle BigQuery:\n bigquery.googleapis.com/{dataset}", + "type": "string" + }, + "experiments": { + "description": "The list of experiments to enable.", + "type": "array", + "items": { + "type": "string" + } + }, + "version": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "A structure describing which components and their versions of the service\nare required in order to run the job.", + "type": "object" + }, + "internalExperiments": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Experimental settings.", + "type": "object" + }, + "serviceAccountEmail": { + "description": "Identity to run virtual machines as. Defaults to the default account.", + "type": "string" + } + }, + "id": "Environment", + "description": "Describes the environment in which a Dataflow Job runs.", + "type": "object" + }, + "StreamingComputationTask": { + "description": "A task which describes what action should be performed for the specified\nstreaming computation ranges.", + "type": "object", + "properties": { + "computationRanges": { + "description": "Contains ranges of a streaming computation this task should apply to.", + "type": "array", + "items": { + "$ref": "StreamingComputationRanges" + } + }, + "dataDisks": { + "description": "Describes the set of data disks this task should apply to.", + "type": "array", + "items": { + "$ref": "MountedDataDisk" + } + }, + "taskType": { + "enumDescriptions": [ + "The streaming computation task is unknown, or unspecified.", + "Stop processing specified streaming computation range(s).", + "Start processing specified streaming computation range(s)." + ], + "enum": [ + "STREAMING_COMPUTATION_TASK_UNKNOWN", + "STREAMING_COMPUTATION_TASK_STOP", + "STREAMING_COMPUTATION_TASK_START" + ], + "description": "A type of streaming computation task.", + "type": "string" + } + }, + "id": "StreamingComputationTask" } }, + "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", "version": "v1b3", "baseUrl": "https://dataflow.googleapis.com/", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/userinfo.email": { - "description": "View your email address" - }, "https://www.googleapis.com/auth/compute.readonly": { "description": "View your Google Compute Engine resources" }, "https://www.googleapis.com/auth/compute": { "description": "View and manage your Google Compute Engine resources" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/userinfo.email": { + "description": "View your email address" } } } @@ -5110,7 +5108,9 @@ "name": "dataflow", "batchPath": "batch", "revision": "20171222", - "id": "dataflow:v1b3", "documentationLink": "https://cloud.google.com/dataflow", - "title": "Google Dataflow API" + "id": "dataflow:v1b3", + "title": "Google Dataflow API", + "ownerName": "Google", + "discoveryVersion": "v1" }
diff --git a/dataproc/v1/dataproc-api.json b/dataproc/v1/dataproc-api.json index 8184a8d..debb20d 100644 --- a/dataproc/v1/dataproc-api.json +++ b/dataproc/v1/dataproc-api.json
@@ -6,262 +6,8 @@ "resources": { "regions": { "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "dataproc.projects.regions.operations.cancel" - }, - "delete": { - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}", - "path": "v1/{+name}", - "id": "dataproc.projects.regions.operations.delete", - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations", - "id": "dataproc.projects.regions.operations.list", - "path": "v1/{+name}", - "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "ListOperationsResponse" - }, - "parameters": { - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/operations$", - "location": "path" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "get": { - "path": "v1/{+name}", - "id": "dataproc.projects.regions.operations.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.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}" - } - } - }, "jobs": { "methods": { - "submit": { - "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", - "id": "dataproc.projects.regions.jobs.submit", - "request": { - "$ref": "SubmitJobRequest" - }, - "description": "Submits a job to a cluster.", - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId", - "region" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string", - "location": "path" - }, - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit" - }, - "delete": { - "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string" - }, - "jobId": { - "description": "Required. The job ID.", - "required": true, - "type": "string", - "location": "path" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "id": "dataproc.projects.regions.jobs.delete" - }, - "list": { - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs", - "path": "v1/projects/{projectId}/regions/{region}/jobs", - "id": "dataproc.projects.regions.jobs.list", - "description": "Lists regions/{region}/jobs in a project.", - "response": { - "$ref": "ListJobsResponse" - }, - "parameterOrder": [ - "projectId", - "region" - ], - "httpMethod": "GET", - "parameters": { - "filter": { - "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", - "type": "string", - "location": "query" - }, - "jobStateMatcher": { - "location": "query", - "enum": [ - "ALL", - "ACTIVE", - "NON_ACTIVE" - ], - "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.", - "type": "string" - }, - "pageToken": { - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The number of results to return in each response.", - "format": "int32", - "type": "integer" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterName": { - "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.", - "type": "string", - "location": "query" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "cancel": { "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.", "request": { @@ -280,12 +26,6 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, "projectId": { "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", "required": true, @@ -293,10 +33,16 @@ "location": "path" }, "jobId": { - "location": "path", "description": "Required. The job ID.", "required": true, - "type": "string" + "type": "string", + "location": "path" + }, + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" } }, "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", @@ -304,6 +50,13 @@ "id": "dataproc.projects.regions.jobs.cancel" }, "patch": { + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "id": "dataproc.projects.regions.jobs.patch", + "description": "Updates a job in a project.", + "request": { + "$ref": "Job" + }, "response": { "$ref": "Job" }, @@ -318,22 +71,22 @@ ], "parameters": { "region": { - "location": "path", "description": "Required. The Cloud Dataproc region in which to handle the request.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "updateMask": { - "location": "query", "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.", "format": "google-fieldmask", - "type": "string" + "type": "string", + "location": "query" }, "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", "required": true, - "type": "string" + "type": "string", + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to." }, "jobId": { "location": "path", @@ -341,13 +94,6 @@ "required": true, "type": "string" } - }, - "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", - "id": "dataproc.projects.regions.jobs.patch", - "description": "Updates a job in a project.", - "request": { - "$ref": "Job" } }, "get": { @@ -366,10 +112,10 @@ ], "parameters": { "projectId": { - "location": "path", "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "jobId": { "location": "path", @@ -387,144 +133,188 @@ "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", "id": "dataproc.projects.regions.jobs.get" + }, + "submit": { + "response": { + "$ref": "Job" + }, + "parameterOrder": [ + "projectId", + "region" + ], + "httpMethod": "POST", + "parameters": { + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "path": "v1/projects/{projectId}/regions/{region}/jobs:submit", + "id": "dataproc.projects.regions.jobs.submit", + "request": { + "$ref": "SubmitJobRequest" + }, + "description": "Submits a job to a cluster." + }, + "delete": { + "id": "dataproc.projects.regions.jobs.delete", + "path": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}", + "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", + "httpMethod": "DELETE", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "parameters": { + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "jobId": { + "location": "path", + "description": "Required. The job ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs/{jobId}" + }, + "list": { + "path": "v1/projects/{projectId}/regions/{region}/jobs", + "id": "dataproc.projects.regions.jobs.list", + "description": "Lists regions/{region}/jobs in a project.", + "response": { + "$ref": "ListJobsResponse" + }, + "parameterOrder": [ + "projectId", + "region" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "filter": { + "location": "query", + "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", + "type": "string" + }, + "jobStateMatcher": { + "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.", + "type": "string", + "location": "query", + "enum": [ + "ALL", + "ACTIVE", + "NON_ACTIVE" + ] + }, + "pageToken": { + "location": "query", + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The number of results to return in each response.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + }, + "clusterName": { + "location": "query", + "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}/regions/{region}/jobs" } } }, "clusters": { "methods": { - "get": { - "description": "Gets the resource representation for a cluster in a project.", - "response": { - "$ref": "Cluster" - }, + "diagnose": { + "httpMethod": "POST", "parameterOrder": [ "projectId", "region", "clusterName" ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" - }, - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, - "clusterName": { - "description": "Required. The cluster name.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "id": "dataproc.projects.regions.clusters.get" - }, - "patch": { "response": { "$ref": "Operation" }, - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "httpMethod": "PATCH", + "parameters": { + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "region": { + "required": true, + "type": "string", + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request." + }, + "clusterName": { + "required": true, + "type": "string", + "location": "path", + "description": "Required. The cluster name." + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "parameters": { - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "clusterName": { - "description": "Required. The cluster name.", - "required": true, - "type": "string", - "location": "path" - }, - "gracefulDecommissionTimeout": { - "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.", - "format": "google-duration", - "type": "string", - "location": "query" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "id": "dataproc.projects.regions.clusters.patch", - "description": "Updates a cluster in a project.", - "request": { - "$ref": "Cluster" - } - }, - "diagnose": { - "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.", + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", + "id": "dataproc.projects.regions.clusters.diagnose", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", "request": { "$ref": "DiagnoseClusterRequest" }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" - }, - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, - "clusterName": { - "location": "path", - "description": "Required. The cluster name.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", - "id": "dataproc.projects.regions.clusters.diagnose" + "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation." }, "delete": { + "description": "Deletes a cluster in a project.", "response": { "$ref": "Operation" }, @@ -539,40 +329,44 @@ ], "parameters": { "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterName": { "location": "path", - "description": "Required. The cluster name.", + "description": "Required. The Cloud Dataproc region in which to handle the request.", "required": true, "type": "string" }, + "clusterName": { + "required": true, + "type": "string", + "location": "path", + "description": "Required. The cluster name." + }, + "projectId": { + "required": true, + "type": "string", + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to." + } + }, + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "id": "dataproc.projects.regions.clusters.delete" + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "projectId", + "region" + ], + "response": { + "$ref": "ListClustersResponse" + }, + "parameters": { "projectId": { "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", "required": true, "type": "string", "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "id": "dataproc.projects.regions.clusters.delete", - "description": "Deletes a cluster in a project." - }, - "list": { - "description": "Lists all regions/{region}/clusters in a project.", - "httpMethod": "GET", - "response": { - "$ref": "ListClustersResponse" - }, - "parameterOrder": [ - "projectId", - "region" - ], - "parameters": { + }, "region": { "location": "path", "description": "Required. The Cloud Dataproc region in which to handle the request.", @@ -580,9 +374,9 @@ "type": "string" }, "filter": { + "type": "string", "location": "query", - "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", - "type": "string" + "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *" }, "pageToken": { "description": "Optional. The standard List page token.", @@ -594,12 +388,6 @@ "format": "int32", "type": "integer", "location": "query" - }, - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" } }, "scopes": [ @@ -607,13 +395,10 @@ ], "flatPath": "v1/projects/{projectId}/regions/{region}/clusters", "id": "dataproc.projects.regions.clusters.list", - "path": "v1/projects/{projectId}/regions/{region}/clusters" + "path": "v1/projects/{projectId}/regions/{region}/clusters", + "description": "Lists all regions/{region}/clusters in a project." }, "create": { - "description": "Creates a cluster in a project.", - "request": { - "$ref": "Cluster" - }, "response": { "$ref": "Operation" }, @@ -622,9 +407,6 @@ "region" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "projectId": { "location": "path", @@ -639,9 +421,227 @@ "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/projects/{projectId}/regions/{region}/clusters", "path": "v1/projects/{projectId}/regions/{region}/clusters", - "id": "dataproc.projects.regions.clusters.create" + "id": "dataproc.projects.regions.clusters.create", + "request": { + "$ref": "Cluster" + }, + "description": "Creates a cluster in a project." + }, + "get": { + "description": "Gets the resource representation for a cluster in a project.", + "httpMethod": "GET", + "response": { + "$ref": "Cluster" + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "parameters": { + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + }, + "clusterName": { + "description": "Required. The cluster name.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "id": "dataproc.projects.regions.clusters.get", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}" + }, + "patch": { + "description": "Updates a cluster in a project.", + "request": { + "$ref": "Cluster" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + }, + "updateMask": { + "description": "Required. Specifies the path, relative to Cluster, of the field to update. For example, to change the number of workers in a cluster to 5, the update_mask parameter would be specified as config.worker_config.num_instances, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the update_mask parameter would be config.secondary_worker_config.num_instances, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e Currently, only the following fields can be updated:\u003ctable\u003e \u003ctbody\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003eMask\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003e\u003cstrong\u003ePurpose\u003c/strong\u003e\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003elabels\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eUpdate labels\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize primary worker group\u003c/td\u003e \u003c/tr\u003e \u003ctr\u003e \u003ctd\u003e\u003cstrong\u003e\u003cem\u003econfig.secondary_worker_config.num_instances\u003c/em\u003e\u003c/strong\u003e\u003c/td\u003e \u003ctd\u003eResize secondary worker group\u003c/td\u003e \u003c/tr\u003e \u003c/tbody\u003e \u003c/table\u003e", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "clusterName": { + "description": "Required. The cluster name.", + "required": true, + "type": "string", + "location": "path" + }, + "gracefulDecommissionTimeout": { + "location": "query", + "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.", + "format": "google-duration", + "type": "string" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "path": "v1/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "id": "dataproc.projects.regions.clusters.patch" + } + } + }, + "operations": { + "methods": { + "cancel": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel", + "path": "v1/{+name}:cancel", + "id": "dataproc.projects.regions.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED." + }, + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}", + "id": "dataproc.projects.regions.operations.delete", + "path": "v1/{+name}", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED." + }, + "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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + }, + "name": { + "location": "path", + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations$" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations", + "path": "v1/{+name}", + "id": "dataproc.projects.regions.operations.list" + }, + "get": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}", + "path": "v1/{+name}", + "id": "dataproc.projects.regions.operations.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." } } } @@ -652,9 +652,9 @@ }, "parameters": { "uploadType": { - "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", @@ -662,9 +662,9 @@ "location": "query" }, "callback": { - "location": "query", "description": "JSONP", - "type": "string" + "type": "string", + "location": "query" }, "$.xgafv": { "enumDescriptions": [ @@ -680,6 +680,12 @@ "type": "string" }, "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -687,13 +693,7 @@ ], "location": "query", "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" + "default": "json" }, "key": { "location": "query", @@ -706,15 +706,15 @@ "location": "query" }, "quotaUser": { + "location": "query", "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.", - "type": "string", - "location": "query" + "type": "string" }, "pp": { - "location": "query", - "description": "Pretty-print response.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query", + "description": "Pretty-print response." }, "bearer_token": { "description": "OAuth bearer token.", @@ -722,14 +722,14 @@ "location": "query" }, "oauth_token": { + "location": "query", "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" + "type": "string" }, "upload_protocol": { + "type": "string", "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." }, "prettyPrint": { "location": "query", @@ -739,15 +739,453 @@ } }, "schemas": { + "ManagedGroupConfig": { + "type": "object", + "properties": { + "instanceGroupManagerName": { + "type": "string", + "description": "Output-only. The name of the Instance Group Manager for this group." + }, + "instanceTemplateName": { + "description": "Output-only. The name of the Instance Template used for the Managed Instance Group.", + "type": "string" + } + }, + "id": "ManagedGroupConfig", + "description": "Specifies the resources used to actively manage an instance group." + }, + "ClusterOperationStatus": { + "description": "The status of the operation.", + "type": "object", + "properties": { + "innerState": { + "type": "string", + "description": "Output-only. A message containing the detailed operation state." + }, + "stateStartTime": { + "description": "Output-only. The time this state was entered.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "enumDescriptions": [ + "Unused.", + "The operation has been created.", + "The operation is running.", + "The operation is done; either cancelled or completed." + ], + "enum": [ + "UNKNOWN", + "PENDING", + "RUNNING", + "DONE" + ], + "description": "Output-only. A message containing the operation state.", + "type": "string" + }, + "details": { + "description": "Output-only.A message containing any operation metadata details.", + "type": "string" + } + }, + "id": "ClusterOperationStatus" + }, + "HadoopJob": { + "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).", + "type": "object", + "properties": { + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", + "type": "object" + }, + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "type": "array", + "items": { + "type": "string" + } + }, + "fileUris": { + "description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", + "type": "array", + "items": { + "type": "string" + } + }, + "mainClass": { + "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.", + "type": "string" + }, + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", + "type": "array", + "items": { + "type": "string" + } + }, + "mainJarFileUri": { + "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", + "type": "string" + }, + "jarFileUris": { + "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", + "type": "array", + "items": { + "type": "string" + } + }, + "loggingConfig": { + "description": "Optional. The runtime log config for job execution.", + "$ref": "LoggingConfig" + } + }, + "id": "HadoopJob" + }, + "YarnApplication": { + "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", + "type": "object", + "properties": { + "state": { + "description": "Required. The application state.", + "type": "string", + "enumDescriptions": [ + "Status is unspecified.", + "Status is NEW.", + "Status is NEW_SAVING.", + "Status is SUBMITTED.", + "Status is ACCEPTED.", + "Status is RUNNING.", + "Status is FINISHED.", + "Status is FAILED.", + "Status is KILLED." + ], + "enum": [ + "STATE_UNSPECIFIED", + "NEW", + "NEW_SAVING", + "SUBMITTED", + "ACCEPTED", + "RUNNING", + "FINISHED", + "FAILED", + "KILLED" + ] + }, + "name": { + "description": "Required. The application name.", + "type": "string" + }, + "trackingUrl": { + "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.", + "type": "string" + }, + "progress": { + "description": "Required. The numerical progress of the application, from 1 to 100.", + "format": "float", + "type": "number" + } + }, + "id": "YarnApplication" + }, + "QueryList": { + "type": "object", + "properties": { + "queries": { + "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "QueryList", + "description": "A list of queries to run on a cluster." + }, + "DiagnoseClusterRequest": { + "description": "A request to collect cluster diagnostic information.", + "type": "object", + "properties": {}, + "id": "DiagnoseClusterRequest" + }, + "DiskConfig": { + "id": "DiskConfig", + "description": "Specifies the config of disk options for a group of VM instances.", + "type": "object", + "properties": { + "bootDiskSizeGb": { + "description": "Optional. Size in GB of the boot disk (default is 500GB).", + "format": "int32", + "type": "integer" + }, + "numLocalSsds": { + "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.", + "format": "int32", + "type": "integer" + } + } + }, + "ClusterOperationMetadata": { + "description": "Metadata describing the operation.", + "type": "object", + "properties": { + "warnings": { + "description": "Output-only. Errors encountered during operation execution.", + "type": "array", + "items": { + "type": "string" + } + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output-only. Labels associated with the operation", + "type": "object" + }, + "status": { + "$ref": "ClusterOperationStatus", + "description": "Output-only. Current operation status." + }, + "statusHistory": { + "description": "Output-only. The previous operation status.", + "type": "array", + "items": { + "$ref": "ClusterOperationStatus" + } + }, + "clusterUuid": { + "type": "string", + "description": "Output-only. Cluster UUID for the operation." + }, + "clusterName": { + "description": "Output-only. Name of the cluster for the operation.", + "type": "string" + }, + "operationType": { + "description": "Output-only. The operation type.", + "type": "string" + }, + "description": { + "description": "Output-only. Short description of operation.", + "type": "string" + } + }, + "id": "ClusterOperationMetadata" + }, + "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "HiveJob": { + "id": "HiveJob", + "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.", + "type": "object", + "properties": { + "continueOnFailure": { + "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", + "type": "boolean" + }, + "queryFileUri": { + "description": "The HCFS URI of the script that contains Hive queries.", + "type": "string" + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "scriptVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).", + "type": "object" + }, + "jarFileUris": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs." + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", + "type": "object" + } + } + }, + "DiagnoseClusterResults": { + "description": "The location of diagnostic output.", + "type": "object", + "properties": { + "outputUri": { + "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.", + "type": "string" + } + }, + "id": "DiagnoseClusterResults" + }, + "ClusterConfig": { + "type": "object", + "properties": { + "initializationActions": { + "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n", + "type": "array", + "items": { + "$ref": "NodeInitializationAction" + } + }, + "configBucket": { + "description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.", + "type": "string" + }, + "workerConfig": { + "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.", + "$ref": "InstanceGroupConfig" + }, + "gceClusterConfig": { + "$ref": "GceClusterConfig", + "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster." + }, + "softwareConfig": { + "$ref": "SoftwareConfig", + "description": "Optional. The config settings for software inside the cluster." + }, + "masterConfig": { + "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.", + "$ref": "InstanceGroupConfig" + }, + "secondaryWorkerConfig": { + "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.", + "$ref": "InstanceGroupConfig" + } + }, + "id": "ClusterConfig", + "description": "The cluster config." + }, + "PySparkJob": { + "id": "PySparkJob", + "description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.", + "type": "object", + "properties": { + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", + "type": "array", + "items": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code." + }, + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "type": "array", + "items": { + "type": "string" + } + }, + "fileUris": { + "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.", + "type": "array", + "items": { + "type": "string" + } + }, + "pythonFileUris": { + "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", + "type": "array", + "items": { + "type": "string" + } + }, + "mainPythonFileUri": { + "type": "string", + "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file." + }, + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "GceClusterConfig": { + "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", + "type": "object", + "properties": { + "metadata": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata))." + }, + "internalIpOnly": { + "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.", + "type": "boolean" + }, + "serviceAccountScopes": { + "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control", + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).", + "type": "array", + "items": { + "type": "string" + } + }, + "serviceAccount": { + "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com", + "type": "string" + }, + "subnetworkUri": { + "type": "string", + "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0" + }, + "networkUri": { + "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault", + "type": "string" + }, + "zoneUri": { + "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f", + "type": "string" + } + }, + "id": "GceClusterConfig" + }, "ClusterMetrics": { + "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", + "type": "object", "properties": { "yarnMetrics": { + "description": "The YARN metrics.", + "type": "object", "additionalProperties": { "format": "int64", "type": "string" - }, - "description": "The YARN metrics.", - "type": "object" + } }, "hdfsMetrics": { "additionalProperties": { @@ -758,32 +1196,29 @@ "type": "object" } }, - "id": "ClusterMetrics", - "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "type": "object" + "id": "ClusterMetrics" }, "AcceleratorConfig": { + "id": "AcceleratorConfig", "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).", "type": "object", "properties": { - "acceleratorTypeUri": { - "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80", - "type": "string" - }, "acceleratorCount": { "description": "The number of the accelerator cards of this type exposed to this instance.", "format": "int32", "type": "integer" + }, + "acceleratorTypeUri": { + "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80", + "type": "string" } - }, - "id": "AcceleratorConfig" + } }, "LoggingConfig": { - "description": "The runtime logging config of the job.", - "type": "object", "properties": { "driverLogLevels": { "additionalProperties": { + "type": "string", "enum": [ "LEVEL_UNSPECIFIED", "ALL", @@ -794,14 +1229,15 @@ "ERROR", "FATAL", "OFF" - ], - "type": "string" + ] }, "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'", "type": "object" } }, - "id": "LoggingConfig" + "id": "LoggingConfig", + "description": "The runtime logging config of the job.", + "type": "object" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a network API call.", @@ -812,20 +1248,20 @@ "type": "boolean" }, "response": { + "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", "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 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" + } }, "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 operations/some/unique/name.", - "type": "string" + "type": "string", + "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 operations/some/unique/name." }, "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { @@ -839,6 +1275,9 @@ "id": "Operation" }, "JobReference": { + "id": "JobReference", + "description": "Encapsulates the full scoping used to reference a job.", + "type": "object", "properties": { "projectId": { "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", @@ -848,10 +1287,7 @@ "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.", "type": "string" } - }, - "id": "JobReference", - "description": "Encapsulates the full scoping used to reference a job.", - "type": "object" + } }, "SubmitJobRequest": { "description": "A request to submit a job.", @@ -904,14 +1340,11 @@ "id": "JobScheduling" }, "InstanceGroupConfig": { + "type": "object", "properties": { "diskConfig": { - "$ref": "DiskConfig", - "description": "Optional. Disk option config settings." - }, - "machineTypeUri": { - "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2", - "type": "string" + "description": "Optional. Disk option config settings.", + "$ref": "DiskConfig" }, "managedGroupConfig": { "$ref": "ManagedGroupConfig", @@ -925,6 +1358,10 @@ "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.", "type": "string" }, + "machineTypeUri": { + "type": "string", + "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2" + }, "instanceNames": { "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).", "type": "array", @@ -946,17 +1383,16 @@ } }, "id": "InstanceGroupConfig", - "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.", - "type": "object" + "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group." }, "NodeInitializationAction": { "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", "type": "object", "properties": { "executionTimeout": { + "type": "string", "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.", - "format": "google-duration", - "type": "string" + "format": "google-duration" }, "executableFile": { "description": "Required. Google Cloud Storage URI of executable file.", @@ -966,22 +1402,22 @@ "id": "NodeInitializationAction" }, "ListJobsResponse": { + "id": "ListJobsResponse", "description": "A list of jobs in a project.", "type": "object", "properties": { "nextPageToken": { - "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.", - "type": "string" + "type": "string", + "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e." }, "jobs": { - "description": "Output-only. Jobs list.", "type": "array", "items": { "$ref": "Job" - } + }, + "description": "Output-only. Jobs list." } - }, - "id": "ListJobsResponse" + } }, "CancelJobRequest": { "description": "A request to cancel a job.", @@ -993,20 +1429,12 @@ "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.", "type": "object", "properties": { - "queryFileUri": { - "description": "The HCFS URI of the script that contains SQL queries.", - "type": "string" - }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." - }, "scriptVariables": { + "type": "object", "additionalProperties": { "type": "string" }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", - "type": "object" + "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";)." }, "jarFileUris": { "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", @@ -1016,8 +1444,8 @@ } }, "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." + "description": "Optional. The runtime log config for job execution.", + "$ref": "LoggingConfig" }, "properties": { "additionalProperties": { @@ -1025,6 +1453,14 @@ }, "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.", "type": "object" + }, + "queryFileUri": { + "description": "The HCFS URI of the script that contains SQL queries.", + "type": "string" + }, + "queryList": { + "description": "A list of queries.", + "$ref": "QueryList" } }, "id": "SparkSqlJob" @@ -1040,13 +1476,13 @@ "description": "Optional. The labels to associate with this cluster. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a cluster.", "type": "object" }, - "status": { - "description": "Output-only. Cluster status.", - "$ref": "ClusterStatus" - }, "metrics": { - "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "$ref": "ClusterMetrics" + "$ref": "ClusterMetrics", + "description": "Contains cluster daemon metrics such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release." + }, + "status": { + "$ref": "ClusterStatus", + "description": "Output-only. Cluster status." }, "statusHistory": { "description": "Output-only. The previous cluster status.", @@ -1056,17 +1492,17 @@ } }, "config": { - "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.", - "$ref": "ClusterConfig" + "$ref": "ClusterConfig", + "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated." + }, + "clusterName": { + "type": "string", + "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused." }, "clusterUuid": { "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.", "type": "string" }, - "clusterName": { - "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.", - "type": "string" - }, "projectId": { "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.", "type": "string" @@ -1078,37 +1514,37 @@ "description": "The response message for Operations.ListOperations.", "type": "object", "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.", "type": "array", "items": { "$ref": "Operation" } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } }, "id": "ListOperationsResponse" }, "SoftwareConfig": { + "id": "SoftwareConfig", + "description": "Specifies the selection and config of software inside the cluster.", + "type": "object", "properties": { "properties": { + "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.", + "type": "object", "additionalProperties": { "type": "string" - }, - "description": "Optional. The properties to set on daemon config files.Property keys are specified in prefix:property format, such as core:fs.defaultFS. The following are supported prefixes and their mappings:\ncapacity-scheduler: capacity-scheduler.xml\ncore: core-site.xml\ndistcp: distcp-default.xml\nhdfs: hdfs-site.xml\nhive: hive-site.xml\nmapred: mapred-site.xml\npig: pig.properties\nspark: spark-defaults.conf\nyarn: yarn-site.xmlFor more information, see Cluster properties.", - "type": "object" + } }, "imageVersion": { "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).", "type": "string" } - }, - "id": "SoftwareConfig", - "description": "Specifies the selection and config of software inside the cluster.", - "type": "object" + } }, "JobPlacement": { "description": "Cloud Dataproc job config.", @@ -1126,16 +1562,8 @@ "id": "JobPlacement" }, "PigJob": { - "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.", "type": "object", "properties": { - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", - "type": "object" - }, "continueOnFailure": { "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", "type": "boolean" @@ -1145,8 +1573,8 @@ "type": "string" }, "queryList": { - "description": "A list of queries.", - "$ref": "QueryList" + "$ref": "QueryList", + "description": "A list of queries." }, "jarFileUris": { "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", @@ -1163,11 +1591,19 @@ "type": "object" }, "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." + "description": "Optional. The runtime log config for job execution.", + "$ref": "LoggingConfig" + }, + "properties": { + "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", + "type": "object", + "additionalProperties": { + "type": "string" + } } }, - "id": "PigJob" + "id": "PigJob", + "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN." }, "ClusterStatus": { "description": "The status of a cluster and its instances.", @@ -1179,6 +1615,8 @@ "type": "string" }, "substate": { + "description": "Output-only. Additional state information that includes status reported by the agent.", + "type": "string", "enumDescriptions": [ "", "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.", @@ -1188,23 +1626,13 @@ "UNSPECIFIED", "UNHEALTHY", "STALE_STATUS" - ], - "description": "Output-only. Additional state information that includes status reported by the agent.", - "type": "string" + ] }, "detail": { "description": "Output-only. Optional details of cluster's state.", "type": "string" }, "state": { - "enumDescriptions": [ - "The cluster state is unknown.", - "The cluster is being created and set up. It is not ready for use.", - "The cluster is currently running and healthy. It is ready for use.", - "The cluster encountered an error. It is not ready for use.", - "The cluster is being deleted. It cannot be used.", - "The cluster is being updated. It continues to accept and process jobs." - ], "enum": [ "UNKNOWN", "CREATING", @@ -1214,14 +1642,20 @@ "UPDATING" ], "description": "Output-only. The cluster's state.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "The cluster state is unknown.", + "The cluster is being created and set up. It is not ready for use.", + "The cluster is currently running and healthy. It is ready for use.", + "The cluster encountered an error. It is not ready for use.", + "The cluster is being deleted. It cannot be used.", + "The cluster is being updated. It continues to accept and process jobs." + ] } }, "id": "ClusterStatus" }, "ListClustersResponse": { - "description": "The list of all clusters in a project.", - "type": "object", "properties": { "clusters": { "description": "Output-only. The clusters in the project.", @@ -1235,36 +1669,17 @@ "type": "string" } }, - "id": "ListClustersResponse" + "id": "ListClustersResponse", + "description": "The list of all clusters in a project.", + "type": "object" }, "SparkJob": { "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.", "type": "object", "properties": { - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", - "type": "object" - }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "type": "array", - "items": { - "type": "string" - } - }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks.", - "type": "array", - "items": { - "type": "string" - } - }, "mainClass": { - "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.", - "type": "string" + "type": "string", + "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris." }, "archiveUris": { "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", @@ -1287,45 +1702,40 @@ "loggingConfig": { "$ref": "LoggingConfig", "description": "Optional. The runtime log config for job execution." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Spark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code." + }, + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "type": "array", + "items": { + "type": "string" + } + }, + "fileUris": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. HCFS URIs of files to be copied to the working directory of Spark drivers and distributed tasks. Useful for naively parallel tasks." } }, "id": "SparkJob" }, "Job": { + "id": "Job", "description": "A Cloud Dataproc job resource.", "type": "object", "properties": { - "scheduling": { - "$ref": "JobScheduling", - "description": "Optional. Job scheduling configuration." - }, - "pigJob": { - "description": "Job is a Pig job.", - "$ref": "PigJob" - }, - "hiveJob": { - "description": "Job is a Hive job.", - "$ref": "HiveJob" - }, - "labels": { - "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, "driverOutputResourceUri": { "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.", "type": "string" }, - "sparkJob": { - "$ref": "SparkJob", - "description": "Job is a Spark job." - }, - "sparkSqlJob": { - "description": "Job is a SparkSql job.", - "$ref": "SparkSqlJob" - }, "statusHistory": { "description": "Output-only. The previous job status.", "type": "array", @@ -1333,41 +1743,68 @@ "$ref": "JobStatus" } }, + "sparkSqlJob": { + "$ref": "SparkSqlJob", + "description": "Job is a SparkSql job." + }, + "sparkJob": { + "description": "Job is a Spark job.", + "$ref": "SparkJob" + }, "yarnApplications": { - "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", "type": "array", "items": { "$ref": "YarnApplication" - } + }, + "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release." }, "pysparkJob": { "$ref": "PySparkJob", "description": "Job is a Pyspark job." }, "reference": { - "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.", - "$ref": "JobReference" + "$ref": "JobReference", + "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e." }, "hadoopJob": { "$ref": "HadoopJob", "description": "Job is a Hadoop job." }, "status": { - "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields.", - "$ref": "JobStatus" + "$ref": "JobStatus", + "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields." }, "placement": { "$ref": "JobPlacement", "description": "Required. Job information, including how, when, and where to run the job." }, "driverControlFilesUri": { - "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.", - "type": "string" + "type": "string", + "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri." + }, + "scheduling": { + "$ref": "JobScheduling", + "description": "Optional. Job scheduling configuration." + }, + "pigJob": { + "$ref": "PigJob", + "description": "Job is a Pig job." + }, + "hiveJob": { + "$ref": "HiveJob", + "description": "Job is a Hive job." + }, + "labels": { + "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", + "type": "object", + "additionalProperties": { + "type": "string" + } } - }, - "id": "Job" + } }, "JobStatus": { + "id": "JobStatus", "description": "Cloud Dataproc job status.", "type": "object", "properties": { @@ -1393,18 +1830,6 @@ ] }, "state": { - "enumDescriptions": [ - "The job state is unknown.", - "The job is pending; it has been submitted, but is not yet running.", - "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.", - "The job is running on the cluster.", - "A CancelJob request has been received, but is pending.", - "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.", - "The job cancellation was successful.", - "The job has completed successfully.", - "The job has completed, but encountered an error.", - "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only." - ], "enum": [ "STATE_UNSPECIFIED", "PENDING", @@ -1418,457 +1843,32 @@ "ATTEMPT_FAILURE" ], "description": "Output-only. A state message specifying the overall job state.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "The job state is unknown.", + "The job is pending; it has been submitted, but is not yet running.", + "Job has been received by the service and completed initial setup; it will soon be submitted to the cluster.", + "The job is running on the cluster.", + "A CancelJob request has been received, but is pending.", + "Transient in-flight resources have been canceled, and the request to cancel the running job has been issued to the cluster.", + "The job cancellation was successful.", + "The job has completed successfully.", + "The job has completed, but encountered an error.", + "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only." + ] }, "details": { "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.", "type": "string" } - }, - "id": "JobStatus" - }, - "ManagedGroupConfig": { - "description": "Specifies the resources used to actively manage an instance group.", - "type": "object", - "properties": { - "instanceGroupManagerName": { - "description": "Output-only. The name of the Instance Group Manager for this group.", - "type": "string" - }, - "instanceTemplateName": { - "description": "Output-only. The name of the Instance Template used for the Managed Instance Group.", - "type": "string" - } - }, - "id": "ManagedGroupConfig" - }, - "ClusterOperationStatus": { - "description": "The status of the operation.", - "type": "object", - "properties": { - "state": { - "enumDescriptions": [ - "Unused.", - "The operation has been created.", - "The operation is running.", - "The operation is done; either cancelled or completed." - ], - "enum": [ - "UNKNOWN", - "PENDING", - "RUNNING", - "DONE" - ], - "description": "Output-only. A message containing the operation state.", - "type": "string" - }, - "details": { - "description": "Output-only.A message containing any operation metadata details.", - "type": "string" - }, - "innerState": { - "description": "Output-only. A message containing the detailed operation state.", - "type": "string" - }, - "stateStartTime": { - "description": "Output-only. The time this state was entered.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "ClusterOperationStatus" - }, - "HadoopJob": { - "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).", - "type": "object", - "properties": { - "mainJarFileUri": { - "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", - "type": "string" - }, - "jarFileUris": { - "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", - "type": "array", - "items": { - "type": "string" - } - }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." - }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", - "type": "object" - }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "type": "array", - "items": { - "type": "string" - } - }, - "fileUris": { - "description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", - "type": "array", - "items": { - "type": "string" - } - }, - "mainClass": { - "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.", - "type": "string" - }, - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "HadoopJob" - }, - "YarnApplication": { - "properties": { - "state": { - "enum": [ - "STATE_UNSPECIFIED", - "NEW", - "NEW_SAVING", - "SUBMITTED", - "ACCEPTED", - "RUNNING", - "FINISHED", - "FAILED", - "KILLED" - ], - "description": "Required. The application state.", - "type": "string", - "enumDescriptions": [ - "Status is unspecified.", - "Status is NEW.", - "Status is NEW_SAVING.", - "Status is SUBMITTED.", - "Status is ACCEPTED.", - "Status is RUNNING.", - "Status is FINISHED.", - "Status is FAILED.", - "Status is KILLED." - ] - }, - "name": { - "description": "Required. The application name.", - "type": "string" - }, - "trackingUrl": { - "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.", - "type": "string" - }, - "progress": { - "description": "Required. The numerical progress of the application, from 1 to 100.", - "format": "float", - "type": "number" - } - }, - "id": "YarnApplication", - "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "type": "object" - }, - "QueryList": { - "description": "A list of queries to run on a cluster.", - "type": "object", - "properties": { - "queries": { - "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "QueryList" - }, - "DiagnoseClusterRequest": { - "properties": {}, - "id": "DiagnoseClusterRequest", - "description": "A request to collect cluster diagnostic information.", - "type": "object" - }, - "DiskConfig": { - "properties": { - "numLocalSsds": { - "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.", - "format": "int32", - "type": "integer" - }, - "bootDiskSizeGb": { - "description": "Optional. Size in GB of the boot disk (default is 500GB).", - "format": "int32", - "type": "integer" - } - }, - "id": "DiskConfig", - "description": "Specifies the config of disk options for a group of VM instances.", - "type": "object" - }, - "ClusterOperationMetadata": { - "description": "Metadata describing the operation.", - "type": "object", - "properties": { - "description": { - "description": "Output-only. Short description of operation.", - "type": "string" - }, - "warnings": { - "description": "Output-only. Errors encountered during operation execution.", - "type": "array", - "items": { - "type": "string" - } - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Output-only. Labels associated with the operation", - "type": "object" - }, - "status": { - "description": "Output-only. Current operation status.", - "$ref": "ClusterOperationStatus" - }, - "statusHistory": { - "description": "Output-only. The previous operation status.", - "type": "array", - "items": { - "$ref": "ClusterOperationStatus" - } - }, - "clusterUuid": { - "description": "Output-only. Cluster UUID for the operation.", - "type": "string" - }, - "clusterName": { - "description": "Output-only. Name of the cluster for the operation.", - "type": "string" - }, - "operationType": { - "description": "Output-only. The operation type.", - "type": "string" - } - }, - "id": "ClusterOperationMetadata" - }, - "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "HiveJob": { - "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.", - "type": "object", - "properties": { - "continueOnFailure": { - "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", - "type": "boolean" - }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains Hive queries.", - "type": "string" - }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." - }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.", - "type": "array", - "items": { - "type": "string" - } - }, - "scriptVariables": { - "description": "Optional. Mapping of query variable names to values (equivalent to the Hive command: SET name=\"value\";).", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "properties": { - "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "id": "HiveJob" - }, - "DiagnoseClusterResults": { - "properties": { - "outputUri": { - "description": "Output-only. The Google Cloud Storage URI of the diagnostic output. The output report is a plain text file with a summary of collected diagnostics.", - "type": "string" - } - }, - "id": "DiagnoseClusterResults", - "description": "The location of diagnostic output.", - "type": "object" - }, - "ClusterConfig": { - "description": "The cluster config.", - "type": "object", - "properties": { - "masterConfig": { - "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.", - "$ref": "InstanceGroupConfig" - }, - "secondaryWorkerConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster." - }, - "initializationActions": { - "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's role metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n", - "type": "array", - "items": { - "$ref": "NodeInitializationAction" - } - }, - "configBucket": { - "description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.", - "type": "string" - }, - "workerConfig": { - "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.", - "$ref": "InstanceGroupConfig" - }, - "gceClusterConfig": { - "$ref": "GceClusterConfig", - "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster." - }, - "softwareConfig": { - "$ref": "SoftwareConfig", - "description": "Optional. The config settings for software inside the cluster." - } - }, - "id": "ClusterConfig" - }, - "PySparkJob": { - "description": "A Cloud Dataproc job for running Apache PySpark (https://spark.apache.org/docs/0.9.0/python-programming-guide.html) applications on YARN.", - "type": "object", - "properties": { - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATHs of the Python driver and tasks.", - "type": "array", - "items": { - "type": "string" - } - }, - "loggingConfig": { - "description": "Optional. The runtime log config for job execution.", - "$ref": "LoggingConfig" - }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure PySpark. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/spark/conf/spark-defaults.conf and classes in user code.", - "type": "object" - }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as --conf, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "type": "array", - "items": { - "type": "string" - } - }, - "fileUris": { - "description": "Optional. HCFS URIs of files to be copied to the working directory of Python drivers and distributed tasks. Useful for naively parallel tasks.", - "type": "array", - "items": { - "type": "string" - } - }, - "pythonFileUris": { - "description": "Optional. HCFS file URIs of Python files to pass to the PySpark framework. Supported file types: .py, .egg, and .zip.", - "type": "array", - "items": { - "type": "string" - } - }, - "mainPythonFileUri": { - "description": "Required. The HCFS URI of the main Python file to use as the driver. Must be a .py file.", - "type": "string" - }, - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted in the working directory of .jar, .tar, .tar.gz, .tgz, and .zip.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "PySparkJob" - }, - "GceClusterConfig": { - "properties": { - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).", - "type": "object" - }, - "internalIpOnly": { - "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.", - "type": "boolean" - }, - "serviceAccountScopes": { - "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control", - "type": "array", - "items": { - "type": "string" - } - }, - "tags": { - "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).", - "type": "array", - "items": { - "type": "string" - } - }, - "serviceAccount": { - "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com", - "type": "string" - }, - "subnetworkUri": { - "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0", - "type": "string" - }, - "networkUri": { - "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault", - "type": "string" - }, - "zoneUri": { - "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f", - "type": "string" - } - }, - "id": "GceClusterConfig", - "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", - "type": "object" + } } }, + "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", "version": "v1", "baseUrl": "https://dataproc.googleapis.com/", "auth": { @@ -1880,9 +1880,9 @@ } } }, - "servicePath": "", - "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", "kind": "discovery#restDescription", + "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", + "servicePath": "", "rootUrl": "https://dataproc.googleapis.com/", "basePath": "", "ownerDomain": "google.com",
diff --git a/dataproc/v1beta2/dataproc-api.json b/dataproc/v1beta2/dataproc-api.json index 06c4fe1..1f5a1fa 100644 --- a/dataproc/v1beta2/dataproc-api.json +++ b/dataproc/v1beta2/dataproc-api.json
@@ -1,1805 +1,7 @@ { - "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Dataproc API", - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "locations": { - "resources": { - "workflowTemplates": { - "methods": { - "instantiate": { - "request": { - "$ref": "InstantiateWorkflowTemplateRequest" - }, - "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate", - "path": "v1beta2/{+name}:instantiate", - "id": "dataproc.projects.locations.workflowTemplates.instantiate" - }, - "get": { - "response": { - "$ref": "WorkflowTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "version": { - "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "name": { - "location": "path", - "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.locations.workflowTemplates.get", - "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter." - }, - "update": { - "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", - "request": { - "$ref": "WorkflowTemplate" - }, - "response": { - "$ref": "WorkflowTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", - "location": "path", - "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.locations.workflowTemplates.update" - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$" - }, - "version": { - "location": "query", - "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.locations.workflowTemplates.delete", - "description": "Deletes a workflow template. It does not cancel in-progress workflows." - }, - "list": { - "description": "Lists workflows that match the specified filter in the request.", - "response": { - "$ref": "ListWorkflowTemplatesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return in each response.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "type": "string" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates", - "path": "v1beta2/{+parent}/workflowTemplates", - "id": "dataproc.projects.locations.workflowTemplates.list" - }, - "create": { - "response": { - "$ref": "WorkflowTemplate" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "location": "path", - "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates", - "path": "v1beta2/{+parent}/workflowTemplates", - "id": "dataproc.projects.locations.workflowTemplates.create", - "description": "Creates new workflow template.", - "request": { - "$ref": "WorkflowTemplate" - } - } - } - } - } - }, - "regions": { - "resources": { - "clusters": { - "methods": { - "diagnose": { - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", - "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", - "id": "dataproc.projects.regions.clusters.diagnose", - "request": { - "$ref": "DiagnoseClusterRequest" - }, - "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "httpMethod": "POST", - "parameters": { - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, - "clusterName": { - "description": "Required. The cluster name.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "delete": { - "description": "Deletes a cluster in a project.", - "httpMethod": "DELETE", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterName": { - "location": "path", - "description": "Required. The cluster name.", - "required": true, - "type": "string" - }, - "clusterUuid": { - "location": "query", - "description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.", - "type": "string" - }, - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "id": "dataproc.projects.regions.clusters.delete", - "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}" - }, - "list": { - "response": { - "$ref": "ListClustersResponse" - }, - "parameterOrder": [ - "projectId", - "region" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "description": "Optional. The standard List page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" - }, - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, - "filter": { - "location": "query", - "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", - "type": "string" - }, - "pageToken": { - "description": "Optional. The standard List page token.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters", - "path": "v1beta2/projects/{projectId}/regions/{region}/clusters", - "id": "dataproc.projects.regions.clusters.list", - "description": "Lists all regions/{region}/clusters in a project." - }, - "create": { - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters", - "path": "v1beta2/projects/{projectId}/regions/{region}/clusters", - "id": "dataproc.projects.regions.clusters.create", - "request": { - "$ref": "Cluster" - }, - "description": "Creates a cluster in a project.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "projectId", - "region" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" - }, - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "setIamPolicy": { - "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy", - "path": "v1beta2/{+resource}:setIamPolicy", - "id": "dataproc.projects.regions.clusters.setIamPolicy" - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.", - "httpMethod": "GET", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy", - "id": "dataproc.projects.regions.clusters.getIamPolicy", - "path": "v1beta2/{+resource}:getIamPolicy" - }, - "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - }, - "updateMask": { - "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "clusterName": { - "location": "path", - "description": "Required. The cluster name.", - "required": true, - "type": "string" - }, - "gracefulDecommissionTimeout": { - "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.", - "format": "google-duration", - "type": "string", - "location": "query" - }, - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "id": "dataproc.projects.regions.clusters.patch", - "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "request": { - "$ref": "Cluster" - }, - "description": "Updates a cluster in a project." - }, - "get": { - "description": "Gets the resource representation for a cluster in a project.", - "response": { - "$ref": "Cluster" - }, - "parameterOrder": [ - "projectId", - "region", - "clusterName" - ], - "httpMethod": "GET", - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - }, - "clusterName": { - "location": "path", - "description": "Required. The cluster name.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", - "id": "dataproc.projects.regions.clusters.get" - }, - "testIamPermissions": { - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions", - "path": "v1beta2/{+resource}:testIamPermissions", - "id": "dataproc.projects.regions.clusters.testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning." - } - } - }, - "workflowTemplates": { - "methods": { - "create": { - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates", - "path": "v1beta2/{+parent}/workflowTemplates", - "id": "dataproc.projects.regions.workflowTemplates.create", - "description": "Creates new workflow template.", - "request": { - "$ref": "WorkflowTemplate" - }, - "response": { - "$ref": "WorkflowTemplate" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "location": "path", - "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+$" - } - } - }, - "instantiate": { - "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.", - "request": { - "$ref": "InstantiateWorkflowTemplateRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate", - "path": "v1beta2/{+name}:instantiate", - "id": "dataproc.projects.regions.workflowTemplates.instantiate" - }, - "get": { - "response": { - "$ref": "WorkflowTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", - "location": "path" - }, - "version": { - "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.regions.workflowTemplates.get", - "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter." - }, - "update": { - "httpMethod": "PUT", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "WorkflowTemplate" - }, - "parameters": { - "name": { - "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", - "id": "dataproc.projects.regions.workflowTemplates.update", - "path": "v1beta2/{+name}", - "request": { - "$ref": "WorkflowTemplate" - }, - "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version." - }, - "delete": { - "description": "Deletes a workflow template. It does not cancel in-progress workflows.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "version": { - "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "name": { - "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", - "location": "path", - "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.regions.workflowTemplates.delete" - }, - "list": { - "description": "Lists workflows that match the specified filter in the request.", - "response": { - "$ref": "ListWorkflowTemplatesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return in each response.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+/regions/[^/]+$", - "location": "path", - "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates", - "path": "v1beta2/{+parent}/workflowTemplates", - "id": "dataproc.projects.regions.workflowTemplates.list" - } - } - }, - "operations": { - "methods": { - "list": { - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/regions/[^/]+/operations$", - "location": "path", - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.regions.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id." - }, - "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}", - "id": "dataproc.projects.regions.operations.get", - "path": "v1beta2/{+name}", - "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." - }, - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel", - "path": "v1beta2/{+name}:cancel", - "id": "dataproc.projects.regions.operations.cancel" - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", - "location": "path", - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}", - "path": "v1beta2/{+name}", - "id": "dataproc.projects.regions.operations.delete" - } - } - }, - "jobs": { - "methods": { - "cancel": { - "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.", - "request": { - "$ref": "CancelJobRequest" - }, - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string", - "location": "path" - }, - "jobId": { - "location": "path", - "description": "Required. The job ID.", - "required": true, - "type": "string" - }, - "region": { - "location": "path", - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", - "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", - "id": "dataproc.projects.regions.jobs.cancel" - }, - "patch": { - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "httpMethod": "PATCH", - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string" - }, - "jobId": { - "description": "Required. The job ID.", - "required": true, - "type": "string", - "location": "path" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - }, - "updateMask": { - "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", - "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", - "id": "dataproc.projects.regions.jobs.patch", - "request": { - "$ref": "Job" - }, - "description": "Updates a job in a project." - }, - "get": { - "description": "Gets the resource representation for a job in a project.", - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string", - "location": "path" - }, - "jobId": { - "description": "Required. The job ID.", - "required": true, - "type": "string", - "location": "path" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", - "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", - "id": "dataproc.projects.regions.jobs.get" - }, - "submit": { - "request": { - "$ref": "SubmitJobRequest" - }, - "description": "Submits a job to a cluster.", - "response": { - "$ref": "Job" - }, - "parameterOrder": [ - "projectId", - "region" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit", - "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit", - "id": "dataproc.projects.regions.jobs.submit" - }, - "delete": { - "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "projectId", - "region", - "jobId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - }, - "projectId": { - "location": "path", - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string" - }, - "jobId": { - "description": "Required. The job ID.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", - "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", - "id": "dataproc.projects.regions.jobs.delete" - }, - "list": { - "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs", - "id": "dataproc.projects.regions.jobs.list", - "path": "v1beta2/projects/{projectId}/regions/{region}/jobs", - "description": "Lists regions/{region}/jobs in a project.", - "httpMethod": "GET", - "parameterOrder": [ - "projectId", - "region" - ], - "response": { - "$ref": "ListJobsResponse" - }, - "parameters": { - "clusterName": { - "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.", - "type": "string", - "location": "query" - }, - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "required": true, - "type": "string", - "location": "path" - }, - "filter": { - "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", - "type": "string", - "location": "query" - }, - "jobStateMatcher": { - "enum": [ - "ALL", - "ACTIVE", - "NON_ACTIVE" - ], - "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.", - "type": "string", - "location": "query" - }, - "pageToken": { - "location": "query", - "description": "Optional. The page token, returned by a previous call, to request the next page of results.", - "type": "string" - }, - "pageSize": { - "description": "Optional. The number of results to return in each response.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "region": { - "description": "Required. The Cloud Dataproc region in which to handle the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - } - } - } - }, - "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - } - }, - "version": "v1beta2", - "baseUrl": "https://dataproc.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", - "servicePath": "", - "basePath": "", - "revision": "20171212", - "documentationLink": "https://cloud.google.com/dataproc/", - "id": "dataproc:v1beta2", - "discoveryVersion": "v1", "version_module": true, "schemas": { - "GceClusterConfig": { - "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", - "type": "object", - "properties": { - "subnetworkUri": { - "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0", - "type": "string" - }, - "networkUri": { - "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault", - "type": "string" - }, - "zoneUri": { - "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "type": "string" - }, - "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).", - "type": "object" - }, - "internalIpOnly": { - "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.", - "type": "boolean" - }, - "serviceAccountScopes": { - "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control", - "type": "array", - "items": { - "type": "string" - } - }, - "tags": { - "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).", - "type": "array", - "items": { - "type": "string" - } - }, - "serviceAccount": { - "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com", - "type": "string" - } - }, - "id": "GceClusterConfig" - }, - "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.Example\n{\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n}\nFor a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam).", - "type": "object", - "properties": { - "bindings": { - "description": "Associates a list of members to a role. bindings with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - }, - "etag": { - "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Version of the Policy. The default version is 0.", - "format": "int32", - "type": "integer" - } - }, - "id": "Policy" - }, - "Operation": { - "properties": { - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "done": { - "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", - "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 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" - }, - "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 operations/some/unique/name.", - "type": "string" - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a network API call.", - "type": "object" - }, - "ListWorkflowTemplatesResponse": { - "description": "A response to a request to list workflow templates in a project.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListWorkflowTemplatesRequest\u003c/code\u003e.", - "type": "string" - }, - "templates": { - "description": "Output only. WorkflowTemplates list.", - "type": "array", - "items": { - "$ref": "WorkflowTemplate" - } - } - }, - "id": "ListWorkflowTemplatesResponse" - }, - "JobReference": { - "properties": { - "projectId": { - "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", - "type": "string" - }, - "jobId": { - "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.", - "type": "string" - } - }, - "id": "JobReference", - "description": "Encapsulates the full scoping used to reference a job.", - "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", - "type": "object", - "properties": { - "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 field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - } - }, - "id": "Status" - }, - "Binding": { - "description": "Associates members with a role.", - "type": "object", - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required", - "type": "string" - } - }, - "id": "Binding" - }, - "InstanceGroupConfig": { - "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.", - "type": "object", - "properties": { - "machineTypeUri": { - "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2", - "type": "string" - }, - "imageUri": { - "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.", - "type": "string" - }, - "isPreemptible": { - "description": "Optional. Specifies that this instance group contains preemptible instances.", - "type": "boolean" - }, - "managedGroupConfig": { - "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.", - "$ref": "ManagedGroupConfig" - }, - "instanceNames": { - "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).", - "type": "array", - "items": { - "type": "string" - } - }, - "accelerators": { - "description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.", - "type": "array", - "items": { - "$ref": "AcceleratorConfig" - } - }, - "numInstances": { - "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.", - "format": "int32", - "type": "integer" - }, - "minCpuPlatform": { - "description": "Optional. Specifies the minimum cpu platform for the Instance Group. Examples: * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform", - "type": "string" - }, - "diskConfig": { - "$ref": "DiskConfig", - "description": "Optional. Disk option config settings." - } - }, - "id": "InstanceGroupConfig" - }, - "NodeInitializationAction": { - "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", - "type": "object", - "properties": { - "executionTimeout": { - "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.", - "format": "google-duration", - "type": "string" - }, - "executableFile": { - "description": "Required. Google Cloud Storage URI of executable file.", - "type": "string" - } - }, - "id": "NodeInitializationAction" - }, - "ListJobsResponse": { - "description": "A list of jobs in a project.", - "type": "object", - "properties": { - "jobs": { - "description": "Output-only. Jobs list.", - "type": "array", - "items": { - "$ref": "Job" - } - }, - "nextPageToken": { - "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.", - "type": "string" - } - }, - "id": "ListJobsResponse" - }, - "CancelJobRequest": { - "properties": {}, - "id": "CancelJobRequest", - "description": "A request to cancel a job.", - "type": "object" - }, - "SparkSqlJob": { - "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.", - "type": "object", - "properties": { - "properties": { - "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." - }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains SQL queries.", - "type": "string" - }, - "scriptVariables": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", - "type": "object" - }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", - "type": "array", - "items": { - "type": "string" - } - }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." - } - }, - "id": "SparkSqlJob" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "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.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "id": "ListOperationsResponse" - }, - "JobPlacement": { - "description": "Cloud Dataproc job config.", - "type": "object", - "properties": { - "clusterName": { - "description": "Required. The name of the cluster where the job will be submitted.", - "type": "string" - }, - "clusterUuid": { - "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.", - "type": "string" - } - }, - "id": "JobPlacement" - }, - "PigJob": { - "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.", - "type": "object", - "properties": { - "continueOnFailure": { - "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", - "type": "boolean" - }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains the Pig queries.", - "type": "string" - }, - "queryList": { - "description": "A list of queries.", - "$ref": "QueryList" - }, - "scriptVariables": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).", - "type": "object" - }, - "jarFileUris": { - "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", - "type": "array", - "items": { - "type": "string" - } - }, - "loggingConfig": { - "description": "Optional. The runtime log config for job execution.", - "$ref": "LoggingConfig" - }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", - "type": "object" - } - }, - "id": "PigJob" - }, - "ClusterStatus": { - "properties": { - "stateStartTime": { - "description": "Output-only. Time when this state was entered.", - "format": "google-datetime", - "type": "string" - }, - "substate": { - "enumDescriptions": [ - "", - "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.", - "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state." - ], - "enum": [ - "UNSPECIFIED", - "UNHEALTHY", - "STALE_STATUS" - ], - "description": "Output-only. Additional state information that includes status reported by the agent.", - "type": "string" - }, - "detail": { - "description": "Output-only. Optional details of cluster's state.", - "type": "string" - }, - "state": { - "description": "Output-only. The cluster's state.", - "type": "string", - "enumDescriptions": [ - "The cluster state is unknown.", - "The cluster is being created and set up. It is not ready for use.", - "The cluster is currently running and healthy. It is ready for use.", - "The cluster encountered an error. It is not ready for use.", - "The cluster is being deleted. It cannot be used.", - "The cluster is being updated. It continues to accept and process jobs." - ], - "enum": [ - "UNKNOWN", - "CREATING", - "RUNNING", - "ERROR", - "DELETING", - "UPDATING" - ] - } - }, - "id": "ClusterStatus", - "description": "The status of a cluster and its instances.", - "type": "object" - }, - "WorkflowTemplate": { - "description": "A Cloud Dataproc workflow template resource.", - "type": "object", - "properties": { - "jobs": { - "description": "Required. The Directed Acyclic Graph of Jobs to submit.", - "type": "array", - "items": { - "$ref": "OrderedJob" - } - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.", - "type": "object" - }, - "createTime": { - "description": "Output only. The time template was created.", - "format": "google-datetime", - "type": "string" - }, - "placement": { - "$ref": "WorkflowTemplatePlacement", - "description": "Required. WorkflowTemplate scheduling information." - }, - "updateTime": { - "description": "Output only. The time template was last updated.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", - "type": "string" - }, - "version": { - "description": "Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.", - "format": "int32", - "type": "integer" - }, - "id": { - "description": "Required. The template id.", - "type": "string" - } - }, - "id": "WorkflowTemplate" - }, - "ListClustersResponse": { - "properties": { - "clusters": { - "description": "Output-only. The clusters in the project.", - "type": "array", - "items": { - "$ref": "Cluster" - } - }, - "nextPageToken": { - "description": "Output-only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListClustersRequest\u003c/code\u003e.", - "type": "string" - } - }, - "id": "ListClustersResponse", - "description": "The list of all clusters in a project.", - "type": "object" - }, - "Job": { - "description": "A Cloud Dataproc job resource.", - "type": "object", - "properties": { - "reference": { - "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e.", - "$ref": "JobReference" - }, - "hadoopJob": { - "$ref": "HadoopJob", - "description": "Job is a Hadoop job." - }, - "status": { - "$ref": "JobStatus", - "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields." - }, - "placement": { - "$ref": "JobPlacement", - "description": "Required. Job information, including how, when, and where to run the job." - }, - "driverControlFilesUri": { - "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.", - "type": "string" - }, - "scheduling": { - "description": "Optional. Job scheduling configuration.", - "$ref": "JobScheduling" - }, - "pigJob": { - "$ref": "PigJob", - "description": "Job is a Pig job." - }, - "hiveJob": { - "description": "Job is a Hive job.", - "$ref": "HiveJob" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", - "type": "object" - }, - "driverOutputResourceUri": { - "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.", - "type": "string" - }, - "sparkJob": { - "$ref": "SparkJob", - "description": "Job is a Spark job." - }, - "sparkSqlJob": { - "$ref": "SparkSqlJob", - "description": "Job is a SparkSql job." - }, - "statusHistory": { - "description": "Output-only. The previous job status.", - "type": "array", - "items": { - "$ref": "JobStatus" - } - }, - "yarnApplications": { - "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "type": "array", - "items": { - "$ref": "YarnApplication" - } - }, - "pysparkJob": { - "description": "Job is a Pyspark job.", - "$ref": "PySparkJob" - } - }, - "id": "Job" - }, "ManagedGroupConfig": { - "description": "Specifies the resources used to actively manage an instance group.", - "type": "object", "properties": { "instanceGroupManagerName": { "description": "Output-only. The name of the Instance Group Manager for this group.", @@ -1810,17 +12,14 @@ "type": "string" } }, - "id": "ManagedGroupConfig" + "id": "ManagedGroupConfig", + "description": "Specifies the resources used to actively manage an instance group.", + "type": "object" }, "LifecycleConfig": { "description": "Specifies the cluster auto delete related schedule configuration.", "type": "object", "properties": { - "autoDeleteTime": { - "description": "Optional. The time when cluster will be auto-deleted.", - "format": "google-datetime", - "type": "string" - }, "idleDeleteTtl": { "description": "Optional. The longest duration that cluster would keep alive while staying idle; passing this threshold will cause cluster to be auto-deleted.", "format": "google-duration", @@ -1830,6 +29,11 @@ "description": "Optional. The life duration of cluster, the cluster will be auto-deleted at the end of this duration.", "format": "google-duration", "type": "string" + }, + "autoDeleteTime": { + "description": "Optional. The time when cluster will be auto-deleted.", + "format": "google-datetime", + "type": "string" } }, "id": "LifecycleConfig" @@ -1846,8 +50,8 @@ "type": "object" }, "config": { - "$ref": "ClusterConfig", - "description": "Required. The cluster configuration." + "description": "Required. The cluster configuration.", + "$ref": "ClusterConfig" }, "clusterName": { "description": "Required. The cluster name. Cluster names within a project must be unique. Names from deleted clusters can be reused.", @@ -1861,12 +65,6 @@ "type": "object", "properties": { "state": { - "enumDescriptions": [ - "Unused.", - "The operation has been created.", - "The operation is running.", - "The operation is done; either cancelled or completed." - ], "enum": [ "UNKNOWN", "PENDING", @@ -1874,7 +72,13 @@ "DONE" ], "description": "Output-only. A message containing the operation state.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unused.", + "The operation has been created.", + "The operation is running.", + "The operation is done; either cancelled or completed." + ] }, "details": { "description": "Output-only.A message containing any operation metadata details.", @@ -1892,76 +96,17 @@ }, "id": "ClusterOperationStatus" }, - "HadoopJob": { - "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).", - "type": "object", - "properties": { - "jarFileUris": { - "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", - "type": "array", - "items": { - "type": "string" - } - }, - "loggingConfig": { - "$ref": "LoggingConfig", - "description": "Optional. The runtime log config for job execution." - }, - "properties": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", - "type": "object" - }, - "args": { - "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", - "type": "array", - "items": { - "type": "string" - } - }, - "fileUris": { - "description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", - "type": "array", - "items": { - "type": "string" - } - }, - "mainClass": { - "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.", - "type": "string" - }, - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", - "type": "array", - "items": { - "type": "string" - } - }, - "mainJarFileUri": { - "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", - "type": "string" - } - }, - "id": "HadoopJob" - }, - "QueryList": { - "description": "A list of queries to run on a cluster.", - "type": "object", - "properties": { - "queries": { - "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "QueryList" - }, "YarnApplication": { "properties": { + "trackingUrl": { + "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.", + "type": "string" + }, + "progress": { + "description": "Required. The numerical progress of the application, from 1 to 100.", + "format": "float", + "type": "number" + }, "state": { "enum": [ "STATE_UNSPECIFIED", @@ -1991,28 +136,87 @@ "name": { "description": "Required. The application name.", "type": "string" - }, - "trackingUrl": { - "description": "Optional. The HTTP URL of the ApplicationMaster, HistoryServer, or TimelineServer that provides application-specific information. The URL uses the internal hostname, and requires a proxy server for resolution and, possibly, access.", - "type": "string" - }, - "progress": { - "description": "Required. The numerical progress of the application, from 1 to 100.", - "format": "float", - "type": "number" } }, "id": "YarnApplication", "description": "A YARN application created by a job. Application information is a subset of \u003ccode\u003eorg.apache.hadoop.yarn.proto.YarnProtos.ApplicationReportProto\u003c/code\u003e.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", "type": "object" }, + "QueryList": { + "description": "A list of queries to run on a cluster.", + "type": "object", + "properties": { + "queries": { + "description": "Required. The queries to execute. You do not need to terminate a query with a semicolon. Multiple queries can be specified in one string by separating each with a semicolon. Here is an example of an Cloud Dataproc API snippet that uses a QueryList to specify a HiveJob:\n\"hiveJob\": {\n \"queryList\": {\n \"queries\": [\n \"query1\",\n \"query2\",\n \"query3;query4\",\n ]\n }\n}\n", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "QueryList" + }, + "HadoopJob": { + "properties": { + "mainClass": { + "description": "The name of the driver's main class. The jar file containing the class must be in the default CLASSPATH or specified in jar_file_uris.", + "type": "string" + }, + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Hadoop drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, or .zip.", + "type": "array", + "items": { + "type": "string" + } + }, + "mainJarFileUri": { + "description": "The HCFS URI of the jar file containing the main class. Examples: 'gs://foo-bucket/analytics-binaries/extract-useful-metrics-mr.jar' 'hdfs:/tmp/test-samples/custom-wordcount.jar' 'file:///home/usr/lib/hadoop-mapreduce/hadoop-mapreduce-examples.jar'", + "type": "string" + }, + "jarFileUris": { + "description": "Optional. Jar file URIs to add to the CLASSPATHs of the Hadoop driver and tasks.", + "type": "array", + "items": { + "type": "string" + } + }, + "loggingConfig": { + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." + }, + "properties": { + "description": "Optional. A mapping of property names to values, used to configure Hadoop. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site and classes in user code.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "args": { + "description": "Optional. The arguments to pass to the driver. Do not include arguments, such as -libjars or -Dfoo=bar, that can be set as job properties, since a collision may occur that causes an incorrect job submission.", + "type": "array", + "items": { + "type": "string" + } + }, + "fileUris": { + "description": "Optional. HCFS (Hadoop Compatible Filesystem) URIs of files to be copied to the working directory of Hadoop drivers and distributed tasks. Useful for naively parallel tasks.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "HadoopJob", + "description": "A Cloud Dataproc job for running Apache Hadoop MapReduce (https://hadoop.apache.org/docs/current/hadoop-mapreduce-client/hadoop-mapreduce-client-core/MapReduceTutorial.html) jobs on Apache Hadoop YARN (https://hadoop.apache.org/docs/r2.7.1/hadoop-yarn/hadoop-yarn-site/YARN.html).", + "type": "object" + }, "SetIamPolicyRequest": { "description": "Request message for SetIamPolicy method.", "type": "object", "properties": { "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them." + "description": "REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.", + "$ref": "Policy" } }, "id": "SetIamPolicyRequest" @@ -2021,18 +225,6 @@ "description": "A Cloud Dataproc job for running Apache Hive (https://hive.apache.org/) queries on YARN.", "type": "object", "properties": { - "continueOnFailure": { - "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", - "type": "boolean" - }, - "queryFileUri": { - "description": "The HCFS URI of the script that contains Hive queries.", - "type": "string" - }, - "queryList": { - "$ref": "QueryList", - "description": "A list of queries." - }, "jarFileUris": { "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Hive server and Hadoop MapReduce (MR) tasks. Can contain Hive SerDes and UDFs.", "type": "array", @@ -2053,24 +245,22 @@ }, "description": "Optional. A mapping of property names and values, used to configure Hive. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/hive/conf/hive-site.xml, and classes in user code.", "type": "object" + }, + "continueOnFailure": { + "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", + "type": "boolean" + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "queryFileUri": { + "description": "The HCFS URI of the script that contains Hive queries.", + "type": "string" } }, "id": "HiveJob" }, - "WorkflowGraph": { - "properties": { - "nodes": { - "description": "Output only. The workflow nodes.", - "type": "array", - "items": { - "$ref": "WorkflowNode" - } - } - }, - "id": "WorkflowGraph", - "description": "The workflow graph.", - "type": "object" - }, "DiagnoseClusterResults": { "description": "The location of diagnostic output.", "type": "object", @@ -2082,10 +272,32 @@ }, "id": "DiagnoseClusterResults" }, + "WorkflowGraph": { + "description": "The workflow graph.", + "type": "object", + "properties": { + "nodes": { + "description": "Output only. The workflow nodes.", + "type": "array", + "items": { + "$ref": "WorkflowNode" + } + } + }, + "id": "WorkflowGraph" + }, "ClusterConfig": { "description": "The cluster config.", "type": "object", "properties": { + "masterConfig": { + "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.", + "$ref": "InstanceGroupConfig" + }, + "secondaryWorkerConfig": { + "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster.", + "$ref": "InstanceGroupConfig" + }, "initializationActions": { "description": "Optional. Commands to execute on each node after config is completed. By default, executables are run on master and all worker nodes. You can test a node's \u003ccode\u003erole\u003c/code\u003e metadata to run an executable on a master or worker node, as shown below using curl (you can also use wget):\nROLE=$(curl -H Metadata-Flavor:Google http://metadata/computeMetadata/v1beta2/instance/attributes/dataproc-role)\nif [[ \"${ROLE}\" == 'Master' ]]; then\n ... master specific actions ...\nelse\n ... worker specific actions ...\nfi\n", "type": "array", @@ -2094,32 +306,24 @@ } }, "lifecycleConfig": { - "$ref": "LifecycleConfig", - "description": "Optional. The config setting for auto delete cluster schedule." + "description": "Optional. The config setting for auto delete cluster schedule.", + "$ref": "LifecycleConfig" }, "configBucket": { "description": "Optional. A Google Cloud Storage staging bucket used for sharing generated SSH keys and config. If you do not specify a staging bucket, Cloud Dataproc will determine an appropriate Cloud Storage location (US, ASIA, or EU) for your cluster's staging bucket according to the Google Compute Engine zone where your cluster is deployed, and then it will create and manage this project-level, per-location bucket for you.", "type": "string" }, "workerConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster." + "description": "Optional. The Google Compute Engine config settings for worker instances in a cluster.", + "$ref": "InstanceGroupConfig" }, "gceClusterConfig": { "description": "Required. The shared Google Compute Engine config settings for all instances in a cluster.", "$ref": "GceClusterConfig" }, "softwareConfig": { - "$ref": "SoftwareConfig", - "description": "Optional. The config settings for software inside the cluster." - }, - "masterConfig": { - "description": "Optional. The Google Compute Engine config settings for the master instance in a cluster.", - "$ref": "InstanceGroupConfig" - }, - "secondaryWorkerConfig": { - "$ref": "InstanceGroupConfig", - "description": "Optional. The Google Compute Engine config settings for additional worker instances in a cluster." + "description": "Optional. The config settings for software inside the cluster.", + "$ref": "SoftwareConfig" } }, "id": "ClusterConfig" @@ -2175,14 +379,24 @@ } }, "loggingConfig": { - "description": "Optional. The runtime log config for job execution.", - "$ref": "LoggingConfig" + "$ref": "LoggingConfig", + "description": "Optional. The runtime log config for job execution." } }, "id": "PySparkJob" }, "ClusterMetrics": { + "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", + "type": "object", "properties": { + "yarnMetrics": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "The YARN metrics.", + "type": "object" + }, "hdfsMetrics": { "additionalProperties": { "format": "int64", @@ -2190,32 +404,22 @@ }, "description": "The HDFS metrics.", "type": "object" - }, - "yarnMetrics": { - "description": "The YARN metrics.", - "type": "object", - "additionalProperties": { - "format": "int64", - "type": "string" - } } }, - "id": "ClusterMetrics", - "description": "Contains cluster daemon metrics, such as HDFS and YARN stats.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", - "type": "object" + "id": "ClusterMetrics" }, "AcceleratorConfig": { "description": "Specifies the type and number of accelerator cards attached to the instances of an instance group (see GPUs on Compute Engine).", "type": "object", "properties": { - "acceleratorTypeUri": { - "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80", - "type": "string" - }, "acceleratorCount": { "description": "The number of the accelerator cards of this type exposed to this instance.", "format": "int32", "type": "integer" + }, + "acceleratorTypeUri": { + "description": "Full URL, partial URI, or short name of the accelerator type resource to expose to this instance. See Google Compute Engine AcceleratorTypes( /compute/docs/reference/beta/acceleratorTypes)Examples * https://www.googleapis.com/compute/beta/projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * projects/[project_id]/zones/us-east1-a/acceleratorTypes/nvidia-tesla-k80 * nvidia-tesla-k80", + "type": "string" } }, "id": "AcceleratorConfig" @@ -2235,11 +439,12 @@ "id": "TestIamPermissionsRequest" }, "LoggingConfig": { - "description": "The runtime logging config of the job.", - "type": "object", "properties": { "driverLogLevels": { + "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'", + "type": "object", "additionalProperties": { + "type": "string", "enum": [ "LEVEL_UNSPECIFIED", "ALL", @@ -2250,28 +455,26 @@ "ERROR", "FATAL", "OFF" - ], - "type": "string" - }, - "description": "The per-package log levels for the driver. This may include \"root\" package name to configure rootLogger. Examples: 'com.google = FATAL', 'root = INFO', 'org.apache = DEBUG'", - "type": "object" + ] + } } }, - "id": "LoggingConfig" + "id": "LoggingConfig", + "description": "The runtime logging config of the job.", + "type": "object" }, "OrderedJob": { - "type": "object", "properties": { "labels": { - "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Optional. The labels to associate with this job.Label keys must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}{0,62}Label values must be between 1 and 63 characters long, and must conform to the following regular expression: \\p{Ll}\\p{Lo}\\p{N}_-{0,63}No more than 64 labels can be associated with a given job.", + "type": "object" }, "sparkJob": { - "description": "Job is a Spark job.", - "$ref": "SparkJob" + "$ref": "SparkJob", + "description": "Job is a Spark job." }, "sparkSqlJob": { "$ref": "SparkSqlJob", @@ -2282,20 +485,24 @@ "$ref": "PySparkJob" }, "scheduling": { - "$ref": "JobScheduling", - "description": "Optional. Job scheduling configuration." + "description": "Optional. Job scheduling configuration.", + "$ref": "JobScheduling" }, "pigJob": { - "$ref": "PigJob", - "description": "Job is a Pig job." + "description": "Job is a Pig job.", + "$ref": "PigJob" }, "stepId": { "description": "Required. The step id. The id must be unique among all jobs within the template.The step id is used as prefix for job id, as job workflow-step-id label, and in prerequisite_step_ids field from other steps.", "type": "string" }, "hadoopJob": { - "$ref": "HadoopJob", - "description": "Job is a Hadoop job." + "description": "Job is a Hadoop job.", + "$ref": "HadoopJob" + }, + "hiveJob": { + "$ref": "HiveJob", + "description": "Job is a Hive job." }, "prerequisiteStepIds": { "description": "Optional. The optional list of prerequisite job step_ids. If not specified, the job will start at the beginning of workflow.", @@ -2303,17 +510,24 @@ "items": { "type": "string" } - }, - "hiveJob": { - "description": "Job is a Hive job.", - "$ref": "HiveJob" } }, - "id": "OrderedJob" + "id": "OrderedJob", + "type": "object" }, "WorkflowNode": { + "description": "The workflow node.", + "type": "object", "properties": { "state": { + "enumDescriptions": [ + "", + "The node is awaiting prerequisite node to finish.", + "The node is runnable but not running.", + "The node is running.", + "The node completed successfully.", + "The node failed. A node can be marked FAILED because its ancestor or peer failed." + ], "enum": [ "NODE_STATUS_UNSPECIFIED", "BLOCKED", @@ -2323,15 +537,7 @@ "FAILED" ], "description": "Output only. The node state.", - "type": "string", - "enumDescriptions": [ - "", - "The node is awaiting prerequisite node to finish.", - "The node is runnable but not running.", - "The node is running.", - "The node completed successfully.", - "The node failed. A node can be marked FAILED because its ancestor or peer failed." - ] + "type": "string" }, "stepId": { "description": "Output only. The name of the node.", @@ -2353,9 +559,7 @@ } } }, - "id": "WorkflowNode", - "description": "The workflow node.", - "type": "object" + "id": "WorkflowNode" }, "InstantiateWorkflowTemplateRequest": { "description": "A request to instantiate a workflow template.", @@ -2385,8 +589,6 @@ "type": "object" }, "JobScheduling": { - "description": "Job scheduling options.", - "type": "object", "properties": { "maxFailuresPerHour": { "description": "Optional. Maximum number of times per hour a driver may be restarted as a result of driver terminating with non-zero code before job is reported failed.A job may be reported as thrashing if driver exits with non-zero code 4 times within 10 minute window.Maximum value is 10.", @@ -2394,10 +596,18 @@ "type": "integer" } }, - "id": "JobScheduling" + "id": "JobScheduling", + "description": "Job scheduling options.", + "type": "object" }, "Cluster": { + "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.", + "type": "object", "properties": { + "projectId": { + "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" @@ -2410,8 +620,12 @@ "$ref": "ClusterMetrics" }, "status": { - "$ref": "ClusterStatus", - "description": "Output-only. Cluster status." + "description": "Output-only. Cluster status.", + "$ref": "ClusterStatus" + }, + "config": { + "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated.", + "$ref": "ClusterConfig" }, "statusHistory": { "description": "Output-only. The previous cluster status.", @@ -2420,10 +634,6 @@ "$ref": "ClusterStatus" } }, - "config": { - "$ref": "ClusterConfig", - "description": "Required. The cluster config. Note that Cloud Dataproc may set default values, and values may change when clusters are updated." - }, "clusterName": { "description": "Required. The cluster name. Cluster names within a project must be unique. Names of deleted clusters can be reused.", "type": "string" @@ -2431,15 +641,9 @@ "clusterUuid": { "description": "Output-only. A cluster UUID (Unique Universal Identifier). Cloud Dataproc generates this value when it creates the cluster.", "type": "string" - }, - "projectId": { - "description": "Required. The Google Cloud Platform project ID that the cluster belongs to.", - "type": "string" } }, - "id": "Cluster", - "description": "Describes the identifying information, config, and status of a cluster of Google Compute Engine instances.", - "type": "object" + "id": "Cluster" }, "TestIamPermissionsResponse": { "properties": { @@ -2456,8 +660,6 @@ "type": "object" }, "SoftwareConfig": { - "description": "Specifies the selection and config of software inside the cluster.", - "type": "object", "properties": { "imageVersion": { "description": "Optional. The version of software inside the cluster. It must match the regular expression [0-9]+\\.[0-9]+. If unspecified, it defaults to the latest version (see Cloud Dataproc Versioning).", @@ -2471,22 +673,24 @@ "type": "object" } }, - "id": "SoftwareConfig" + "id": "SoftwareConfig", + "description": "Specifies the selection and config of software inside the cluster.", + "type": "object" }, "ClusterSelector": { "description": "A selector that chooses target cluster for jobs based on metadata.", "type": "object", "properties": { + "clusterLabels": { + "description": "Required. The cluster labels. Cluster must have all labels to match.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, "zone": { "description": "Optional. The zone where workflow process executes. This parameter does not affect the selection of the cluster.If unspecified, the zone of the first cluster matching the selector is used.", "type": "string" - }, - "clusterLabels": { - "additionalProperties": { - "type": "string" - }, - "description": "Required. The cluster labels. Cluster must have all labels to match.", - "type": "object" } }, "id": "ClusterSelector" @@ -2495,13 +699,13 @@ "description": "Specifies workflow execution target.Either managed_cluster or cluster_selector is required.", "type": "object", "properties": { + "managedCluster": { + "description": "Optional. A cluster that is managed by the workflow.", + "$ref": "ManagedCluster" + }, "clusterSelector": { "$ref": "ClusterSelector", "description": "Optional. A selector that chooses target cluster for jobs based on metadata.The selector is evaluated at the time each job is submitted." - }, - "managedCluster": { - "$ref": "ManagedCluster", - "description": "Optional. A cluster that is managed by the workflow." } }, "id": "WorkflowTemplatePlacement" @@ -2509,10 +713,6 @@ "ClusterOperation": { "type": "object", "properties": { - "done": { - "description": "Output only. Indicates the operation is done.", - "type": "boolean" - }, "operationId": { "description": "Output only. The id of the cluster operation.", "type": "string" @@ -2520,19 +720,27 @@ "error": { "description": "Output only. Error, if operation failed.", "type": "string" + }, + "done": { + "description": "Output only. Indicates the operation is done.", + "type": "boolean" } }, "id": "ClusterOperation" }, "WorkflowMetadata": { - "description": "A Cloud Dataproc workflow template resource.", - "type": "object", "properties": { + "template": { + "description": "Output only. The \"resource name\" of the template.", + "type": "string" + }, "deleteCluster": { "$ref": "ClusterOperation", "description": "Output only. The delete cluster operation metadata." }, "state": { + "description": "Output only. The workflow state.", + "type": "string", "enumDescriptions": [ "Unused.", "The operation has been created.", @@ -2544,17 +752,15 @@ "PENDING", "RUNNING", "DONE" - ], - "description": "Output only. The workflow state.", - "type": "string" + ] }, "clusterName": { "description": "Output only. The name of the managed cluster.", "type": "string" }, "createCluster": { - "$ref": "ClusterOperation", - "description": "Output only. The create cluster operation metadata." + "description": "Output only. The create cluster operation metadata.", + "$ref": "ClusterOperation" }, "version": { "description": "Output only. The version of template at the time of workflow instantiation.", @@ -2562,31 +768,16 @@ "type": "integer" }, "graph": { - "description": "Output only. The workflow graph.", - "$ref": "WorkflowGraph" - }, - "template": { - "description": "Output only. The \"resource name\" of the template.", - "type": "string" + "$ref": "WorkflowGraph", + "description": "Output only. The workflow graph." } }, - "id": "WorkflowMetadata" + "id": "WorkflowMetadata", + "description": "A Cloud Dataproc workflow template resource.", + "type": "object" }, "SparkJob": { - "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.", - "type": "object", "properties": { - "mainClass": { - "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.", - "type": "string" - }, - "archiveUris": { - "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", - "type": "array", - "items": { - "type": "string" - } - }, "mainJarFileUri": { "description": "The HCFS URI of the jar file that contains the main class.", "type": "string" @@ -2622,46 +813,28 @@ "items": { "type": "string" } + }, + "mainClass": { + "description": "The name of the driver's main class. The jar file that contains the class must be in the default CLASSPATH or specified in jar_file_uris.", + "type": "string" + }, + "archiveUris": { + "description": "Optional. HCFS URIs of archives to be extracted in the working directory of Spark drivers and tasks. Supported file types: .jar, .tar, .tar.gz, .tgz, and .zip.", + "type": "array", + "items": { + "type": "string" + } } }, - "id": "SparkJob" + "id": "SparkJob", + "description": "A Cloud Dataproc job for running Apache Spark (http://spark.apache.org/) applications on YARN.", + "type": "object" }, "JobStatus": { + "description": "Cloud Dataproc job status.", + "type": "object", "properties": { - "stateStartTime": { - "description": "Output-only. The time when this state was entered.", - "format": "google-datetime", - "type": "string" - }, - "substate": { - "enumDescriptions": [ - "", - "The Job is submitted to the agent.Applies to RUNNING state.", - "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.", - "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state." - ], - "enum": [ - "UNSPECIFIED", - "SUBMITTED", - "QUEUED", - "STALE_STATUS" - ], - "description": "Output-only. Additional state information, which includes status reported by the agent.", - "type": "string" - }, "state": { - "enum": [ - "STATE_UNSPECIFIED", - "PENDING", - "SETUP_DONE", - "RUNNING", - "CANCEL_PENDING", - "CANCEL_STARTED", - "CANCELLED", - "DONE", - "ERROR", - "ATTEMPT_FAILURE" - ], "description": "Output-only. A state message specifying the overall job state.", "type": "string", "enumDescriptions": [ @@ -2675,32 +848,58 @@ "The job has completed successfully.", "The job has completed, but encountered an error.", "Job attempt has failed. The detail field contains failure details for this attempt.Applies to restartable jobs only." + ], + "enum": [ + "STATE_UNSPECIFIED", + "PENDING", + "SETUP_DONE", + "RUNNING", + "CANCEL_PENDING", + "CANCEL_STARTED", + "CANCELLED", + "DONE", + "ERROR", + "ATTEMPT_FAILURE" ] }, "details": { "description": "Output-only. Optional job state details, such as an error description if the state is \u003ccode\u003eERROR\u003c/code\u003e.", "type": "string" + }, + "stateStartTime": { + "description": "Output-only. The time when this state was entered.", + "format": "google-datetime", + "type": "string" + }, + "substate": { + "enum": [ + "UNSPECIFIED", + "SUBMITTED", + "QUEUED", + "STALE_STATUS" + ], + "description": "Output-only. Additional state information, which includes status reported by the agent.", + "type": "string", + "enumDescriptions": [ + "", + "The Job is submitted to the agent.Applies to RUNNING state.", + "The Job has been received and is awaiting execution (it may be waiting for a condition to be met). See the \"details\" field for the reason for the delay.Applies to RUNNING state.", + "The agent-reported status is out of date, which may be caused by a loss of communication between the agent and Cloud Dataproc. If the agent does not send a timely update, the job will fail.Applies to RUNNING state." + ] } }, - "id": "JobStatus", - "description": "Cloud Dataproc job status.", - "type": "object" + "id": "JobStatus" }, "DiagnoseClusterRequest": { - "properties": {}, - "id": "DiagnoseClusterRequest", "description": "A request to collect cluster diagnostic information.", - "type": "object" + "type": "object", + "properties": {}, + "id": "DiagnoseClusterRequest" }, "DiskConfig": { "description": "Specifies the config of disk options for a group of VM instances.", "type": "object", "properties": { - "bootDiskSizeGb": { - "description": "Optional. Size in GB of the boot disk (default is 500GB).", - "format": "int32", - "type": "integer" - }, "bootDiskType": { "description": "Optional. Type of the boot disk (default is 'pd-standard'). Valid values: 'pd-ssd', 'pd-standard'", "type": "string" @@ -2709,6 +908,11 @@ "description": "Optional. Number of attached SSDs, from 0 to 4 (default is 0). If SSDs are not attached, the boot disk is used to store runtime logs and HDFS (https://hadoop.apache.org/docs/r1.2.1/hdfs_user_guide.html) data. If one or more SSDs are attached, this runtime bulk data is spread across them, and the boot disk contains only basic config and installed binaries.", "format": "int32", "type": "integer" + }, + "bootDiskSizeGb": { + "description": "Optional. Size in GB of the boot disk (default is 500GB).", + "format": "int32", + "type": "integer" } }, "id": "DiskConfig" @@ -2717,21 +921,6 @@ "description": "Metadata describing the operation.", "type": "object", "properties": { - "operationType": { - "description": "Output-only. The operation type.", - "type": "string" - }, - "description": { - "description": "Output-only. Short description of operation.", - "type": "string" - }, - "warnings": { - "description": "Output-only. Errors encountered during operation execution.", - "type": "array", - "items": { - "type": "string" - } - }, "labels": { "additionalProperties": { "type": "string" @@ -2757,6 +946,21 @@ "clusterName": { "description": "Output-only. Name of the cluster for the operation.", "type": "string" + }, + "operationType": { + "description": "Output-only. The operation type.", + "type": "string" + }, + "description": { + "description": "Output-only. Short description of operation.", + "type": "string" + }, + "warnings": { + "description": "Output-only. Errors encountered during operation execution.", + "type": "array", + "items": { + "type": "string" + } } }, "id": "ClusterOperationMetadata" @@ -2766,6 +970,590 @@ "type": "object", "properties": {}, "id": "Empty" + }, + "GceClusterConfig": { + "description": "Common config settings for resources of Google Compute Engine cluster instances, applicable to all instances in the cluster.", + "type": "object", + "properties": { + "networkUri": { + "description": "Optional. The Google Compute Engine network to be used for machine communications. Cannot be specified with subnetwork_uri. If neither network_uri nor subnetwork_uri is specified, the \"default\" network of the project is used, if it exists. Cannot be a \"Custom Subnet Network\" (see Using Subnetworks for more information).A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/global/default\nprojects/[project_id]/regions/global/default\ndefault", + "type": "string" + }, + "zoneUri": { + "description": "Optional. The zone where the Google Compute Engine cluster will be located. On a create request, it is required in the \"global\" region. If omitted in a non-global Cloud Dataproc region, the service will pick a zone in the corresponding Compute Engine region. On a get request, zone will always be present.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/[zone]\nprojects/[project_id]/zones/[zone]\nus-central1-f", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "type": "string" + }, + "description": "The Google Compute Engine metadata entries to add to all instances (see Project and instance metadata (https://cloud.google.com/compute/docs/storing-retrieving-metadata#project_and_instance_metadata)).", + "type": "object" + }, + "internalIpOnly": { + "description": "Optional. If true, all instances in the cluster will only have internal IP addresses. By default, clusters are not restricted to internal IP addresses, and will have ephemeral external IP addresses assigned to each instance. This internal_ip_only restriction can only be enabled for subnetwork enabled networks, and all off-cluster dependencies must be configured to be accessible without external IP addresses.", + "type": "boolean" + }, + "serviceAccountScopes": { + "description": "Optional. The URIs of service account scopes to be included in Google Compute Engine instances. The following base set of scopes is always included:\nhttps://www.googleapis.com/auth/cloud.useraccounts.readonly\nhttps://www.googleapis.com/auth/devstorage.read_write\nhttps://www.googleapis.com/auth/logging.writeIf no scopes are specified, the following defaults are also provided:\nhttps://www.googleapis.com/auth/bigquery\nhttps://www.googleapis.com/auth/bigtable.admin.table\nhttps://www.googleapis.com/auth/bigtable.data\nhttps://www.googleapis.com/auth/devstorage.full_control", + "type": "array", + "items": { + "type": "string" + } + }, + "tags": { + "description": "The Google Compute Engine tags to add to all instances (see Tagging instances).", + "type": "array", + "items": { + "type": "string" + } + }, + "serviceAccount": { + "description": "Optional. The service account of the instances. Defaults to the default Google Compute Engine service account. Custom service accounts need permissions equivalent to the folloing IAM roles:\nroles/logging.logWriter\nroles/storage.objectAdmin(see https://cloud.google.com/compute/docs/access/service-accounts#custom_service_accounts for more information). Example: [account_id]@[project_id].iam.gserviceaccount.com", + "type": "string" + }, + "subnetworkUri": { + "description": "Optional. The Google Compute Engine subnetwork to be used for machine communications. Cannot be specified with network_uri.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/regions/us-east1/sub0\nprojects/[project_id]/regions/us-east1/sub0\nsub0", + "type": "string" + } + }, + "id": "GceClusterConfig" + }, + "Policy": { + "properties": { + "bindings": { + "description": "Associates a list of members to a role. bindings with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + }, + "etag": { + "description": "etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy.If no etag is provided in the call to setIamPolicy, then the existing policy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Version of the Policy. The default version is 0.", + "format": "int32", + "type": "integer" + } + }, + "id": "Policy", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources.A Policy consists of a list of bindings. A Binding binds a list of members to a role, where the members can be user accounts, Google groups, Google domains, and service accounts. A role is a named list of permissions defined by IAM.Example\n{\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n}\nFor a description of IAM and its features, see the IAM developer's guide (https://cloud.google.com/iam).", + "type": "object" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a network API call.", + "type": "object", + "properties": { + "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 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" + }, + "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 operations/some/unique/name.", + "type": "string" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.", + "type": "object" + }, + "done": { + "description": "If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.", + "type": "boolean" + } + }, + "id": "Operation" + }, + "ListWorkflowTemplatesResponse": { + "description": "A response to a request to list workflow templates in a project.", + "type": "object", + "properties": { + "templates": { + "description": "Output only. WorkflowTemplates list.", + "type": "array", + "items": { + "$ref": "WorkflowTemplate" + } + }, + "nextPageToken": { + "description": "Output only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListWorkflowTemplatesRequest\u003c/code\u003e.", + "type": "string" + } + }, + "id": "ListWorkflowTemplatesResponse" + }, + "JobReference": { + "properties": { + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "type": "string" + }, + "jobId": { + "description": "Optional. The job ID, which must be unique within the project. The job ID is generated by the server upon job submission or provided by the user as a means to perform retries without creating duplicate jobs. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), or hyphens (-). The maximum length is 100 characters.", + "type": "string" + } + }, + "id": "JobReference", + "description": "Encapsulates the full scoping used to reference a job.", + "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "type": "object", + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "id": "Status" + }, + "Binding": { + "description": "Associates members with a role.", + "type": "object", + "properties": { + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource. members can have the following values:\nallUsers: A special identifier that represents anyone who is on the internet; with or without a Google account.\nallAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account.\nuser:{emailid}: An email address that represents a specific Google account. For example, alice@gmail.com or joe@example.com.\nserviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com.\ngroup:{emailid}: An email address that represents a Google group. For example, admins@example.com.\ndomain:{domain}: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner. Required", + "type": "string" + } + }, + "id": "Binding" + }, + "InstanceGroupConfig": { + "description": "Optional. The config settings for Google Compute Engine resources in an instance group, such as a master or worker group.", + "type": "object", + "properties": { + "diskConfig": { + "$ref": "DiskConfig", + "description": "Optional. Disk option config settings." + }, + "managedGroupConfig": { + "description": "Output-only. The config for Google Compute Engine Instance Group Manager that manages this group. This is only used for preemptible instance groups.", + "$ref": "ManagedGroupConfig" + }, + "isPreemptible": { + "description": "Optional. Specifies that this instance group contains preemptible instances.", + "type": "boolean" + }, + "imageUri": { + "description": "Output-only. The Google Compute Engine image resource used for cluster instances. Inferred from SoftwareConfig.image_version.", + "type": "string" + }, + "machineTypeUri": { + "description": "Optional. The Google Compute Engine machine type used for cluster instances.A full URL, partial URI, or short name are valid. Examples:\nhttps://www.googleapis.com/compute/v1/projects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nprojects/[project_id]/zones/us-east1-a/machineTypes/n1-standard-2\nn1-standard-2", + "type": "string" + }, + "instanceNames": { + "description": "Optional. The list of instance names. Cloud Dataproc derives the names from cluster_name, num_instances, and the instance group if not set by user (recommended practice is to let Cloud Dataproc derive the name).", + "type": "array", + "items": { + "type": "string" + } + }, + "accelerators": { + "description": "Optional. The Google Compute Engine accelerator configuration for these instances.Beta Feature: This feature is still under development. It may be changed before final release.", + "type": "array", + "items": { + "$ref": "AcceleratorConfig" + } + }, + "numInstances": { + "description": "Optional. The number of VM instances in the instance group. For master instance groups, must be set to 1.", + "format": "int32", + "type": "integer" + }, + "minCpuPlatform": { + "description": "Optional. Specifies the minimum cpu platform for the Instance Group. Examples: * https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform", + "type": "string" + } + }, + "id": "InstanceGroupConfig" + }, + "ListJobsResponse": { + "description": "A list of jobs in a project.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "Optional. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListJobsRequest\u003c/code\u003e.", + "type": "string" + }, + "jobs": { + "description": "Output-only. Jobs list.", + "type": "array", + "items": { + "$ref": "Job" + } + } + }, + "id": "ListJobsResponse" + }, + "NodeInitializationAction": { + "description": "Specifies an executable to run on a fully configured node and a timeout period for executable completion.", + "type": "object", + "properties": { + "executionTimeout": { + "description": "Optional. Amount of time executable has to complete. Default is 10 minutes. Cluster creation fails with an explanatory error message (the name of the executable that caused the error and the exceeded timeout period) if the executable is not completed at end of the timeout period.", + "format": "google-duration", + "type": "string" + }, + "executableFile": { + "description": "Required. Google Cloud Storage URI of executable file.", + "type": "string" + } + }, + "id": "NodeInitializationAction" + }, + "CancelJobRequest": { + "description": "A request to cancel a job.", + "type": "object", + "properties": {}, + "id": "CancelJobRequest" + }, + "SparkSqlJob": { + "description": "A Cloud Dataproc job for running Apache Spark SQL (http://spark.apache.org/sql/) queries.", + "type": "object", + "properties": { + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Spark SQL's SparkConf. Properties that conflict with values set by the Cloud Dataproc API may be overwritten.", + "type": "object" + }, + "queryFileUri": { + "description": "The HCFS URI of the script that contains SQL queries.", + "type": "string" + }, + "queryList": { + "description": "A list of queries.", + "$ref": "QueryList" + }, + "scriptVariables": { + "description": "Optional. Mapping of query variable names to values (equivalent to the Spark SQL command: SET name=\"value\";).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to be added to the Spark CLASSPATH.", + "type": "array", + "items": { + "type": "string" + } + }, + "loggingConfig": { + "description": "Optional. The runtime log config for job execution.", + "$ref": "LoggingConfig" + } + }, + "id": "SparkSqlJob" + }, + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + }, + "id": "ListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object" + }, + "JobPlacement": { + "description": "Cloud Dataproc job config.", + "type": "object", + "properties": { + "clusterName": { + "description": "Required. The name of the cluster where the job will be submitted.", + "type": "string" + }, + "clusterUuid": { + "description": "Output-only. A cluster UUID generated by the Cloud Dataproc service when the job is submitted.", + "type": "string" + } + }, + "id": "JobPlacement" + }, + "ClusterStatus": { + "description": "The status of a cluster and its instances.", + "type": "object", + "properties": { + "stateStartTime": { + "description": "Output-only. Time when this state was entered.", + "format": "google-datetime", + "type": "string" + }, + "substate": { + "enumDescriptions": [ + "", + "The cluster is known to be in an unhealthy state (for example, critical daemons are not running or HDFS capacity is exhausted).Applies to RUNNING state.", + "The agent-reported status is out of date (may occur if Cloud Dataproc loses communication with Agent).Applies to RUNNING state." + ], + "enum": [ + "UNSPECIFIED", + "UNHEALTHY", + "STALE_STATUS" + ], + "description": "Output-only. Additional state information that includes status reported by the agent.", + "type": "string" + }, + "detail": { + "description": "Output-only. Optional details of cluster's state.", + "type": "string" + }, + "state": { + "enum": [ + "UNKNOWN", + "CREATING", + "RUNNING", + "ERROR", + "DELETING", + "UPDATING" + ], + "description": "Output-only. The cluster's state.", + "type": "string", + "enumDescriptions": [ + "The cluster state is unknown.", + "The cluster is being created and set up. It is not ready for use.", + "The cluster is currently running and healthy. It is ready for use.", + "The cluster encountered an error. It is not ready for use.", + "The cluster is being deleted. It cannot be used.", + "The cluster is being updated. It continues to accept and process jobs." + ] + } + }, + "id": "ClusterStatus" + }, + "PigJob": { + "properties": { + "continueOnFailure": { + "description": "Optional. Whether to continue executing queries if a query fails. The default value is false. Setting to true can be useful when executing independent parallel queries.", + "type": "boolean" + }, + "queryList": { + "$ref": "QueryList", + "description": "A list of queries." + }, + "queryFileUri": { + "description": "The HCFS URI of the script that contains the Pig queries.", + "type": "string" + }, + "jarFileUris": { + "description": "Optional. HCFS URIs of jar files to add to the CLASSPATH of the Pig Client and Hadoop MapReduce (MR) tasks. Can contain Pig UDFs.", + "type": "array", + "items": { + "type": "string" + } + }, + "scriptVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. Mapping of query variable names to values (equivalent to the Pig command: name=[value]).", + "type": "object" + }, + "loggingConfig": { + "description": "Optional. The runtime log config for job execution.", + "$ref": "LoggingConfig" + }, + "properties": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A mapping of property names to values, used to configure Pig. Properties that conflict with values set by the Cloud Dataproc API may be overwritten. Can include properties set in /etc/hadoop/conf/*-site.xml, /etc/pig/conf/pig.properties, and classes in user code.", + "type": "object" + } + }, + "id": "PigJob", + "description": "A Cloud Dataproc job for running Apache Pig (https://pig.apache.org/) queries on YARN.", + "type": "object" + }, + "WorkflowTemplate": { + "description": "A Cloud Dataproc workflow template resource.", + "type": "object", + "properties": { + "jobs": { + "description": "Required. The Directed Acyclic Graph of Jobs to submit.", + "type": "array", + "items": { + "$ref": "OrderedJob" + } + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this template. These labels will be propagated to all jobs and clusters created by the workflow instance.Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt).No more than 32 labels can be associated with a template.", + "type": "object" + }, + "createTime": { + "description": "Output only. The time template was created.", + "format": "google-datetime", + "type": "string" + }, + "placement": { + "$ref": "WorkflowTemplatePlacement", + "description": "Required. WorkflowTemplate scheduling information." + }, + "updateTime": { + "description": "Output only. The time template was last updated.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "type": "string" + }, + "version": { + "description": "Optional. Used to perform a consistent read-modify-write.This field should be left blank for a CreateWorkflowTemplate request. It is required for an UpdateWorkflowTemplate request, and must match the current server version. A typical update template flow would fetch the current template with a GetWorkflowTemplate request, which will return the current template with the version field filled in with the current server version. The user updates other fields in the template, then returns it as part of the UpdateWorkflowTemplate request.", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "Required. The template id.", + "type": "string" + } + }, + "id": "WorkflowTemplate" + }, + "ListClustersResponse": { + "description": "The list of all clusters in a project.", + "type": "object", + "properties": { + "clusters": { + "description": "Output-only. The clusters in the project.", + "type": "array", + "items": { + "$ref": "Cluster" + } + }, + "nextPageToken": { + "description": "Output-only. This token is included in the response if there are more results to fetch. To fetch additional results, provide this value as the page_token in a subsequent \u003ccode\u003eListClustersRequest\u003c/code\u003e.", + "type": "string" + } + }, + "id": "ListClustersResponse" + }, + "Job": { + "description": "A Cloud Dataproc job resource.", + "type": "object", + "properties": { + "pigJob": { + "description": "Job is a Pig job.", + "$ref": "PigJob" + }, + "hiveJob": { + "description": "Job is a Hive job.", + "$ref": "HiveJob" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. The labels to associate with this job. Label keys must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). Label values may be empty, but, if present, must contain 1 to 63 characters, and must conform to RFC 1035 (https://www.ietf.org/rfc/rfc1035.txt). No more than 32 labels can be associated with a job.", + "type": "object" + }, + "driverOutputResourceUri": { + "description": "Output-only. A URI pointing to the location of the stdout of the job's driver program.", + "type": "string" + }, + "statusHistory": { + "description": "Output-only. The previous job status.", + "type": "array", + "items": { + "$ref": "JobStatus" + } + }, + "sparkSqlJob": { + "description": "Job is a SparkSql job.", + "$ref": "SparkSqlJob" + }, + "sparkJob": { + "description": "Job is a Spark job.", + "$ref": "SparkJob" + }, + "yarnApplications": { + "description": "Output-only. The collection of YARN applications spun up by this job.Beta Feature: This report is available for testing purposes only. It may be changed before final release.", + "type": "array", + "items": { + "$ref": "YarnApplication" + } + }, + "pysparkJob": { + "description": "Job is a Pyspark job.", + "$ref": "PySparkJob" + }, + "reference": { + "$ref": "JobReference", + "description": "Optional. The fully qualified reference to the job, which can be used to obtain the equivalent REST path of the job resource. If this property is not specified when a job is created, the server generates a \u003ccode\u003ejob_id\u003c/code\u003e." + }, + "hadoopJob": { + "description": "Job is a Hadoop job.", + "$ref": "HadoopJob" + }, + "placement": { + "$ref": "JobPlacement", + "description": "Required. Job information, including how, when, and where to run the job." + }, + "status": { + "$ref": "JobStatus", + "description": "Output-only. The job status. Additional application-specific status information may be contained in the \u003ccode\u003etype_job\u003c/code\u003e and \u003ccode\u003eyarn_applications\u003c/code\u003e fields." + }, + "driverControlFilesUri": { + "description": "Output-only. If present, the location of miscellaneous control files which may be used as part of job setup and handling. If not present, control files may be placed in the same location as driver_output_uri.", + "type": "string" + }, + "scheduling": { + "$ref": "JobScheduling", + "description": "Optional. Job scheduling configuration." + } + }, + "id": "Job" } }, "icons": { @@ -2785,5 +1573,1217 @@ "rootUrl": "https://dataproc.googleapis.com/", "ownerDomain": "google.com", "name": "dataproc", - "batchPath": "batch" + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Cloud Dataproc API", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "regions": { + "resources": { + "jobs": { + "methods": { + "submit": { + "description": "Submits a job to a cluster.", + "request": { + "$ref": "SubmitJobRequest" + }, + "response": { + "$ref": "Job" + }, + "parameterOrder": [ + "projectId", + "region" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit", + "path": "v1beta2/projects/{projectId}/regions/{region}/jobs:submit", + "id": "dataproc.projects.regions.jobs.submit" + }, + "delete": { + "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", + "id": "dataproc.projects.regions.jobs.delete", + "description": "Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "jobId": { + "location": "path", + "description": "Required. The job ID.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}" + }, + "list": { + "description": "Lists regions/{region}/jobs in a project.", + "response": { + "$ref": "ListJobsResponse" + }, + "parameterOrder": [ + "projectId", + "region" + ], + "httpMethod": "GET", + "parameters": { + "clusterName": { + "description": "Optional. If set, the returned jobs list includes only jobs that were submitted to the named cluster.", + "type": "string", + "location": "query" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "filter": { + "description": "Optional. A filter constraining the jobs to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is status.state or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be either ACTIVE or NON_ACTIVE. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND labels.env = staging AND labels.starred = *", + "type": "string", + "location": "query" + }, + "jobStateMatcher": { + "enum": [ + "ALL", + "ACTIVE", + "NON_ACTIVE" + ], + "description": "Optional. Specifies enumerated categories of jobs to list. (default = match ALL jobs).If filter is provided, jobStateMatcher will be ignored.", + "type": "string", + "location": "query" + }, + "pageToken": { + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The number of results to return in each response.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs", + "path": "v1beta2/projects/{projectId}/regions/{region}/jobs", + "id": "dataproc.projects.regions.jobs.list" + }, + "cancel": { + "request": { + "$ref": "CancelJobRequest" + }, + "description": "Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.", + "response": { + "$ref": "Job" + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "httpMethod": "POST", + "parameters": { + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "jobId": { + "location": "path", + "description": "Required. The job ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", + "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}:cancel", + "id": "dataproc.projects.regions.jobs.cancel" + }, + "get": { + "response": { + "$ref": "Job" + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "httpMethod": "GET", + "parameters": { + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "jobId": { + "location": "path", + "description": "Required. The job ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", + "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", + "id": "dataproc.projects.regions.jobs.get", + "description": "Gets the resource representation for a job in a project." + }, + "patch": { + "description": "Updates a job in a project.", + "request": { + "$ref": "Job" + }, + "response": { + "$ref": "Job" + }, + "parameterOrder": [ + "projectId", + "region", + "jobId" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the job belongs to.", + "required": true, + "type": "string" + }, + "jobId": { + "location": "path", + "description": "Required. The job ID.", + "required": true, + "type": "string" + }, + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specifies the path, relative to \u003ccode\u003eJob\u003c/code\u003e, of the field to update. For example, to update the labels of a Job the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003elabels\u003c/code\u003e, and the PATCH request body would specify the new value. \u003cstrong\u003eNote:\u003c/strong\u003e Currently, \u003ccode\u003elabels\u003c/code\u003e is the only field that can be updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", + "path": "v1beta2/projects/{projectId}/regions/{region}/jobs/{jobId}", + "id": "dataproc.projects.regions.jobs.patch" + } + } + }, + "clusters": { + "methods": { + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:testIamPermissions", + "path": "v1beta2/{+resource}:testIamPermissions", + "id": "dataproc.projects.regions.clusters.testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning." + }, + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "parameters": { + "clusterName": { + "location": "path", + "description": "Required. The cluster name.", + "required": true, + "type": "string" + }, + "clusterUuid": { + "location": "query", + "description": "Optional. Specifying the cluster_uuid means the RPC should fail (with error NOT_FOUND) if cluster with specified UUID does not exist.", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "id": "dataproc.projects.regions.clusters.delete", + "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "description": "Deletes a cluster in a project." + }, + "diagnose": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "clusterName": { + "location": "path", + "description": "Required. The cluster name.", + "required": true, + "type": "string" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", + "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}:diagnose", + "id": "dataproc.projects.regions.clusters.diagnose", + "description": "Gets cluster diagnostic information. After the operation completes, the Operation.response field contains DiagnoseClusterOutputLocation.", + "request": { + "$ref": "DiagnoseClusterRequest" + } + }, + "list": { + "description": "Lists all regions/{region}/clusters in a project.", + "response": { + "$ref": "ListClustersResponse" + }, + "parameterOrder": [ + "projectId", + "region" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + }, + "filter": { + "location": "query", + "description": "Optional. A filter constraining the clusters to list. Filters are case-sensitive and have the following syntax:field = value AND field = value ...where field is one of status.state, clusterName, or labels.[KEY], and [KEY] is a label key. value can be * to match all values. status.state can be one of the following: ACTIVE, INACTIVE, CREATING, RUNNING, ERROR, DELETING, or UPDATING. ACTIVE contains the CREATING, UPDATING, and RUNNING states. INACTIVE contains the DELETING and ERROR states. clusterName is the name of the cluster provided at creation time. Only the logical AND operator is supported; space-separated items are treated as having an implicit AND operator.Example filter:status.state = ACTIVE AND clusterName = mycluster AND labels.env = staging AND labels.starred = *", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "Optional. The standard List page token.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The standard List page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters", + "path": "v1beta2/projects/{projectId}/regions/{region}/clusters", + "id": "dataproc.projects.regions.clusters.list" + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any existing policy.", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:setIamPolicy", + "path": "v1beta2/{+resource}:setIamPolicy", + "id": "dataproc.projects.regions.clusters.setIamPolicy" + }, + "create": { + "path": "v1beta2/projects/{projectId}/regions/{region}/clusters", + "id": "dataproc.projects.regions.clusters.create", + "request": { + "$ref": "Cluster" + }, + "description": "Creates a cluster in a project.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "region" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string", + "location": "path" + }, + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters" + }, + "getIamPolicy": { + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "GET", + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/clusters/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/clusters/{clustersId}:getIamPolicy", + "path": "v1beta2/{+resource}:getIamPolicy", + "id": "dataproc.projects.regions.clusters.getIamPolicy", + "description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set." + }, + "get": { + "description": "Gets the resource representation for a cluster in a project.", + "response": { + "$ref": "Cluster" + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "clusterName": { + "location": "path", + "description": "Required. The cluster name.", + "required": true, + "type": "string" + }, + "projectId": { + "location": "path", + "description": "Required. The ID of the Google Cloud Platform project that the cluster belongs to.", + "required": true, + "type": "string" + }, + "region": { + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "id": "dataproc.projects.regions.clusters.get" + }, + "patch": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "projectId", + "region", + "clusterName" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "region": { + "location": "path", + "description": "Required. The Cloud Dataproc region in which to handle the request.", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "Required. Specifies the path, relative to \u003ccode\u003eCluster\u003c/code\u003e, of the field to update. For example, to change the number of workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be specified as \u003ccode\u003econfig.worker_config.num_instances\u003c/code\u003e, and the PATCH request body would specify the new value, as follows:\n{\n \"config\":{\n \"workerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\nSimilarly, to change the number of preemptible workers in a cluster to 5, the \u003ccode\u003eupdate_mask\u003c/code\u003e parameter would be \u003ccode\u003econfig.secondary_worker_config.num_instances\u003c/code\u003e, and the PATCH request body would be set as follows:\n{\n \"config\":{\n \"secondaryWorkerConfig\":{\n \"numInstances\":\"5\"\n }\n }\n}\n\u003cstrong\u003eNote:\u003c/strong\u003e currently only some fields can be updated: |Mask|Purpose| |labels|Updates labels| |config.worker_config.num_instances|Resize primary worker group| |config.secondary_worker_config.num_instances|Resize secondary worker group|", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "clusterName": { + "location": "path", + "description": "Required. The cluster name.", + "required": true, + "type": "string" + }, + "gracefulDecommissionTimeout": { + "location": "query", + "description": "Optional. Timeout for graceful YARN decomissioning. Graceful decommissioning allows removing nodes from the cluster without interrupting jobs in progress. Timeout specifies how long to wait for jobs in progress to finish before forcefully removing nodes (and potentially interrupting jobs). Default timeout is 0 (for forceful decommission), and the maximum allowed timeout is 1 day.Only supported on Dataproc image versions 1.2 and higher.", + "format": "google-duration", + "type": "string" + }, + "projectId": { + "description": "Required. The ID of the Google Cloud Platform project the cluster belongs to.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "path": "v1beta2/projects/{projectId}/regions/{region}/clusters/{clusterName}", + "id": "dataproc.projects.regions.clusters.patch", + "description": "Updates a cluster in a project.", + "request": { + "$ref": "Cluster" + } + } + } + }, + "workflowTemplates": { + "methods": { + "create": { + "request": { + "$ref": "WorkflowTemplate" + }, + "description": "Creates new workflow template.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "WorkflowTemplate" + }, + "parameters": { + "parent": { + "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates", + "id": "dataproc.projects.regions.workflowTemplates.create", + "path": "v1beta2/{+parent}/workflowTemplates" + }, + "instantiate": { + "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.", + "request": { + "$ref": "InstantiateWorkflowTemplateRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}:instantiate", + "path": "v1beta2/{+name}:instantiate", + "id": "dataproc.projects.regions.workflowTemplates.instantiate" + }, + "get": { + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.regions.workflowTemplates.get", + "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter.", + "response": { + "$ref": "WorkflowTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "version": { + "location": "query", + "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "location": "path" + } + } + }, + "update": { + "request": { + "$ref": "WorkflowTemplate" + }, + "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", + "response": { + "$ref": "WorkflowTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PUT", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "location": "path", + "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.regions.workflowTemplates.update" + }, + "delete": { + "description": "Deletes a workflow template. It does not cancel in-progress workflows.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/regions/[^/]+/workflowTemplates/[^/]+$", + "location": "path", + "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string" + }, + "version": { + "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates/{workflowTemplatesId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.regions.workflowTemplates.delete" + }, + "list": { + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/workflowTemplates", + "path": "v1beta2/{+parent}/workflowTemplates", + "id": "dataproc.projects.regions.workflowTemplates.list", + "description": "Lists workflows that match the specified filter in the request.", + "response": { + "$ref": "ListWorkflowTemplatesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/regions/[^/]+$", + "location": "path", + "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return in each response.", + "format": "int32", + "type": "integer", + "location": "query" + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}:cancel", + "path": "v1beta2/{+name}:cancel", + "id": "dataproc.projects.regions.operations.cancel" + }, + "delete": { + "path": "v1beta2/{+name}", + "id": "dataproc.projects.regions.operations.delete", + "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}" + }, + "list": { + "path": "v1beta2/{+name}", + "id": "dataproc.projects.regions.operations.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 allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as \"/v1/{name=users/*}/operations\" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations" + }, + "get": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/regions/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/regions/{regionsId}/operations/{operationsId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.regions.operations.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." + } + } + } + } + }, + "locations": { + "resources": { + "workflowTemplates": { + "methods": { + "update": { + "request": { + "$ref": "WorkflowTemplate" + }, + "description": "Updates (replaces) workflow template. The updated template must contain version that matches the current server version.", + "response": { + "$ref": "WorkflowTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PUT", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "location": "path", + "description": "Output only. The \"resource name\" of the template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.locations.workflowTemplates.update" + }, + "delete": { + "description": "Deletes a workflow template. It does not cancel in-progress workflows.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "version": { + "location": "query", + "description": "Optional. The version of workflow template to delete. If specified, will only delete the template if the current server version matches specified version.", + "format": "int32", + "type": "integer" + }, + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "location": "path", + "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.locations.workflowTemplates.delete" + }, + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListWorkflowTemplatesResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageToken": { + "location": "query", + "description": "Optional. The page token, returned by a previous call, to request the next page of results.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return in each response.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "location": "path", + "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates", + "id": "dataproc.projects.locations.workflowTemplates.list", + "path": "v1beta2/{+parent}/workflowTemplates", + "description": "Lists workflows that match the specified filter in the request." + }, + "create": { + "response": { + "$ref": "WorkflowTemplate" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "Required. The \"resource name\" of the region, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates", + "path": "v1beta2/{+parent}/workflowTemplates", + "id": "dataproc.projects.locations.workflowTemplates.create", + "request": { + "$ref": "WorkflowTemplate" + }, + "description": "Creates new workflow template." + }, + "instantiate": { + "request": { + "$ref": "InstantiateWorkflowTemplateRequest" + }, + "description": "Instantiates a template and begins execution.The returned Operation can be used to track execution of workflow by polling google.cloud.dataproc.v1beta2.OperationService.GetOperation. The Operation will complete when entire workflow is finished.The running workflow can be aborted via google.cloud.dataproc.v1beta2.OperationService.CancelOperation.The google.cloud.dataproc.v1beta2.Operation.metadata will always be google.cloud.dataproc.v1beta2.WorkflowMetadata.The google.cloud.dataproc.v1beta2.Operation.result will always be google.protobuf.Empty.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}:instantiate", + "id": "dataproc.projects.locations.workflowTemplates.instantiate", + "path": "v1beta2/{+name}:instantiate" + }, + "get": { + "response": { + "$ref": "WorkflowTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Required. The \"resource name\" of the workflow template, as described in https://cloud.google.com/apis/design/resource_names of the form projects/{project_id}/regions/{region}/workflowTemplates/{template_id}", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+/workflowTemplates/[^/]+$", + "location": "path" + }, + "version": { + "location": "query", + "description": "Optional. The version of workflow template to retrieve. Only previously instatiated versions can be retrieved.If unspecified, retrieves the current version.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta2/projects/{projectsId}/locations/{locationsId}/workflowTemplates/{workflowTemplatesId}", + "path": "v1beta2/{+name}", + "id": "dataproc.projects.locations.workflowTemplates.get", + "description": "Retrieves the latest workflow template.Can retrieve previously instantiated template by specifying optional version parameter." + } + } + } + } + } + } + } + }, + "parameters": { + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + } + }, + "version": "v1beta2", + "baseUrl": "https://dataproc.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Manages Hadoop-based clusters and jobs on Google Cloud Platform.", + "servicePath": "", + "basePath": "", + "revision": "20171212", + "documentationLink": "https://cloud.google.com/dataproc/", + "id": "dataproc:v1beta2", + "discoveryVersion": "v1" }
diff --git a/datastore/v1/datastore-api.json b/datastore/v1/datastore-api.json index 736f452..7676542 100644 --- a/datastore/v1/datastore-api.json +++ b/datastore/v1/datastore-api.json
@@ -1,25 +1,4 @@ { - "version": "v1", - "baseUrl": "https://datastore.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/datastore": { - "description": "View and manage your Google Cloud Datastore data" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "kind": "discovery#restDescription", - "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n", - "servicePath": "", - "rootUrl": "https://datastore.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "datastore", "batchPath": "batch", "id": "datastore:v1", "documentationLink": "https://cloud.google.com/datastore/", @@ -30,17 +9,220 @@ "version_module": true, "resources": { "projects": { + "methods": { + "allocateIds": { + "request": { + "$ref": "AllocateIdsRequest" + }, + "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.", + "httpMethod": "POST", + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "AllocateIdsResponse" + }, + "parameters": { + "projectId": { + "location": "path", + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1/projects/{projectId}:allocateIds", + "id": "datastore.projects.allocateIds", + "path": "v1/projects/{projectId}:allocateIds" + }, + "beginTransaction": { + "response": { + "$ref": "BeginTransactionResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "projectId": { + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}:beginTransaction", + "path": "v1/projects/{projectId}:beginTransaction", + "id": "datastore.projects.beginTransaction", + "description": "Begins a new transaction.", + "request": { + "$ref": "BeginTransactionRequest" + } + }, + "commit": { + "response": { + "$ref": "CommitResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1/projects/{projectId}:commit", + "path": "v1/projects/{projectId}:commit", + "id": "datastore.projects.commit", + "request": { + "$ref": "CommitRequest" + }, + "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities." + }, + "reserveIds": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "ReserveIdsResponse" + }, + "parameters": { + "projectId": { + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1/projects/{projectId}:reserveIds", + "id": "datastore.projects.reserveIds", + "path": "v1/projects/{projectId}:reserveIds", + "request": { + "$ref": "ReserveIdsRequest" + }, + "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore." + }, + "rollback": { + "request": { + "$ref": "RollbackRequest" + }, + "description": "Rolls back a transaction.", + "response": { + "$ref": "RollbackResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1/projects/{projectId}:rollback", + "path": "v1/projects/{projectId}:rollback", + "id": "datastore.projects.rollback" + }, + "runQuery": { + "description": "Queries for entities.", + "request": { + "$ref": "RunQueryRequest" + }, + "response": { + "$ref": "RunQueryResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "projectId": { + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectId}:runQuery", + "path": "v1/projects/{projectId}:runQuery", + "id": "datastore.projects.runQuery" + }, + "lookup": { + "request": { + "$ref": "LookupRequest" + }, + "description": "Looks up entities by key.", + "response": { + "$ref": "LookupResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "parameters": { + "projectId": { + "location": "path", + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1/projects/{projectId}:lookup", + "path": "v1/projects/{projectId}:lookup", + "id": "datastore.projects.lookup" + } + }, "resources": { "operations": { "methods": { "cancel": { - "httpMethod": "POST", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], "parameters": { "name": { "description": "The name of the operation resource to be cancelled.", @@ -50,16 +232,14 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel", - "id": "datastore.projects.operations.cancel", "path": "v1/{+name}:cancel", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." + "id": "datastore.projects.operations.cancel" }, "delete": { + "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", + "path": "v1/{+name}", + "id": "datastore.projects.operations.delete", "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "Empty" @@ -70,22 +250,23 @@ "httpMethod": "DELETE", "parameters": { "name": { - "pattern": "^projects/[^/]+/operations/[^/]+$", - "location": "path", "description": "The name of the operation resource to be deleted.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/operations/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", - "path": "v1/{+name}", - "id": "datastore.projects.operations.delete" + ] }, "list": { + "flatPath": "v1/projects/{projectsId}/operations", + "path": "v1/{+name}/operations", + "id": "datastore.projects.operations.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.", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, @@ -93,6 +274,10 @@ "name" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], "parameters": { "filter": { "description": "The standard list filter.", @@ -100,11 +285,11 @@ "location": "query" }, "name": { + "pattern": "^projects/[^/]+$", + "location": "path", "description": "The name of the operation's parent resource.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" + "type": "string" }, "pageToken": { "description": "The standard list page token.", @@ -117,15 +302,7 @@ "format": "int32", "type": "integer" } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1/projects/{projectsId}/operations", - "path": "v1/{+name}/operations", - "id": "datastore.projects.operations.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." + } }, "get": { "response": { @@ -155,219 +332,10 @@ } } } - }, - "methods": { - "allocateIds": { - "request": { - "$ref": "AllocateIdsRequest" - }, - "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.", - "response": { - "$ref": "AllocateIdsResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1/projects/{projectId}:allocateIds", - "path": "v1/projects/{projectId}:allocateIds", - "id": "datastore.projects.allocateIds" - }, - "beginTransaction": { - "description": "Begins a new transaction.", - "request": { - "$ref": "BeginTransactionRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "BeginTransactionResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "projectId": { - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectId}:beginTransaction", - "id": "datastore.projects.beginTransaction", - "path": "v1/projects/{projectId}:beginTransaction" - }, - "commit": { - "response": { - "$ref": "CommitResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1/projects/{projectId}:commit", - "path": "v1/projects/{projectId}:commit", - "id": "datastore.projects.commit", - "request": { - "$ref": "CommitRequest" - }, - "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities." - }, - "reserveIds": { - "path": "v1/projects/{projectId}:reserveIds", - "id": "datastore.projects.reserveIds", - "request": { - "$ref": "ReserveIdsRequest" - }, - "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.", - "response": { - "$ref": "ReserveIdsResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1/projects/{projectId}:reserveIds" - }, - "rollback": { - "description": "Rolls back a transaction.", - "request": { - "$ref": "RollbackRequest" - }, - "response": { - "$ref": "RollbackResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}:rollback", - "path": "v1/projects/{projectId}:rollback", - "id": "datastore.projects.rollback" - }, - "runQuery": { - "path": "v1/projects/{projectId}:runQuery", - "id": "datastore.projects.runQuery", - "description": "Queries for entities.", - "request": { - "$ref": "RunQueryRequest" - }, - "response": { - "$ref": "RunQueryResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectId}:runQuery" - }, - "lookup": { - "path": "v1/projects/{projectId}:lookup", - "id": "datastore.projects.lookup", - "request": { - "$ref": "LookupRequest" - }, - "description": "Looks up entities by key.", - "response": { - "$ref": "LookupResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "location": "path", - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1/projects/{projectId}:lookup" - } } } }, "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", @@ -378,12 +346,9 @@ "type": "string", "location": "query" }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "$.xgafv": { + "description": "V1 error format.", + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -392,17 +357,14 @@ "enum": [ "1", "2" - ], - "description": "V1 error format.", + ] + }, + "callback": { + "location": "query", + "description": "JSONP", "type": "string" }, "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -410,7 +372,13 @@ ], "location": "query", "description": "Data format for response.", - "default": "json" + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" }, "key": { "location": "query", @@ -418,9 +386,9 @@ "type": "string" }, "access_token": { - "location": "query", "description": "OAuth access token.", - "type": "string" + "type": "string", + "location": "query" }, "quotaUser": { "location": "query", @@ -433,45 +401,213 @@ "default": "true", "location": "query" }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" } }, "schemas": { - "RollbackResponse": { - "properties": {}, - "id": "RollbackResponse", - "description": "The response for Datastore.Rollback.\n(an empty message).", + "Status": { + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "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" + } + }, + "id": "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.", "type": "object" }, - "MutationResult": { + "PropertyOrder": { + "description": "The desired order for a specific property.", + "type": "object", "properties": { + "property": { + "$ref": "PropertyReference", + "description": "The property to order by." + }, + "direction": { + "enumDescriptions": [ + "Unspecified. This value must not be used.", + "Ascending.", + "Descending." + ], + "enum": [ + "DIRECTION_UNSPECIFIED", + "ASCENDING", + "DESCENDING" + ], + "description": "The direction to order by. Defaults to `ASCENDING`.", + "type": "string" + } + }, + "id": "PropertyOrder" + }, + "ReserveIdsResponse": { + "description": "The response for Datastore.ReserveIds.", + "type": "object", + "properties": {}, + "id": "ReserveIdsResponse" + }, + "GoogleDatastoreAdminV1beta1EntityFilter": { + "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", + "type": "object", + "properties": { + "kinds": { + "description": "If empty, then this represents all kinds.", + "type": "array", + "items": { + "type": "string" + } + }, + "namespaceIds": { + "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "GoogleDatastoreAdminV1beta1EntityFilter" + }, + "PropertyReference": { + "description": "A reference to a property relative to the kind expressions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", + "type": "string" + } + }, + "id": "PropertyReference" + }, + "Projection": { + "description": "A representation of a property in a projection.", + "type": "object", + "properties": { + "property": { + "$ref": "PropertyReference", + "description": "The property to project." + } + }, + "id": "Projection" + }, + "Mutation": { + "description": "A mutation to apply to an entity.", + "type": "object", + "properties": { + "insert": { + "$ref": "Entity", + "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete." + }, + "baseVersion": { + "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.", + "format": "int64", + "type": "string" + }, + "update": { + "$ref": "Entity", + "description": "The entity to update. The entity must already exist.\nMust have a complete key path." + }, + "upsert": { + "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete.", + "$ref": "Entity" + }, + "delete": { + "$ref": "Key", + "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only." + } + }, + "id": "Mutation" + }, + "ReadOptions": { + "description": "The options shared by read requests.", + "type": "object", + "properties": { + "readConsistency": { + "enumDescriptions": [ + "Unspecified. This value must not be used.", + "Strong consistency.", + "Eventual consistency." + ], + "enum": [ + "READ_CONSISTENCY_UNSPECIFIED", + "STRONG", + "EVENTUAL" + ], + "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.", + "type": "string" + }, + "transaction": { + "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", + "format": "byte", + "type": "string" + } + }, + "id": "ReadOptions" + }, + "RollbackResponse": { + "description": "The response for Datastore.Rollback.\n(an empty message).", + "type": "object", + "properties": {}, + "id": "RollbackResponse" + }, + "MutationResult": { + "description": "The result of applying a mutation.", + "type": "object", + "properties": { + "version": { + "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.", + "format": "int64", + "type": "string" + }, "conflictDetected": { "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.", "type": "boolean" }, "key": { - "description": "The automatically allocated key.\nSet only when the mutation allocated a key.", - "$ref": "Key" - }, - "version": { - "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.", - "format": "int64", - "type": "string" + "$ref": "Key", + "description": "The automatically allocated key.\nSet only when the mutation allocated a key." } }, - "id": "MutationResult", - "description": "The result of applying a mutation.", - "type": "object" + "id": "MutationResult" }, "RollbackRequest": { + "description": "The request for Datastore.Rollback.", + "type": "object", "properties": { "transaction": { "description": "The transaction identifier, returned by a call to\nDatastore.BeginTransaction.", @@ -479,38 +615,38 @@ "type": "string" } }, - "id": "RollbackRequest", - "description": "The request for Datastore.Rollback.", - "type": "object" + "id": "RollbackRequest" }, "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { "description": "Metadata for ExportEntities operations.", "type": "object", "properties": { - "progressEntities": { - "$ref": "GoogleDatastoreAdminV1beta1Progress", - "description": "An estimate of the number of entities processed." - }, "common": { - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", - "description": "Metadata common to all Datastore Admin operations." + "description": "Metadata common to all Datastore Admin operations.", + "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" }, "progressBytes": { - "description": "An estimate of the number of bytes processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" + "$ref": "GoogleDatastoreAdminV1beta1Progress", + "description": "An estimate of the number of bytes processed." }, "entityFilter": { - "description": "Description of which entities are being exported.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", + "description": "Description of which entities are being exported." }, "outputUrlPrefix": { "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", "type": "string" + }, + "progressEntities": { + "$ref": "GoogleDatastoreAdminV1beta1Progress", + "description": "An estimate of the number of entities processed." } }, "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata" }, "CompositeFilter": { + "description": "A filter that merges multiple other filters using the given operator.", + "type": "object", "properties": { "filters": { "description": "The list of filters to combine.\nMust contain at least one filter.", @@ -520,6 +656,8 @@ } }, "op": { + "description": "The operator for combining multiple filters.", + "type": "string", "enumDescriptions": [ "Unspecified. This value must not be used.", "The results are required to satisfy each of the combined filters." @@ -527,16 +665,14 @@ "enum": [ "OPERATOR_UNSPECIFIED", "AND" - ], - "description": "The operator for combining multiple filters.", - "type": "string" + ] } }, - "id": "CompositeFilter", - "description": "A filter that merges multiple other filters using the given operator.", - "type": "object" + "id": "CompositeFilter" }, "AllocateIdsResponse": { + "description": "The response for Datastore.AllocateIds.", + "type": "object", "properties": { "keys": { "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.", @@ -546,12 +682,14 @@ } } }, - "id": "AllocateIdsResponse", - "description": "The response for Datastore.AllocateIds.", - "type": "object" + "id": "AllocateIdsResponse" }, "GoogleLongrunningOperation": { "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.", @@ -565,8 +703,8 @@ "type": "string" }, "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { @@ -575,10 +713,6 @@ }, "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", "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" } }, "id": "GoogleLongrunningOperation", @@ -590,14 +724,23 @@ "type": "object", "properties": { "value": { - "description": "The value to compare the property to.", - "$ref": "Value" + "$ref": "Value", + "description": "The value to compare the property to." }, "property": { - "description": "The property to filter by.", - "$ref": "PropertyReference" + "$ref": "PropertyReference", + "description": "The property to filter by." }, "op": { + "enumDescriptions": [ + "Unspecified. This value must not be used.", + "Less than.", + "Less than or equal.", + "Greater than.", + "Greater than or equal.", + "Equal.", + "Has ancestor." + ], "enum": [ "OPERATOR_UNSPECIFIED", "LESS_THAN", @@ -608,16 +751,7 @@ "HAS_ANCESTOR" ], "description": "The operator to filter by.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Less than.", - "Less than or equal.", - "Greater than.", - "Greater than or equal.", - "Equal.", - "Has ancestor." - ] + "type": "string" } }, "id": "PropertyFilter" @@ -658,43 +792,29 @@ }, "Entity": { "properties": { - "key": { - "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.", - "$ref": "Key" - }, "properties": { + "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.", + "type": "object", "additionalProperties": { "$ref": "Value" - }, - "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.", - "type": "object" + } + }, + "key": { + "$ref": "Key", + "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key." } }, "id": "Entity", "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.", "type": "object" }, - "GoogleDatastoreAdminV1beta1Progress": { - "description": "Measures the progress of a particular metric.", - "type": "object", + "QueryResultBatch": { "properties": { - "workEstimated": { - "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", + "snapshotVersion": { + "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.", "format": "int64", "type": "string" }, - "workCompleted": { - "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.", - "format": "int64", - "type": "string" - } - }, - "id": "GoogleDatastoreAdminV1beta1Progress" - }, - "QueryResultBatch": { - "description": "A batch of results produced by a query.", - "type": "object", - "properties": { "skippedCursor": { "description": "A cursor that points to the position after the last skipped result.\nWill be set when `skipped_results` != 0.", "format": "byte", @@ -706,12 +826,6 @@ "type": "integer" }, "entityResultType": { - "enumDescriptions": [ - "Unspecified. This value is never used.", - "The key and properties.", - "A projected subset of properties. The entity may have no key.", - "Only the key." - ], "enum": [ "RESULT_TYPE_UNSPECIFIED", "FULL", @@ -719,7 +833,13 @@ "KEY_ONLY" ], "description": "The result type for every entity in `entity_results`.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified. This value is never used.", + "The key and properties.", + "A projected subset of properties. The entity may have no key.", + "Only the key." + ] }, "entityResults": { "description": "The results for this batch.", @@ -728,7 +848,19 @@ "$ref": "EntityResult" } }, + "endCursor": { + "description": "A cursor that points to the position after the last result in the batch.", + "format": "byte", + "type": "string" + }, "moreResults": { + "enumDescriptions": [ + "Unspecified. This value is never used.", + "There may be additional batches to fetch from this query.", + "The query is finished, but there may be more results after the limit.", + "The query is finished, but there may be more results after the end\ncursor.", + "The query is finished, and there are no more results." + ], "enum": [ "MORE_RESULTS_TYPE_UNSPECIFIED", "NOT_FINISHED", @@ -737,36 +869,34 @@ "NO_MORE_RESULTS" ], "description": "The state of the query after the current batch.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value is never used.", - "There may be additional batches to fetch from this query.", - "The query is finished, but there may be more results after the limit.", - "The query is finished, but there may be more results after the end\ncursor.", - "The query is finished, and there are no more results." - ] - }, - "endCursor": { - "description": "A cursor that points to the position after the last result in the batch.", - "format": "byte", + "type": "string" + } + }, + "id": "QueryResultBatch", + "description": "A batch of results produced by a query.", + "type": "object" + }, + "GoogleDatastoreAdminV1beta1Progress": { + "description": "Measures the progress of a particular metric.", + "type": "object", + "properties": { + "workCompleted": { + "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.", + "format": "int64", "type": "string" }, - "snapshotVersion": { - "description": "The version number of the snapshot this batch was returned from.\nThis applies to the range of results from the query's `start_cursor` (or\nthe beginning of the query if no cursor was given) to this batch's\n`end_cursor` (not the query's `end_cursor`).\n\nIn a single transaction, subsequent query result batches for the same query\ncan have a greater snapshot version number. Each batch's snapshot version\nis valid for all preceding batches.\nThe value will be zero for eventually consistent queries.", + "workEstimated": { + "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", "format": "int64", "type": "string" } }, - "id": "QueryResultBatch" + "id": "GoogleDatastoreAdminV1beta1Progress" }, "PathElement": { "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", "type": "object", "properties": { - "name": { - "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", - "type": "string" - }, "kind": { "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", "type": "string" @@ -775,6 +905,10 @@ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", "format": "int64", "type": "string" + }, + "name": { + "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", + "type": "string" } }, "id": "PathElement" @@ -787,8 +921,8 @@ "type": "string" }, "value": { - "description": "A value parameter.", - "$ref": "Value" + "$ref": "Value", + "description": "A value parameter." } }, "id": "GqlQueryParameter", @@ -796,8 +930,6 @@ "type": "object" }, "GoogleLongrunningListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", "properties": { "nextPageToken": { "description": "The standard List next-page token.", @@ -811,9 +943,13 @@ } } }, - "id": "GoogleLongrunningListOperationsResponse" + "id": "GoogleLongrunningListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object" }, "BeginTransactionResponse": { + "description": "The response for Datastore.BeginTransaction.", + "type": "object", "properties": { "transaction": { "description": "The transaction identifier (always present).", @@ -821,9 +957,7 @@ "type": "string" } }, - "id": "BeginTransactionResponse", - "description": "The response for Datastore.BeginTransaction.", - "type": "object" + "id": "BeginTransactionResponse" }, "LookupResponse": { "description": "The response for Datastore.Lookup.", @@ -857,13 +991,13 @@ "description": "The response for Datastore.RunQuery.", "type": "object", "properties": { + "query": { + "$ref": "Query", + "description": "The parsed form of the `GqlQuery` from the request, if it was set." + }, "batch": { "description": "A batch of query results (always present).", "$ref": "QueryResultBatch" - }, - "query": { - "description": "The parsed form of the `GqlQuery` from the request, if it was set.", - "$ref": "Query" } }, "id": "RunQueryResponse" @@ -883,36 +1017,33 @@ "id": "AllocateIdsRequest" }, "BeginTransactionRequest": { - "description": "The request for Datastore.BeginTransaction.", - "type": "object", "properties": { "transactionOptions": { "$ref": "TransactionOptions", "description": "Options for a new transaction." } }, - "id": "BeginTransactionRequest" + "id": "BeginTransactionRequest", + "description": "The request for Datastore.BeginTransaction.", + "type": "object" }, "CommitRequest": { + "description": "The request for Datastore.Commit.", + "type": "object", "properties": { - "transaction": { - "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", - "format": "byte", - "type": "string" - }, "mode": { - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).", - "Non-transactional: The mutations may not apply as all or none." - ], "enum": [ "MODE_UNSPECIFIED", "TRANSACTIONAL", "NON_TRANSACTIONAL" ], "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified. This value must not be used.", + "Transactional: The mutations are either all applied, or none are applied.\nLearn about transactions [here](https://cloud.google.com/datastore/docs/concepts/transactions).", + "Non-transactional: The mutations may not apply as all or none." + ] }, "mutations": { "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.", @@ -920,11 +1051,14 @@ "items": { "$ref": "Mutation" } + }, + "transaction": { + "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", + "format": "byte", + "type": "string" } }, - "id": "CommitRequest", - "description": "The request for Datastore.Commit.", - "type": "object" + "id": "CommitRequest" }, "KindExpression": { "description": "A representation of a kind.", @@ -973,6 +1107,8 @@ "type": "object" }, "GoogleDatastoreAdminV1beta1CommonMetadata": { + "description": "Metadata common to all Datastore Admin operations.", + "type": "object", "properties": { "labels": { "additionalProperties": { @@ -1001,6 +1137,16 @@ "type": "string" }, "state": { + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation." + ], "enum": [ "STATE_UNSPECIFIED", "INITIALIZING", @@ -1012,17 +1158,7 @@ "CANCELLED" ], "description": "The current state of the Operation.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Request is being prepared for processing.", - "Request is actively being processed.", - "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.", - "Request has been processed and is in its finalization stage.", - "Request has completed successfully.", - "Request has finished being processed, but encountered an error.", - "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation." - ] + "type": "string" }, "startTime": { "description": "The time that work began on the operation.", @@ -1030,9 +1166,7 @@ "type": "string" } }, - "id": "GoogleDatastoreAdminV1beta1CommonMetadata", - "description": "Metadata common to all Datastore Admin operations.", - "type": "object" + "id": "GoogleDatastoreAdminV1beta1CommonMetadata" }, "ArrayValue": { "description": "An array value.", @@ -1060,8 +1194,6 @@ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse" }, "GqlQuery": { - "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", - "type": "object", "properties": { "queryString": { "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", @@ -1086,9 +1218,13 @@ } } }, - "id": "GqlQuery" + "id": "GqlQuery", + "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", + "type": "object" }, "Filter": { + "description": "A holder for any type of filter.", + "type": "object", "properties": { "compositeFilter": { "$ref": "CompositeFilter", @@ -1099,63 +1235,57 @@ "$ref": "PropertyFilter" } }, - "id": "Filter", - "description": "A holder for any type of filter.", - "type": "object" + "id": "Filter" }, "RunQueryRequest": { + "description": "The request for Datastore.RunQuery.", + "type": "object", "properties": { "readOptions": { - "$ref": "ReadOptions", - "description": "The options for this query." + "description": "The options for this query.", + "$ref": "ReadOptions" }, "query": { "description": "The query to run.", "$ref": "Query" }, "partitionId": { - "$ref": "PartitionId", - "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID." + "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID.", + "$ref": "PartitionId" }, "gqlQuery": { "description": "The GQL query to run.", "$ref": "GqlQuery" } }, - "id": "RunQueryRequest", - "description": "The request for Datastore.RunQuery.", - "type": "object" + "id": "RunQueryRequest" }, "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" + "type": "object", + "properties": {}, + "id": "Empty" }, "TransactionOptions": { + "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.", + "type": "object", "properties": { "readWrite": { "description": "The transaction should allow both reads and writes.", "$ref": "ReadWrite" }, "readOnly": { - "$ref": "ReadOnly", - "description": "The transaction should only allow reads." + "description": "The transaction should only allow reads.", + "$ref": "ReadOnly" } }, - "id": "TransactionOptions", - "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.", - "type": "object" + "id": "TransactionOptions" }, "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { "properties": { - "progressEntities": { - "$ref": "GoogleDatastoreAdminV1beta1Progress", - "description": "An estimate of the number of entities processed." - }, "common": { - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", - "description": "Metadata common to all Datastore Admin operations." + "description": "Metadata common to all Datastore Admin operations.", + "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" }, "progressBytes": { "$ref": "GoogleDatastoreAdminV1beta1Progress", @@ -1166,8 +1296,12 @@ "type": "string" }, "entityFilter": { - "description": "Description of which entities are being imported.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", + "description": "Description of which entities are being imported." + }, + "progressEntities": { + "$ref": "GoogleDatastoreAdminV1beta1Progress", + "description": "An estimate of the number of entities processed." } }, "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", @@ -1175,21 +1309,23 @@ "type": "object" }, "Query": { + "description": "A query for entities.", + "type": "object", "properties": { "endCursor": { "description": "An ending point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to limit the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).", "format": "byte", "type": "string" }, - "filter": { - "description": "The filter to apply.", - "$ref": "Filter" - }, "limit": { "description": "The maximum number of results to return. Applies after all other\nconstraints. Optional.\nUnspecified is interpreted as no limit.\nMust be \u003e= 0 if specified.", "format": "int32", "type": "integer" }, + "filter": { + "$ref": "Filter", + "description": "The filter to apply." + }, "startCursor": { "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).", "format": "byte", @@ -1229,9 +1365,7 @@ } } }, - "id": "Query", - "description": "A query for entities.", - "type": "object" + "id": "Query" }, "ReadOnly": { "description": "Options specific to read-only transactions.", @@ -1240,7 +1374,13 @@ "id": "ReadOnly" }, "EntityResult": { + "description": "The result of fetching an entity from Datastore.", + "type": "object", "properties": { + "entity": { + "description": "The resulting entity.", + "$ref": "Entity" + }, "cursor": { "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.", "format": "byte", @@ -1250,38 +1390,30 @@ "description": "The version of the entity, a strictly positive number that monotonically\nincreases with changes to the entity.\n\nThis field is set for `FULL` entity\nresults.\n\nFor missing entities in `LookupResponse`, this\nis the version of the snapshot that was used to look up the entity, and it\nis always set except for eventually consistent reads.", "format": "int64", "type": "string" - }, - "entity": { - "description": "The resulting entity.", - "$ref": "Entity" } }, - "id": "EntityResult", - "description": "The result of fetching an entity from Datastore.", - "type": "object" + "id": "EntityResult" }, "Value": { - "description": "A message that can hold any of the supported value types and associated\nmetadata.", - "type": "object", "properties": { "timestampValue": { "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.", "format": "google-datetime", "type": "string" }, - "booleanValue": { - "description": "A boolean value.", - "type": "boolean" - }, "nullValue": { + "enumDescriptions": [ + "Null value." + ], "enum": [ "NULL_VALUE" ], "description": "A null value.", - "type": "string", - "enumDescriptions": [ - "Null value." - ] + "type": "string" + }, + "booleanValue": { + "description": "A boolean value.", + "type": "boolean" }, "blobValue": { "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.", @@ -1298,22 +1430,22 @@ "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`." }, "entityValue": { - "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.", - "$ref": "Entity" + "$ref": "Entity", + "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key." }, "geoPointValue": { - "description": "A geo point value representing a point on the surface of Earth.", - "$ref": "LatLng" - }, - "keyValue": { - "description": "A key value.", - "$ref": "Key" + "$ref": "LatLng", + "description": "A geo point value representing a point on the surface of Earth." }, "integerValue": { "description": "An integer value.", "format": "int64", "type": "string" }, + "keyValue": { + "description": "A key value.", + "$ref": "Key" + }, "stringValue": { "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.", "type": "string" @@ -1328,7 +1460,9 @@ "type": "number" } }, - "id": "Value" + "id": "Value", + "description": "A message that can hold any of the supported value types and associated\nmetadata.", + "type": "object" }, "ReadWrite": { "description": "Options specific to read / write transactions.", @@ -1347,8 +1481,8 @@ "type": "object", "properties": { "readOptions": { - "$ref": "ReadOptions", - "description": "The options for this lookup request." + "description": "The options for this lookup request.", + "$ref": "ReadOptions" }, "keys": { "description": "Keys of entities to look up.", @@ -1361,6 +1495,8 @@ "id": "LookupRequest" }, "ReserveIdsRequest": { + "description": "The request for Datastore.ReserveIds.", + "type": "object", "properties": { "keys": { "description": "A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.", @@ -1374,169 +1510,33 @@ "type": "string" } }, - "id": "ReserveIdsRequest", - "description": "The request for Datastore.ReserveIds.", - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "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" - } - }, - "id": "Status" - }, - "PropertyOrder": { - "description": "The desired order for a specific property.", - "type": "object", - "properties": { - "property": { - "description": "The property to order by.", - "$ref": "PropertyReference" - }, - "direction": { - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Ascending.", - "Descending." - ], - "enum": [ - "DIRECTION_UNSPECIFIED", - "ASCENDING", - "DESCENDING" - ], - "description": "The direction to order by. Defaults to `ASCENDING`.", - "type": "string" - } - }, - "id": "PropertyOrder" - }, - "ReserveIdsResponse": { - "properties": {}, - "id": "ReserveIdsResponse", - "description": "The response for Datastore.ReserveIds.", - "type": "object" - }, - "GoogleDatastoreAdminV1beta1EntityFilter": { - "properties": { - "namespaceIds": { - "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", - "type": "array", - "items": { - "type": "string" - } - }, - "kinds": { - "description": "If empty, then this represents all kinds.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "GoogleDatastoreAdminV1beta1EntityFilter", - "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", - "type": "object" - }, - "PropertyReference": { - "properties": { - "name": { - "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", - "type": "string" - } - }, - "id": "PropertyReference", - "description": "A reference to a property relative to the kind expressions.", - "type": "object" - }, - "Projection": { - "description": "A representation of a property in a projection.", - "type": "object", - "properties": { - "property": { - "$ref": "PropertyReference", - "description": "The property to project." - } - }, - "id": "Projection" - }, - "Mutation": { - "description": "A mutation to apply to an entity.", - "type": "object", - "properties": { - "update": { - "description": "The entity to update. The entity must already exist.\nMust have a complete key path.", - "$ref": "Entity" - }, - "upsert": { - "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete.", - "$ref": "Entity" - }, - "delete": { - "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.", - "$ref": "Key" - }, - "insert": { - "description": "The entity to insert. The entity must not already exist.\nThe entity key's final path element may be incomplete.", - "$ref": "Entity" - }, - "baseVersion": { - "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.", - "format": "int64", - "type": "string" - } - }, - "id": "Mutation" - }, - "ReadOptions": { - "properties": { - "readConsistency": { - "enum": [ - "READ_CONSISTENCY_UNSPECIFIED", - "STRONG", - "EVENTUAL" - ], - "description": "The non-transactional read consistency to use.\nCannot be set to `STRONG` for global queries.", - "type": "string", - "enumDescriptions": [ - "Unspecified. This value must not be used.", - "Strong consistency.", - "Eventual consistency." - ] - }, - "transaction": { - "description": "The identifier of the transaction in which to read. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", - "format": "byte", - "type": "string" - } - }, - "id": "ReadOptions", - "description": "The options shared by read requests.", - "type": "object" + "id": "ReserveIdsRequest" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest" + "protocol": "rest", + "version": "v1", + "baseUrl": "https://datastore.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/datastore": { + "description": "View and manage your Google Cloud Datastore data" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n", + "servicePath": "", + "rootUrl": "https://datastore.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "datastore" }
diff --git a/datastore/v1beta1/datastore-api.json b/datastore/v1beta1/datastore-api.json index 0b5d1b7..4218bd8 100644 --- a/datastore/v1beta1/datastore-api.json +++ b/datastore/v1beta1/datastore-api.json
@@ -1,18 +1,69 @@ { + "version": "v1beta1", + "baseUrl": "https://datastore.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/datastore": { + "description": "View and manage your Google Cloud Datastore data" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n", + "servicePath": "", + "rootUrl": "https://datastore.googleapis.com/", + "basePath": "", "ownerDomain": "google.com", "name": "datastore", "batchPath": "batch", - "revision": "20171212", - "documentationLink": "https://cloud.google.com/datastore/", "id": "datastore:v1beta1", + "documentationLink": "https://cloud.google.com/datastore/", + "revision": "20171212", "title": "Google Cloud Datastore API", - "discoveryVersion": "v1", "ownerName": "Google", + "discoveryVersion": "v1", "version_module": true, "resources": { "projects": { "methods": { "export": { + "description": "Exports a copy of all or a subset of entities from Google Cloud Datastore\nto another storage system, such as Google Cloud Storage. Recent updates to\nentities may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage.", + "request": { + "$ref": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest" + }, + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "projectId": { + "description": "Project ID against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectId}:export", + "path": "v1beta1/projects/{projectId}:export", + "id": "datastore.projects.export" + }, + "import": { + "request": { + "$ref": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest" + }, + "description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore.", "response": { "$ref": "GoogleLongrunningOperation" }, @@ -32,41 +83,9 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datastore" ], - "flatPath": "v1beta1/projects/{projectId}:export", - "path": "v1beta1/projects/{projectId}:export", - "id": "datastore.projects.export", - "request": { - "$ref": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest" - }, - "description": "Exports a copy of all or a subset of entities from Google Cloud Datastore\nto another storage system, such as Google Cloud Storage. Recent updates to\nentities may not be reflected in the export. The export occurs in the\nbackground and its progress can be monitored and managed via the\nOperation resource that is created. The output of an export may only be\nused once the associated operation is done. If an export operation is\ncancelled before completion it may leave partial data behind in Google\nCloud Storage." - }, - "import": { - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "projectId": { - "location": "path", - "description": "Project ID against which to make the request.", - "required": true, - "type": "string" - } - }, "flatPath": "v1beta1/projects/{projectId}:import", "path": "v1beta1/projects/{projectId}:import", - "id": "datastore.projects.import", - "description": "Imports entities into Google Cloud Datastore. Existing entities with the\nsame key are overwritten. The import occurs in the background and its\nprogress can be monitored and managed via the Operation resource that is\ncreated. If an ImportEntities operation is cancelled, it is possible\nthat a subset of the data has already been imported to Cloud Datastore.", - "request": { - "$ref": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest" - } + "id": "datastore.projects.import" } } } @@ -78,15 +97,15 @@ "type": "string" }, "prettyPrint": { - "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", @@ -107,13 +126,11 @@ "type": "string" }, "callback": { - "location": "query", "description": "JSONP", - "type": "string" + "type": "string", + "location": "query" }, "alt": { - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -125,7 +142,9 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], - "location": "query" + "location": "query", + "description": "Data format for response.", + "default": "json" }, "access_token": { "description": "OAuth access token.", @@ -138,9 +157,9 @@ "type": "string" }, "quotaUser": { + "location": "query", "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.", - "type": "string", - "location": "query" + "type": "string" }, "pp": { "description": "Pretty-print response.", @@ -154,12 +173,221 @@ "type": "string" }, "bearer_token": { + "location": "query", "description": "OAuth bearer token.", - "type": "string", - "location": "query" + "type": "string" } }, "schemas": { + "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 is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + } + }, + "id": "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.", + "type": "object" + }, + "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { + "description": "Metadata for ExportEntities operations.", + "type": "object", + "properties": { + "common": { + "description": "Metadata common to all Datastore Admin operations.", + "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" + }, + "progressBytes": { + "description": "An estimate of the number of bytes processed.", + "$ref": "GoogleDatastoreAdminV1beta1Progress" + }, + "entityFilter": { + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", + "description": "Description of which entities are being exported." + }, + "outputUrlPrefix": { + "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", + "type": "string" + }, + "progressEntities": { + "description": "An estimate of the number of entities processed.", + "$ref": "GoogleDatastoreAdminV1beta1Progress" + } + }, + "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata" + }, + "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": { + "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", + "type": "object", + "properties": { + "entityFilter": { + "description": "Description of what data from the project is included in the export.", + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" + }, + "outputUrlPrefix": { + "description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Client-assigned labels.", + "type": "object" + } + }, + "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest" + }, + "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { + "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", + "type": "object", + "properties": { + "outputUrl": { + "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.", + "type": "string" + } + }, + "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse" + }, + "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": { + "properties": { + "inputUrl": { + "description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", + "type": "string" + }, + "entityFilter": { + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", + "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Client-assigned labels.", + "type": "object" + } + }, + "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest", + "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.", + "type": "object" + }, + "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { + "properties": { + "common": { + "description": "Metadata common to all Datastore Admin operations.", + "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" + }, + "progressBytes": { + "description": "An estimate of the number of bytes processed.", + "$ref": "GoogleDatastoreAdminV1beta1Progress" + }, + "inputUrl": { + "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.", + "type": "string" + }, + "entityFilter": { + "description": "Description of which entities are being imported.", + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" + }, + "progressEntities": { + "$ref": "GoogleDatastoreAdminV1beta1Progress", + "description": "An estimate of the number of entities processed." + } + }, + "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", + "description": "Metadata for ImportEntities operations.", + "type": "object" + }, + "GoogleDatastoreAdminV1beta1Progress": { + "description": "Measures the progress of a particular metric.", + "type": "object", + "properties": { + "workCompleted": { + "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.", + "format": "int64", + "type": "string" + }, + "workEstimated": { + "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", + "format": "int64", + "type": "string" + } + }, + "id": "GoogleDatastoreAdminV1beta1Progress" + }, + "GoogleLongrunningOperation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "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.", + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object" + } + }, + "id": "GoogleLongrunningOperation" + }, + "GoogleDatastoreAdminV1beta1EntityFilter": { + "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", + "type": "object", + "properties": { + "namespaceIds": { + "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", + "type": "array", + "items": { + "type": "string" + } + }, + "kinds": { + "description": "If empty, then this represents all kinds.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "GoogleDatastoreAdminV1beta1EntityFilter" + }, "GoogleDatastoreAdminV1beta1CommonMetadata": { "properties": { "labels": { @@ -221,239 +449,11 @@ "id": "GoogleDatastoreAdminV1beta1CommonMetadata", "description": "Metadata common to all Datastore Admin operations.", "type": "object" - }, - "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 is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - } - }, - "id": "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.", - "type": "object" - }, - "GoogleDatastoreAdminV1beta1ExportEntitiesRequest": { - "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Client-assigned labels.", - "type": "object" - }, - "entityFilter": { - "description": "Description of what data from the project is included in the export.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" - }, - "outputUrlPrefix": { - "description": "Location for the export metadata and data files.\n\nThe full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So output_url_prefix should be of the\nform: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the\nname of the Cloud Storage bucket and `NAMESPACE_PATH` is an optional Cloud\nStorage namespace path (this is not a Cloud Datastore namespace). For more\ninformation about Cloud Storage namespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nThe resulting files will be nested deeper than the specified URL prefix.\nThe final output URL will be provided in the\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield. That value should be used for subsequent ImportEntities operations.\n\nBy nesting the data files deeper, the same Cloud Storage bucket can be used\nin multiple ExportEntities operations without conflict.", - "type": "string" - } - }, - "id": "GoogleDatastoreAdminV1beta1ExportEntitiesRequest", - "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", - "type": "object" - }, - "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" - }, - "progressBytes": { - "$ref": "GoogleDatastoreAdminV1beta1Progress", - "description": "An estimate of the number of bytes processed." - }, - "entityFilter": { - "description": "Description of which entities are being exported.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" - }, - "outputUrlPrefix": { - "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", - "type": "string" - }, - "progressEntities": { - "$ref": "GoogleDatastoreAdminV1beta1Progress", - "description": "An estimate of the number of entities processed." - } - }, - "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata", - "description": "Metadata for ExportEntities operations.", - "type": "object" - }, - "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { - "properties": { - "outputUrl": { - "description": "Location of the output metadata file. This can be used to begin an import\ninto Cloud Datastore (this project or another project). See\ngoogle.datastore.admin.v1beta1.ImportEntitiesRequest.input_url.\nOnly present if the operation completed successfully.", - "type": "string" - } - }, - "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse", - "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", - "type": "object" - }, - "GoogleDatastoreAdminV1beta1ImportEntitiesRequest": { - "description": "The request for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ImportEntities.", - "type": "object", - "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Client-assigned labels.", - "type": "object" - }, - "inputUrl": { - "description": "The full resource URL of the external storage location. Currently, only\nGoogle Cloud Storage is supported. So input_url should be of the form:\n`gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where\n`BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is\nan optional Cloud Storage namespace path (this is not a Cloud Datastore\nnamespace), and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written\nby the ExportEntities operation. For more information about Cloud Storage\nnamespace paths, see\n[Object name\nconsiderations](https://cloud.google.com/storage/docs/naming#object-considerations).\n\nFor more information, see\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", - "type": "string" - }, - "entityFilter": { - "description": "Optionally specify which kinds/namespaces are to be imported. If provided,\nthe list must be a subset of the EntityFilter used in creating the export,\notherwise a FAILED_PRECONDITION error will be returned. If no filter is\nspecified then all entities from the export are imported.", - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" - } - }, - "id": "GoogleDatastoreAdminV1beta1ImportEntitiesRequest" - }, - "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { - "description": "Metadata for ImportEntities operations.", - "type": "object", - "properties": { - "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" - }, - "progressBytes": { - "description": "An estimate of the number of bytes processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" - }, - "inputUrl": { - "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.", - "type": "string" - }, - "entityFilter": { - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", - "description": "Description of which entities are being imported." - }, - "progressEntities": { - "$ref": "GoogleDatastoreAdminV1beta1Progress", - "description": "An estimate of the number of entities processed." - } - }, - "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata" - }, - "GoogleDatastoreAdminV1beta1Progress": { - "properties": { - "workCompleted": { - "description": "The amount of work that has been completed. Note that this may be greater\nthan work_estimated.", - "format": "int64", - "type": "string" - }, - "workEstimated": { - "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", - "format": "int64", - "type": "string" - } - }, - "id": "GoogleDatastoreAdminV1beta1Progress", - "description": "Measures the progress of a particular metric.", - "type": "object" - }, - "GoogleDatastoreAdminV1beta1EntityFilter": { - "properties": { - "namespaceIds": { - "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", - "type": "array", - "items": { - "type": "string" - } - }, - "kinds": { - "description": "If empty, then this represents all kinds.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "GoogleDatastoreAdminV1beta1EntityFilter", - "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", - "type": "object" - }, - "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "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.", - "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" - } - }, - "id": "GoogleLongrunningOperation" } }, "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", - "version": "v1beta1", - "baseUrl": "https://datastore.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/datastore": { - "description": "View and manage your Google Cloud Datastore data" - } - } - } - }, - "servicePath": "", - "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n", - "kind": "discovery#restDescription", - "rootUrl": "https://datastore.googleapis.com/", - "basePath": "" + "protocol": "rest" }
diff --git a/datastore/v1beta3/datastore-api.json b/datastore/v1beta3/datastore-api.json index 0edf830..acb7d45 100644 --- a/datastore/v1beta3/datastore-api.json +++ b/datastore/v1beta3/datastore-api.json
@@ -1,23 +1,42 @@ { + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/datastore": { + "description": "View and manage your Google Cloud Datastore data" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n", + "servicePath": "", + "rootUrl": "https://datastore.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "datastore", + "batchPath": "batch", + "revision": "20171212", + "documentationLink": "https://cloud.google.com/datastore/", + "id": "datastore:v1beta3", + "title": "Google Cloud Datastore API", + "ownerName": "Google", + "discoveryVersion": "v1", + "version_module": true, "resources": { "projects": { "methods": { - "allocateIds": { - "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.", - "request": { - "$ref": "AllocateIdsRequest" - }, + "beginTransaction": { "response": { - "$ref": "AllocateIdsResponse" + "$ref": "BeginTransactionResponse" }, "parameterOrder": [ "projectId" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], "parameters": { "projectId": { "description": "The ID of the project against which to make the request.", @@ -26,13 +45,25 @@ "location": "path" } }, - "flatPath": "v1beta3/projects/{projectId}:allocateIds", - "path": "v1beta3/projects/{projectId}:allocateIds", - "id": "datastore.projects.allocateIds" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta3/projects/{projectId}:beginTransaction", + "path": "v1beta3/projects/{projectId}:beginTransaction", + "id": "datastore.projects.beginTransaction", + "request": { + "$ref": "BeginTransactionRequest" + }, + "description": "Begins a new transaction." }, - "beginTransaction": { + "commit": { + "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities.", + "request": { + "$ref": "CommitRequest" + }, "response": { - "$ref": "BeginTransactionResponse" + "$ref": "CommitResponse" }, "parameterOrder": [ "projectId" @@ -50,50 +81,22 @@ "type": "string" } }, - "flatPath": "v1beta3/projects/{projectId}:beginTransaction", - "path": "v1beta3/projects/{projectId}:beginTransaction", - "id": "datastore.projects.beginTransaction", - "description": "Begins a new transaction.", - "request": { - "$ref": "BeginTransactionRequest" - } - }, - "commit": { - "response": { - "$ref": "CommitResponse" - }, - "parameterOrder": [ - "projectId" - ], - "httpMethod": "POST", - "parameters": { - "projectId": { - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], "flatPath": "v1beta3/projects/{projectId}:commit", "path": "v1beta3/projects/{projectId}:commit", - "id": "datastore.projects.commit", - "request": { - "$ref": "CommitRequest" - }, - "description": "Commits a transaction, optionally creating, deleting or modifying some\nentities." + "id": "datastore.projects.commit" }, "reserveIds": { - "httpMethod": "POST", - "parameterOrder": [ - "projectId" - ], "response": { "$ref": "ReserveIdsResponse" }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], "parameters": { "projectId": { "description": "The ID of the project against which to make the request.", @@ -102,21 +105,43 @@ "location": "path" } }, + "flatPath": "v1beta3/projects/{projectId}:reserveIds", + "path": "v1beta3/projects/{projectId}:reserveIds", + "id": "datastore.projects.reserveIds", + "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore.", + "request": { + "$ref": "ReserveIdsRequest" + } + }, + "rollback": { + "path": "v1beta3/projects/{projectId}:rollback", + "id": "datastore.projects.rollback", + "description": "Rolls back a transaction.", + "request": { + "$ref": "RollbackRequest" + }, + "response": { + "$ref": "RollbackResponse" + }, + "parameterOrder": [ + "projectId" + ], + "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datastore" ], - "flatPath": "v1beta3/projects/{projectId}:reserveIds", - "id": "datastore.projects.reserveIds", - "path": "v1beta3/projects/{projectId}:reserveIds", - "request": { - "$ref": "ReserveIdsRequest" + "parameters": { + "projectId": { + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } }, - "description": "Prevents the supplied keys' IDs from being auto-allocated by Cloud\nDatastore." + "flatPath": "v1beta3/projects/{projectId}:rollback" }, "runQuery": { - "id": "datastore.projects.runQuery", - "path": "v1beta3/projects/{projectId}:runQuery", "request": { "$ref": "RunQueryRequest" }, @@ -130,47 +155,27 @@ }, "parameters": { "projectId": { - "location": "path", "description": "The ID of the project against which to make the request.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datastore" ], - "flatPath": "v1beta3/projects/{projectId}:runQuery" - }, - "rollback": { - "id": "datastore.projects.rollback", - "path": "v1beta3/projects/{projectId}:rollback", - "request": { - "$ref": "RollbackRequest" - }, - "description": "Rolls back a transaction.", - "httpMethod": "POST", - "parameterOrder": [ - "projectId" - ], - "response": { - "$ref": "RollbackResponse" - }, - "parameters": { - "projectId": { - "location": "path", - "description": "The ID of the project against which to make the request.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta3/projects/{projectId}:rollback" + "flatPath": "v1beta3/projects/{projectId}:runQuery", + "id": "datastore.projects.runQuery", + "path": "v1beta3/projects/{projectId}:runQuery" }, "lookup": { + "path": "v1beta3/projects/{projectId}:lookup", + "id": "datastore.projects.lookup", + "request": { + "$ref": "LookupRequest" + }, + "description": "Looks up entities by key.", "response": { "$ref": "LookupResponse" }, @@ -178,6 +183,28 @@ "projectId" ], "httpMethod": "POST", + "parameters": { + "projectId": { + "description": "The ID of the project against which to make the request.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta3/projects/{projectId}:lookup" + }, + "allocateIds": { + "httpMethod": "POST", + "parameterOrder": [ + "projectId" + ], + "response": { + "$ref": "AllocateIdsResponse" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/datastore" @@ -190,45 +217,57 @@ "type": "string" } }, - "flatPath": "v1beta3/projects/{projectId}:lookup", - "path": "v1beta3/projects/{projectId}:lookup", - "id": "datastore.projects.lookup", - "description": "Looks up entities by key.", + "flatPath": "v1beta3/projects/{projectId}:allocateIds", + "id": "datastore.projects.allocateIds", + "path": "v1beta3/projects/{projectId}:allocateIds", + "description": "Allocates IDs for the given keys, which is useful for referencing an entity\nbefore it is inserted.", "request": { - "$ref": "LookupRequest" + "$ref": "AllocateIdsRequest" } } } } }, "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true" }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, - "callback": { - "description": "JSONP", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, "$.xgafv": { + "description": "V1 error format.", + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -237,11 +276,15 @@ "enum": [ "1", "2" - ], - "description": "V1 error format.", - "type": "string" + ] }, "alt": { + "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -249,13 +292,7 @@ "media", "proto" ], - "type": "string", - "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" }, "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.", @@ -263,9 +300,9 @@ "location": "query" }, "access_token": { + "location": "query", "description": "OAuth access token.", - "type": "string", - "location": "query" + "type": "string" }, "quotaUser": { "location": "query", @@ -277,19 +314,75 @@ "description": "Pretty-print response.", "type": "boolean", "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" } }, "schemas": { + "ReserveIdsRequest": { + "description": "The request for Datastore.ReserveIds.", + "type": "object", + "properties": { + "keys": { + "description": "A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.", + "type": "array", + "items": { + "$ref": "Key" + } + }, + "databaseId": { + "description": "If not empty, the ID of the database against which to make the request.", + "type": "string" + } + }, + "id": "ReserveIdsRequest" + }, + "PathElement": { + "id": "PathElement", + "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", + "type": "object", + "properties": { + "name": { + "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", + "type": "string" + }, + "kind": { + "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", + "type": "string" + }, + "id": { + "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", + "format": "int64", + "type": "string" + } + } + }, + "GqlQueryParameter": { + "id": "GqlQueryParameter", + "description": "A binding parameter for a GQL query.", + "type": "object", + "properties": { + "value": { + "description": "A value parameter.", + "$ref": "Value" + }, + "cursor": { + "description": "A query cursor. Query cursors are returned in query\nresult batches.", + "format": "byte", + "type": "string" + } + } + }, + "BeginTransactionResponse": { + "description": "The response for Datastore.BeginTransaction.", + "type": "object", + "properties": { + "transaction": { + "description": "The transaction identifier (always present).", + "format": "byte", + "type": "string" + } + }, + "id": "BeginTransactionResponse" + }, "AllocateIdsRequest": { "description": "The request for Datastore.AllocateIds.", "type": "object", @@ -305,14 +398,9 @@ "id": "AllocateIdsRequest" }, "LookupResponse": { + "description": "The response for Datastore.Lookup.", + "type": "object", "properties": { - "deferred": { - "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.", - "type": "array", - "items": { - "$ref": "Key" - } - }, "found": { "description": "Entities found as `ResultType.FULL` entities. The order of results in this\nfield is undefined and has no relation to the order of the keys in the\ninput.", "type": "array", @@ -326,43 +414,36 @@ "items": { "$ref": "EntityResult" } + }, + "deferred": { + "description": "A list of keys that were not looked up due to resource constraints. The\norder of results in this field is undefined and has no relation to the\norder of the keys in the input.", + "type": "array", + "items": { + "$ref": "Key" + } } }, - "id": "LookupResponse", - "description": "The response for Datastore.Lookup.", - "type": "object" + "id": "LookupResponse" }, "RunQueryResponse": { + "id": "RunQueryResponse", + "description": "The response for Datastore.RunQuery.", + "type": "object", "properties": { + "query": { + "description": "The parsed form of the `GqlQuery` from the request, if it was set.", + "$ref": "Query" + }, "batch": { "description": "A batch of query results (always present).", "$ref": "QueryResultBatch" - }, - "query": { - "$ref": "Query", - "description": "The parsed form of the `GqlQuery` from the request, if it was set." } - }, - "id": "RunQueryResponse", - "description": "The response for Datastore.RunQuery.", - "type": "object" + } }, "CommitRequest": { "description": "The request for Datastore.Commit.", "type": "object", "properties": { - "mutations": { - "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.", - "type": "array", - "items": { - "$ref": "Mutation" - } - }, - "transaction": { - "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", - "format": "byte", - "type": "string" - }, "mode": { "enumDescriptions": [ "Unspecified. This value must not be used.", @@ -376,22 +457,35 @@ ], "description": "The type of commit to perform. Defaults to `TRANSACTIONAL`.", "type": "string" + }, + "mutations": { + "description": "The mutations to perform.\n\nWhen mode is `TRANSACTIONAL`, mutations affecting a single entity are\napplied in order. The following sequences of mutations affecting a single\nentity are not permitted in a single `Commit` request:\n\n- `insert` followed by `insert`\n- `update` followed by `insert`\n- `upsert` followed by `insert`\n- `delete` followed by `update`\n\nWhen mode is `NON_TRANSACTIONAL`, no two mutations may affect a single\nentity.", + "type": "array", + "items": { + "$ref": "Mutation" + } + }, + "transaction": { + "description": "The identifier of the transaction associated with the commit. A\ntransaction identifier is returned by a call to\nDatastore.BeginTransaction.", + "format": "byte", + "type": "string" } }, "id": "CommitRequest" }, "BeginTransactionRequest": { + "description": "The request for Datastore.BeginTransaction.", + "type": "object", "properties": { "transactionOptions": { - "$ref": "TransactionOptions", - "description": "Options for a new transaction." + "description": "Options for a new transaction.", + "$ref": "TransactionOptions" } }, - "id": "BeginTransactionRequest", - "description": "The request for Datastore.BeginTransaction.", - "type": "object" + "id": "BeginTransactionRequest" }, "PropertyOrder": { + "id": "PropertyOrder", "description": "The desired order for a specific property.", "type": "object", "properties": { @@ -400,6 +494,8 @@ "description": "The property to order by." }, "direction": { + "description": "The direction to order by. Defaults to `ASCENDING`.", + "type": "string", "enumDescriptions": [ "Unspecified. This value must not be used.", "Ascending.", @@ -409,14 +505,12 @@ "DIRECTION_UNSPECIFIED", "ASCENDING", "DESCENDING" - ], - "description": "The direction to order by. Defaults to `ASCENDING`.", - "type": "string" + ] } - }, - "id": "PropertyOrder" + } }, "KindExpression": { + "id": "KindExpression", "description": "A representation of a kind.", "type": "object", "properties": { @@ -424,10 +518,10 @@ "description": "The name of the kind.", "type": "string" } - }, - "id": "KindExpression" + } }, "Key": { + "id": "Key", "description": "A unique identifier for an entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.", "type": "object", "properties": { @@ -439,34 +533,33 @@ } }, "partitionId": { - "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.", - "$ref": "PartitionId" + "$ref": "PartitionId", + "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition." } - }, - "id": "Key" + } }, "LatLng": { + "id": "LatLng", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", + "type": "object", "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "format": "double", - "type": "number" - }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "format": "double", "type": "number" + }, + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" } - }, - "id": "LatLng", - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", - "type": "object" + } }, "ReserveIdsResponse": { + "id": "ReserveIdsResponse", "description": "The response for Datastore.ReserveIds.", "type": "object", - "properties": {}, - "id": "ReserveIdsResponse" + "properties": {} }, "PropertyReference": { "description": "A reference to a property relative to the kind expressions.", @@ -480,68 +573,30 @@ "id": "PropertyReference" }, "GoogleDatastoreAdminV1beta1EntityFilter": { + "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", + "type": "object", "properties": { - "namespaceIds": { - "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", - "type": "array", - "items": { - "type": "string" - } - }, "kinds": { "description": "If empty, then this represents all kinds.", "type": "array", "items": { "type": "string" } + }, + "namespaceIds": { + "description": "An empty list represents all namespaces. This is the preferred\nusage for projects that don't use namespaces.\n\nAn empty string element represents the default namespace. This should be\nused if the project has data in non-default namespaces, but doesn't want to\ninclude them.\nEach namespace in this list must be unique.", + "type": "array", + "items": { + "type": "string" + } } }, - "id": "GoogleDatastoreAdminV1beta1EntityFilter", - "description": "Identifies a subset of entities in a project. This is specified as\ncombinations of kinds and namespaces (either or both of which may be all, as\ndescribed in the following examples).\nExample usage:\n\nEntire project:\n kinds=[], namespace_ids=[]\n\nKinds Foo and Bar in all namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=[]\n\nKinds Foo and Bar only in the default namespace:\n kinds=['Foo', 'Bar'], namespace_ids=['']\n\nKinds Foo and Bar in both the default and Baz namespaces:\n kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz']\n\nThe entire Baz namespace:\n kinds=[], namespace_ids=['Baz']", - "type": "object" + "id": "GoogleDatastoreAdminV1beta1EntityFilter" }, "GoogleDatastoreAdminV1beta1CommonMetadata": { "description": "Metadata common to all Datastore Admin operations.", "type": "object", "properties": { - "operationType": { - "enumDescriptions": [ - "Unspecified.", - "ExportEntities.", - "ImportEntities." - ], - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "EXPORT_ENTITIES", - "IMPORT_ENTITIES" - ], - "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.", - "type": "string" - }, - "state": { - "enum": [ - "STATE_UNSPECIFIED", - "INITIALIZING", - "PROCESSING", - "CANCELLING", - "FINALIZING", - "SUCCESSFUL", - "FAILED", - "CANCELLED" - ], - "description": "The current state of the Operation.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Request is being prepared for processing.", - "Request is actively being processed.", - "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.", - "Request has been processed and is in its finalization stage.", - "Request has completed successfully.", - "Request has finished being processed, but encountered an error.", - "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation." - ] - }, "startTime": { "description": "The time that work began on the operation.", "format": "google-datetime", @@ -558,20 +613,58 @@ "description": "The time the operation ended, either successfully or otherwise.", "format": "google-datetime", "type": "string" + }, + "operationType": { + "enumDescriptions": [ + "Unspecified.", + "ExportEntities.", + "ImportEntities." + ], + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "EXPORT_ENTITIES", + "IMPORT_ENTITIES" + ], + "description": "The type of the operation. Can be used as a filter in\nListOperationsRequest.", + "type": "string" + }, + "state": { + "description": "The current state of the Operation.", + "type": "string", + "enumDescriptions": [ + "Unspecified.", + "Request is being prepared for processing.", + "Request is actively being processed.", + "Request is in the process of being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation on the operation.", + "Request has been processed and is in its finalization stage.", + "Request has completed successfully.", + "Request has finished being processed, but encountered an error.", + "Request has finished being cancelled after user called\ngoogle.longrunning.Operations.CancelOperation." + ], + "enum": [ + "STATE_UNSPECIFIED", + "INITIALIZING", + "PROCESSING", + "CANCELLING", + "FINALIZING", + "SUCCESSFUL", + "FAILED", + "CANCELLED" + ] } }, "id": "GoogleDatastoreAdminV1beta1CommonMetadata" }, "Projection": { + "id": "Projection", "description": "A representation of a property in a projection.", "type": "object", "properties": { "property": { - "$ref": "PropertyReference", - "description": "The property to project." + "description": "The property to project.", + "$ref": "PropertyReference" } - }, - "id": "Projection" + } }, "ArrayValue": { "description": "An array value.", @@ -588,18 +681,16 @@ "id": "ArrayValue" }, "Mutation": { + "description": "A mutation to apply to an entity.", + "type": "object", "properties": { - "update": { - "description": "The entity to update. The entity must already exist.\nMust have a complete key path.", - "$ref": "Entity" - }, "upsert": { "$ref": "Entity", "description": "The entity to upsert. The entity may or may not already exist.\nThe entity key's final path element may be incomplete." }, "delete": { - "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only.", - "$ref": "Key" + "$ref": "Key", + "description": "The key of the entity to delete. The entity may or may not already exist.\nMust have a complete key path and must not be reserved/read-only." }, "insert": { "$ref": "Entity", @@ -609,11 +700,13 @@ "description": "The version of the entity that this mutation is being applied to. If this\ndoes not match the current version on the server, the mutation conflicts.", "format": "int64", "type": "string" + }, + "update": { + "description": "The entity to update. The entity must already exist.\nMust have a complete key path.", + "$ref": "Entity" } }, - "id": "Mutation", - "description": "A mutation to apply to an entity.", - "type": "object" + "id": "Mutation" }, "ReadOptions": { "description": "The options shared by read requests.", @@ -642,10 +735,10 @@ "id": "ReadOptions" }, "RollbackResponse": { + "id": "RollbackResponse", "description": "The response for Datastore.Rollback.\n(an empty message).", "type": "object", - "properties": {}, - "id": "RollbackResponse" + "properties": {} }, "GoogleDatastoreAdminV1beta1ExportEntitiesResponse": { "description": "The response for\ngoogle.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities.", @@ -659,9 +752,14 @@ "id": "GoogleDatastoreAdminV1beta1ExportEntitiesResponse" }, "MutationResult": { + "id": "MutationResult", "description": "The result of applying a mutation.", "type": "object", "properties": { + "key": { + "description": "The automatically allocated key.\nSet only when the mutation allocated a key.", + "$ref": "Key" + }, "version": { "description": "The version of the entity on the server after processing the mutation. If\nthe mutation doesn't change anything on the server, then the version will\nbe the version of the current entity or, if no entity is present, a version\nthat is strictly greater than the version of any previous entity and less\nthan the version of any possible future entity.", "format": "int64", @@ -670,15 +768,12 @@ "conflictDetected": { "description": "Whether a conflict was detected for this mutation. Always false when a\nconflict detection strategy field is not set in the mutation.", "type": "boolean" - }, - "key": { - "$ref": "Key", - "description": "The automatically allocated key.\nSet only when the mutation allocated a key." } - }, - "id": "MutationResult" + } }, "GqlQuery": { + "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", + "type": "object", "properties": { "queryString": { "description": "A string of the format described\n[here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", @@ -689,11 +784,11 @@ "type": "boolean" }, "namedBindings": { + "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.", + "type": "object", "additionalProperties": { "$ref": "GqlQueryParameter" - }, - "description": "For each non-reserved named binding site in the query string, there must be\na named parameter with that name, but not necessarily the inverse.\n\nKey must match regex `A-Za-z_$*`, must not match regex\n`__.*__`, and must not be `\"\"`.", - "type": "object" + } }, "positionalBindings": { "description": "Numbered binding site @1 references the first numbered parameter,\neffectively using 1-based indexing, rather than the usual 0.\n\nFor each binding site numbered i in `query_string`, there must be an i-th\nnumbered parameter. The inverse must also be true.", @@ -703,49 +798,48 @@ } } }, - "id": "GqlQuery", - "description": "A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).", - "type": "object" + "id": "GqlQuery" }, "Filter": { + "description": "A holder for any type of filter.", + "type": "object", "properties": { - "propertyFilter": { - "$ref": "PropertyFilter", - "description": "A filter on a property." - }, "compositeFilter": { - "$ref": "CompositeFilter", - "description": "A composite filter." + "description": "A composite filter.", + "$ref": "CompositeFilter" + }, + "propertyFilter": { + "description": "A filter on a property.", + "$ref": "PropertyFilter" } }, - "id": "Filter", - "description": "A holder for any type of filter.", - "type": "object" + "id": "Filter" }, "RunQueryRequest": { + "id": "RunQueryRequest", "description": "The request for Datastore.RunQuery.", "type": "object", "properties": { + "readOptions": { + "description": "The options for this query.", + "$ref": "ReadOptions" + }, + "query": { + "$ref": "Query", + "description": "The query to run." + }, "partitionId": { "$ref": "PartitionId", "description": "Entities are partitioned into subsets, identified by a partition ID.\nQueries are scoped to a single partition.\nThis partition ID is normalized with the standard default context\npartition ID." }, "gqlQuery": { - "description": "The GQL query to run.", - "$ref": "GqlQuery" - }, - "readOptions": { - "$ref": "ReadOptions", - "description": "The options for this query." - }, - "query": { - "$ref": "Query", - "description": "The query to run." + "$ref": "GqlQuery", + "description": "The GQL query to run." } - }, - "id": "RunQueryRequest" + } }, "RollbackRequest": { + "id": "RollbackRequest", "description": "The request for Datastore.Rollback.", "type": "object", "properties": { @@ -754,47 +848,46 @@ "format": "byte", "type": "string" } - }, - "id": "RollbackRequest" + } }, "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata": { + "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata", "description": "Metadata for ExportEntities operations.", "type": "object", "properties": { "common": { - "description": "Metadata common to all Datastore Admin operations.", - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" + "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", + "description": "Metadata common to all Datastore Admin operations." }, "progressBytes": { "$ref": "GoogleDatastoreAdminV1beta1Progress", "description": "An estimate of the number of bytes processed." }, "entityFilter": { - "$ref": "GoogleDatastoreAdminV1beta1EntityFilter", - "description": "Description of which entities are being exported." + "description": "Description of which entities are being exported.", + "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" }, "outputUrlPrefix": { "description": "Location for the export metadata and data files. This will be the same\nvalue as the\ngoogle.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix\nfield. The final output location is provided in\ngoogle.datastore.admin.v1beta1.ExportEntitiesResponse.output_url.", "type": "string" }, "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" + "$ref": "GoogleDatastoreAdminV1beta1Progress", + "description": "An estimate of the number of entities processed." } - }, - "id": "GoogleDatastoreAdminV1beta1ExportEntitiesMetadata" + } }, "TransactionOptions": { "description": "Options for beginning a new transaction.\n\nTransactions can be created explicitly with calls to\nDatastore.BeginTransaction or implicitly by setting\nReadOptions.new_transaction in read requests.", "type": "object", "properties": { "readWrite": { - "$ref": "ReadWrite", - "description": "The transaction should allow both reads and writes." + "description": "The transaction should allow both reads and writes.", + "$ref": "ReadWrite" }, "readOnly": { - "$ref": "ReadOnly", - "description": "The transaction should only allow reads." + "description": "The transaction should only allow reads.", + "$ref": "ReadOnly" } }, "id": "TransactionOptions" @@ -826,20 +919,17 @@ "id": "CompositeFilter" }, "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata": { + "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata", "description": "Metadata for ImportEntities operations.", "type": "object", "properties": { - "progressEntities": { - "description": "An estimate of the number of entities processed.", - "$ref": "GoogleDatastoreAdminV1beta1Progress" - }, "common": { - "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata", - "description": "Metadata common to all Datastore Admin operations." + "description": "Metadata common to all Datastore Admin operations.", + "$ref": "GoogleDatastoreAdminV1beta1CommonMetadata" }, "progressBytes": { - "$ref": "GoogleDatastoreAdminV1beta1Progress", - "description": "An estimate of the number of bytes processed." + "description": "An estimate of the number of bytes processed.", + "$ref": "GoogleDatastoreAdminV1beta1Progress" }, "inputUrl": { "description": "The location of the import metadata file. This will be the same value as\nthe google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url\nfield.", @@ -848,11 +938,16 @@ "entityFilter": { "description": "Description of which entities are being imported.", "$ref": "GoogleDatastoreAdminV1beta1EntityFilter" + }, + "progressEntities": { + "$ref": "GoogleDatastoreAdminV1beta1Progress", + "description": "An estimate of the number of entities processed." } - }, - "id": "GoogleDatastoreAdminV1beta1ImportEntitiesMetadata" + } }, "AllocateIdsResponse": { + "description": "The response for Datastore.AllocateIds.", + "type": "object", "properties": { "keys": { "description": "The keys specified in the request (in the same order), each with\nits key path completed with a newly allocated ID.", @@ -862,19 +957,13 @@ } } }, - "id": "AllocateIdsResponse", - "description": "The response for Datastore.AllocateIds.", - "type": "object" + "id": "AllocateIdsResponse" }, "Query": { + "id": "Query", + "description": "A query for entities.", + "type": "object", "properties": { - "order": { - "description": "The order to apply to the query results (if empty, order is unspecified).", - "type": "array", - "items": { - "$ref": "PropertyOrder" - } - }, "projection": { "description": "The projection to return. Defaults to returning all properties.", "type": "array", @@ -893,19 +982,19 @@ "type": "integer" }, "filter": { - "$ref": "Filter", - "description": "The filter to apply." - }, - "offset": { - "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.", - "format": "int32", - "type": "integer" + "description": "The filter to apply.", + "$ref": "Filter" }, "startCursor": { "description": "A starting point for the query results. Query cursors are\nreturned in query result batches and\n[can only be used to continue the same query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).", "format": "byte", "type": "string" }, + "offset": { + "description": "The number of results to skip. Applies before limit, but after all other\nconstraints. Optional. Must be \u003e= 0 if specified.", + "format": "int32", + "type": "integer" + }, "kind": { "description": "The kinds to query (if empty, returns entities of all kinds).\nCurrently at most 1 kind may be specified.", "type": "array", @@ -919,29 +1008,38 @@ "items": { "$ref": "PropertyReference" } + }, + "order": { + "description": "The order to apply to the query results (if empty, order is unspecified).", + "type": "array", + "items": { + "$ref": "PropertyOrder" + } } - }, - "id": "Query", - "description": "A query for entities.", - "type": "object" + } }, "ReadOnly": { + "id": "ReadOnly", "description": "Options specific to read-only transactions.", "type": "object", - "properties": {}, - "id": "ReadOnly" + "properties": {} }, "PropertyFilter": { + "id": "PropertyFilter", + "description": "A filter on a specific property.", + "type": "object", "properties": { "value": { - "$ref": "Value", - "description": "The value to compare the property to." + "description": "The value to compare the property to.", + "$ref": "Value" }, "property": { "$ref": "PropertyReference", "description": "The property to filter by." }, "op": { + "description": "The operator to filter by.", + "type": "string", "enumDescriptions": [ "Unspecified. This value must not be used.", "Less than.", @@ -959,16 +1057,14 @@ "GREATER_THAN_OR_EQUAL", "EQUAL", "HAS_ANCESTOR" - ], - "description": "The operator to filter by.", - "type": "string" + ] } - }, - "id": "PropertyFilter", - "description": "A filter on a specific property.", - "type": "object" + } }, "EntityResult": { + "id": "EntityResult", + "description": "The result of fetching an entity from Datastore.", + "type": "object", "properties": { "cursor": { "description": "A cursor that points to the position after the result entity.\nSet only when the `EntityResult` is part of a `QueryResultBatch` message.", @@ -981,83 +1077,10 @@ "type": "string" }, "entity": { - "$ref": "Entity", - "description": "The resulting entity." - } - }, - "id": "EntityResult", - "description": "The result of fetching an entity from Datastore.", - "type": "object" - }, - "Value": { - "properties": { - "geoPointValue": { - "description": "A geo point value representing a point on the surface of Earth.", - "$ref": "LatLng" - }, - "keyValue": { - "description": "A key value.", - "$ref": "Key" - }, - "integerValue": { - "description": "An integer value.", - "format": "int64", - "type": "string" - }, - "stringValue": { - "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.", - "type": "string" - }, - "excludeFromIndexes": { - "description": "If the value should be excluded from all indexes including those defined\nexplicitly.", - "type": "boolean" - }, - "doubleValue": { - "description": "A double value.", - "format": "double", - "type": "number" - }, - "timestampValue": { - "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.", - "format": "google-datetime", - "type": "string" - }, - "booleanValue": { - "description": "A boolean value.", - "type": "boolean" - }, - "nullValue": { - "enum": [ - "NULL_VALUE" - ], - "description": "A null value.", - "type": "string", - "enumDescriptions": [ - "Null value." - ] - }, - "blobValue": { - "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.", - "format": "byte", - "type": "string" - }, - "meaning": { - "description": "The `meaning` field should only be populated for backwards compatibility.", - "format": "int32", - "type": "integer" - }, - "arrayValue": { - "$ref": "ArrayValue", - "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`." - }, - "entityValue": { - "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.", + "description": "The resulting entity.", "$ref": "Entity" } - }, - "id": "Value", - "description": "A message that can hold any of the supported value types and associated\nmetadata.", - "type": "object" + } }, "CommitResponse": { "description": "The response for Datastore.Commit.", @@ -1078,7 +1101,79 @@ }, "id": "CommitResponse" }, + "Value": { + "description": "A message that can hold any of the supported value types and associated\nmetadata.", + "type": "object", + "properties": { + "entityValue": { + "description": "An entity value.\n\n- May have no key.\n- May have a key with an incomplete key path.\n- May have a reserved/read-only key.", + "$ref": "Entity" + }, + "geoPointValue": { + "$ref": "LatLng", + "description": "A geo point value representing a point on the surface of Earth." + }, + "integerValue": { + "description": "An integer value.", + "format": "int64", + "type": "string" + }, + "keyValue": { + "$ref": "Key", + "description": "A key value." + }, + "stringValue": { + "description": "A UTF-8 encoded string value.\nWhen `exclude_from_indexes` is false (it is indexed) , may have at most 1500 bytes.\nOtherwise, may be set to at least 1,000,000 bytes.", + "type": "string" + }, + "excludeFromIndexes": { + "description": "If the value should be excluded from all indexes including those defined\nexplicitly.", + "type": "boolean" + }, + "doubleValue": { + "description": "A double value.", + "format": "double", + "type": "number" + }, + "timestampValue": { + "description": "A timestamp value.\nWhen stored in the Datastore, precise only to microseconds;\nany additional precision is rounded down.", + "format": "google-datetime", + "type": "string" + }, + "nullValue": { + "description": "A null value.", + "type": "string", + "enumDescriptions": [ + "Null value." + ], + "enum": [ + "NULL_VALUE" + ] + }, + "booleanValue": { + "description": "A boolean value.", + "type": "boolean" + }, + "blobValue": { + "description": "A blob value.\nMay have at most 1,000,000 bytes.\nWhen `exclude_from_indexes` is false, may have at most 1500 bytes.\nIn JSON requests, must be base64-encoded.", + "format": "byte", + "type": "string" + }, + "meaning": { + "description": "The `meaning` field should only be populated for backwards compatibility.", + "format": "int32", + "type": "integer" + }, + "arrayValue": { + "description": "An array value.\nCannot contain another array value.\nA `Value` instance that sets field `array_value` must not set fields\n`meaning` or `exclude_from_indexes`.", + "$ref": "ArrayValue" + } + }, + "id": "Value" + }, "PartitionId": { + "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.", + "type": "object", "properties": { "projectId": { "description": "The ID of the project to which the entities belong.", @@ -1089,50 +1184,71 @@ "type": "string" } }, - "id": "PartitionId", - "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.\n\nPartition dimensions:\n\n- May be `\"\"`.\n- Must be valid UTF-8 bytes.\n- Must have values that match regex `[A-Za-z\\d\\.\\-_]{1,100}`\nIf the value of any dimension matches regex `__.*__`, the partition is\nreserved/read-only.\nA reserved/read-only partition ID is forbidden in certain documented\ncontexts.\n\nForeign partition IDs (in which the project ID does\nnot match the context project ID ) are discouraged.\nReads and writes of foreign partition IDs may fail if the project is not in an active state.", - "type": "object" + "id": "PartitionId" }, "Entity": { + "id": "Entity", "description": "A Datastore data object.\n\nAn entity is limited to 1 megabyte when stored. That _roughly_\ncorresponds to a limit of 1 megabyte for the serialized form of this\nmessage.", "type": "object", "properties": { + "key": { + "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.", + "$ref": "Key" + }, "properties": { "additionalProperties": { "$ref": "Value" }, "description": "The entity's properties.\nThe map's keys are property names.\nA property name matching regex `__.*__` is reserved.\nA reserved property name is forbidden in certain documented contexts.\nThe name must not contain more than 500 characters.\nThe name cannot be `\"\"`.", "type": "object" - }, - "key": { - "description": "The entity's key.\n\nAn entity must have a key, unless otherwise documented (for example,\nan entity in `Value.entity_value` may have no key).\nAn entity's kind is its key path's last element's kind,\nor null if it has no key.", - "$ref": "Key" } - }, - "id": "Entity" + } }, "ReadWrite": { + "id": "ReadWrite", + "description": "Options specific to read / write transactions.", + "type": "object", "properties": { "previousTransaction": { "description": "The transaction identifier of the transaction being retried.", "format": "byte", "type": "string" } - }, - "id": "ReadWrite", - "description": "Options specific to read / write transactions.", - "type": "object" + } + }, + "LookupRequest": { + "id": "LookupRequest", + "description": "The request for Datastore.Lookup.", + "type": "object", + "properties": { + "readOptions": { + "$ref": "ReadOptions", + "description": "The options for this lookup request." + }, + "keys": { + "description": "Keys of entities to look up.", + "type": "array", + "items": { + "$ref": "Key" + } + } + } }, "QueryResultBatch": { + "id": "QueryResultBatch", "description": "A batch of results produced by a query.", "type": "object", "properties": { - "endCursor": { - "description": "A cursor that points to the position after the last result in the batch.", - "format": "byte", - "type": "string" + "entityResults": { + "description": "The results for this batch.", + "type": "array", + "items": { + "$ref": "EntityResult" + } }, "moreResults": { + "description": "The state of the query after the current batch.", + "type": "string", "enumDescriptions": [ "Unspecified. This value is never used.", "There may be additional batches to fetch from this query.", @@ -1146,8 +1262,11 @@ "MORE_RESULTS_AFTER_LIMIT", "MORE_RESULTS_AFTER_CURSOR", "NO_MORE_RESULTS" - ], - "description": "The state of the query after the current batch.", + ] + }, + "endCursor": { + "description": "A cursor that points to the position after the last result in the batch.", + "format": "byte", "type": "string" }, "snapshotVersion": { @@ -1180,18 +1299,12 @@ ], "description": "The result type for every entity in `entity_results`.", "type": "string" - }, - "entityResults": { - "description": "The results for this batch.", - "type": "array", - "items": { - "$ref": "EntityResult" - } } - }, - "id": "QueryResultBatch" + } }, "GoogleDatastoreAdminV1beta1Progress": { + "description": "Measures the progress of a particular metric.", + "type": "object", "properties": { "workEstimated": { "description": "An estimate of how much work needs to be performed. May be zero if the\nwork estimate is unavailable.", @@ -1204,93 +1317,7 @@ "type": "string" } }, - "id": "GoogleDatastoreAdminV1beta1Progress", - "description": "Measures the progress of a particular metric.", - "type": "object" - }, - "LookupRequest": { - "description": "The request for Datastore.Lookup.", - "type": "object", - "properties": { - "readOptions": { - "description": "The options for this lookup request.", - "$ref": "ReadOptions" - }, - "keys": { - "description": "Keys of entities to look up.", - "type": "array", - "items": { - "$ref": "Key" - } - } - }, - "id": "LookupRequest" - }, - "ReserveIdsRequest": { - "description": "The request for Datastore.ReserveIds.", - "type": "object", - "properties": { - "keys": { - "description": "A list of keys with complete key paths whose numeric IDs should not be\nauto-allocated.", - "type": "array", - "items": { - "$ref": "Key" - } - }, - "databaseId": { - "description": "If not empty, the ID of the database against which to make the request.", - "type": "string" - } - }, - "id": "ReserveIdsRequest" - }, - "PathElement": { - "properties": { - "id": { - "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", - "type": "string" - }, - "kind": { - "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", - "type": "string" - } - }, - "id": "PathElement", - "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", - "type": "object" - }, - "GqlQueryParameter": { - "description": "A binding parameter for a GQL query.", - "type": "object", - "properties": { - "cursor": { - "description": "A query cursor. Query cursors are returned in query\nresult batches.", - "format": "byte", - "type": "string" - }, - "value": { - "description": "A value parameter.", - "$ref": "Value" - } - }, - "id": "GqlQueryParameter" - }, - "BeginTransactionResponse": { - "description": "The response for Datastore.BeginTransaction.", - "type": "object", - "properties": { - "transaction": { - "description": "The transaction identifier (always present).", - "format": "byte", - "type": "string" - } - }, - "id": "BeginTransactionResponse" + "id": "GoogleDatastoreAdminV1beta1Progress" } }, "icons": { @@ -1299,32 +1326,5 @@ }, "protocol": "rest", "version": "v1beta3", - "baseUrl": "https://datastore.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/datastore": { - "description": "View and manage your Google Cloud Datastore data" - } - } - } - }, - "kind": "discovery#restDescription", - "description": "Accesses the schemaless NoSQL database to provide fully managed, robust, scalable storage for your application.\n", - "servicePath": "", - "rootUrl": "https://datastore.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "datastore", - "batchPath": "batch", - "revision": "20171212", - "documentationLink": "https://cloud.google.com/datastore/", - "id": "datastore:v1beta3", - "title": "Google Cloud Datastore API", - "discoveryVersion": "v1", - "ownerName": "Google", - "version_module": true + "baseUrl": "https://datastore.googleapis.com/" }
diff --git a/dialogflow/v2beta1/dialogflow-api.json b/dialogflow/v2beta1/dialogflow-api.json index b3bbc2a..92aeda4 100644 --- a/dialogflow/v2beta1/dialogflow-api.json +++ b/dialogflow/v2beta1/dialogflow-api.json
@@ -1,21 +1,520 @@ { + "revision": "20171229", + "documentationLink": "https://cloud.google.com/dialogflow-enterprise/", + "id": "dialogflow:v2beta1", "discoveryVersion": "v1", "version_module": true, "schemas": { + "WebhookRequest": { + "properties": { + "queryResult": { + "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`.", + "$ref": "QueryResult" + }, + "originalDetectIntentRequest": { + "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call.", + "$ref": "OriginalDetectIntentRequest" + }, + "responseId": { + "description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.", + "type": "string" + }, + "session": { + "description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.", + "type": "string" + } + }, + "id": "WebhookRequest", + "description": "The request message for a webhook call.", + "type": "object" + }, + "RestoreAgentRequest": { + "description": "The request message for Agents.RestoreAgent.", + "type": "object", + "properties": { + "agentContent": { + "description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\" \\", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "Warning: Restoring agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".", + "type": "string" + } + }, + "id": "RestoreAgentRequest" + }, + "IntentTrainingPhrase": { + "description": "Represents an example or template that the agent is trained on.", + "type": "object", + "properties": { + "parts": { + "description": "Required. The collection of training phrase parts (can be annotated).\nFields: `entity_type`, `alias` and `user_defined` should be populated\nonly for the annotated parts of the training phrase.", + "type": "array", + "items": { + "$ref": "IntentTrainingPhrasePart" + } + }, + "name": { + "description": "Required. The unique identifier of this training phrase.", + "type": "string" + }, + "timesAddedCount": { + "description": "Optional. Indicates how many times this example or template was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.", + "format": "int32", + "type": "integer" + }, + "type": { + "description": "Required. The type of the training phrase.", + "type": "string", + "enumDescriptions": [ + "Not specified. This value should never be used.", + "Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.", + "Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "EXAMPLE", + "TEMPLATE" + ] + } + }, + "id": "IntentTrainingPhrase" + }, + "ListIntentsResponse": { + "properties": { + "intents": { + "description": "The list of agent intents. There will be a maximum number of items\nreturned based on the page_size field in the request.", + "type": "array", + "items": { + "$ref": "Intent" + } + }, + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "type": "string" + } + }, + "id": "ListIntentsResponse", + "description": "The response message for Intents.ListIntents.", + "type": "object" + }, + "LatLng": { + "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", + "type": "object", + "properties": { + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" + }, + "longitude": { + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double", + "type": "number" + } + }, + "id": "LatLng" + }, + "Context": { + "description": "Represents a context.", + "type": "object", + "properties": { + "lifespanCount": { + "description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 10 minutes even if there\nare no matching queries.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.", + "type": "string" + }, + "parameters": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. The collection of parameters associated with this context.\nRefer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for\nsyntax.", + "type": "object" + } + }, + "id": "Context" + }, + "ImportAgentRequest": { + "description": "The request message for Agents.ImportAgent.", + "type": "object", + "properties": { + "agentContent": { + "description": "The agent to import.\n\nExample for how to import an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:import\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\"", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "Warning: Importing agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".", + "type": "string" + } + }, + "id": "ImportAgentRequest" + }, + "BatchUpdateIntentsResponse": { + "properties": { + "intents": { + "description": "The collection of updated or created intents.", + "type": "array", + "items": { + "$ref": "Intent" + } + } + }, + "id": "BatchUpdateIntentsResponse", + "description": "The response message for Intents.BatchUpdateIntents.", + "type": "object" + }, + "IntentParameter": { + "description": "Represents intent parameters.", + "type": "object", + "properties": { + "name": { + "description": "The unique identifier of this parameter.", + "type": "string" + }, + "isList": { + "description": "Optional. Indicates whether the parameter represents a list of values.", + "type": "boolean" + }, + "value": { + "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", + "type": "string" + }, + "displayName": { + "description": "Required. The name of the parameter.", + "type": "string" + }, + "entityTypeDisplayName": { + "description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.", + "type": "string" + }, + "prompts": { + "description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.", + "type": "array", + "items": { + "type": "string" + } + }, + "defaultValue": { + "description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.", + "type": "string" + }, + "mandatory": { + "description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.", + "type": "boolean" + } + }, + "id": "IntentParameter" + }, + "ExportAgentResponse": { + "description": "The response message for Agents.ExportAgent.", + "type": "object", + "properties": { + "agentContent": { + "description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e \u003cagent zip file\u003e", + "format": "byte", + "type": "string" + }, + "agentUri": { + "description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in `ExportAgentRequest`.", + "type": "string" + } + }, + "id": "ExportAgentResponse" + }, + "IntentMessageBasicCardButtonOpenUriAction": { + "description": "Opens the given URI.", + "type": "object", + "properties": { + "uri": { + "description": "Required. The HTTP or HTTPS scheme URI.", + "type": "string" + } + }, + "id": "IntentMessageBasicCardButtonOpenUriAction" + }, + "IntentMessageImage": { + "description": "The image response message.", + "type": "object", + "properties": { + "imageUri": { + "description": "Optional. The public URI to an image file.", + "type": "string" + } + }, + "id": "IntentMessageImage" + }, + "BatchUpdateIntentsRequest": { + "description": "The request message for Intents.BatchUpdateIntents.", + "type": "object", + "properties": { + "intentBatchUri": { + "description": "Warning: Importing intents from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing intents to update or\ncreate. The file format can either be a serialized proto (of IntentBatch\ntype) or JSON object. Note: The URI must start with \"gs://\".", + "type": "string" + }, + "intentView": { + "description": "Optional. The resource view to apply to the returned intent.", + "type": "string", + "enumDescriptions": [ + "Training phrases field is not populated in the response.", + "All fields are populated." + ], + "enum": [ + "INTENT_VIEW_UNSPECIFIED", + "INTENT_VIEW_FULL" + ] + }, + "intentBatchInline": { + "description": "The collection of intents to update or create.", + "$ref": "IntentBatch" + }, + "languageCode": { + "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intents`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "id": "BatchUpdateIntentsRequest" + }, + "TrainAgentRequest": { + "properties": {}, + "id": "TrainAgentRequest", + "description": "The request message for Agents.TrainAgent.", + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "SessionEntityType": { + "properties": { + "entityOverrideMode": { + "description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.", + "type": "string", + "enumDescriptions": [ + "Not specified. This value should be never used.", + "The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.", + "The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\nCalls to `ListSessionEntityTypes`, `GetSessionEntityType`,\n`CreateSessionEntityType` and `UpdateSessionEntityType` return the full\ncollection of entities from the developer entity type in the agent's\ndefault language and the session entity type." + ], + "enum": [ + "ENTITY_OVERRIDE_MODE_UNSPECIFIED", + "ENTITY_OVERRIDE_MODE_OVERRIDE", + "ENTITY_OVERRIDE_MODE_SUPPLEMENT" + ] + }, + "entities": { + "description": "Required. The collection of entities associated with this session entity\ntype.", + "type": "array", + "items": { + "$ref": "EntityTypeEntity" + } + }, + "name": { + "description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.", + "type": "string" + } + }, + "id": "SessionEntityType", + "description": "Represents a session entity type.\n\nExtends or replaces a developer entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"developer entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.", + "type": "object" + }, + "IntentMessageText": { + "description": "The text response message.", + "type": "object", + "properties": { + "text": { + "description": "Optional. The collection of the agent's responses.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "IntentMessageText" + }, + "BatchUpdateEntitiesRequest": { + "description": "The response message for EntityTypes.BatchCreateEntities.", + "type": "object", + "properties": { + "languageCode": { + "description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "type": "string" + }, + "entities": { + "description": "Required. The collection of new entities to replace the existing entities.", + "type": "array", + "items": { + "$ref": "EntityTypeEntity" + } + } + }, + "id": "BatchUpdateEntitiesRequest" + }, + "WebhookResponse": { + "description": "The response message for a webhook call.", + "type": "object", + "properties": { + "source": { + "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.", + "type": "string" + }, + "followupEventInput": { + "$ref": "EventInput", + "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input." + }, + "outputContexts": { + "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.", + "type": "array", + "items": { + "$ref": "Context" + } + }, + "fulfillmentText": { + "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.", + "type": "string" + }, + "fulfillmentMessages": { + "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.", + "type": "array", + "items": { + "$ref": "IntentMessage" + } + }, + "payload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.", + "type": "object" + } + }, + "id": "WebhookResponse" + }, + "BatchDeleteIntentsRequest": { + "description": "The request message for Intents.BatchDeleteIntents.", + "type": "object", + "properties": { + "intents": { + "description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.", + "type": "array", + "items": { + "$ref": "Intent" + } + } + }, + "id": "BatchDeleteIntentsRequest" + }, + "QueryInput": { + "description": "Represents the query input. It can contain either:\n\n1. An audio config which\n instructs the speech recognizer how to process the speech audio.\n\n2. A conversational query in the form of text,.\n\n3. An event that specifies which intent to trigger.", + "type": "object", + "properties": { + "event": { + "$ref": "EventInput", + "description": "The event to be processed." + }, + "text": { + "description": "The natural language text to be processed.", + "$ref": "TextInput" + }, + "audioConfig": { + "$ref": "InputAudioConfig", + "description": "Instructs the speech recognizer how to process the speech audio." + } + }, + "id": "QueryInput" + }, + "DetectIntentResponse": { + "description": "The message returned from the DetectIntent method.", + "type": "object", + "properties": { + "webhookStatus": { + "description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests.", + "$ref": "Status" + }, + "responseId": { + "description": "The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.", + "type": "string" + }, + "queryResult": { + "description": "The results of the conversational query or event processing.", + "$ref": "QueryResult" + } + }, + "id": "DetectIntentResponse" + }, + "IntentFollowupIntentInfo": { + "properties": { + "followupIntentName": { + "description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", + "type": "string" + }, + "parentFollowupIntentName": { + "description": "The unique identifier of the followup intent parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", + "type": "string" + } + }, + "id": "IntentFollowupIntentInfo", + "description": "Represents a single followup intent in the chain.", + "type": "object" + }, + "ExportAgentRequest": { + "description": "The request message for Agents.ExportAgent.", + "type": "object", + "properties": { + "agentUri": { + "description": "Warning: Exporting agents to a URI is not implemented yet.\nThis feature is coming soon.\n\nOptional. The Google Cloud Storage URI to export the agent to.\nNote: The URI must start with\n\"gs://\". If left unspecified, the serialized agent is returned inline.", + "type": "string" + } + }, + "id": "ExportAgentRequest" + }, + "IntentMessageLinkOutSuggestion": { + "description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.", + "type": "object", + "properties": { + "destinationName": { + "description": "Required. The name of the app or site this chip is linking to.", + "type": "string" + }, + "uri": { + "description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.", + "type": "string" + } + }, + "id": "IntentMessageLinkOutSuggestion" + }, "IntentMessageSelectItemInfo": { "description": "Additional info about the select item for when it is triggered in a\ndialog.", "type": "object", "properties": { + "key": { + "description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.", + "type": "string" + }, "synonyms": { "description": "Optional. A list of synonyms that can also be used to trigger this\nitem in dialog.", "type": "array", "items": { "type": "string" } - }, - "key": { - "description": "Required. A unique key that will be sent back to the agent if this\nresponse is given.", - "type": "string" } }, "id": "IntentMessageSelectItemInfo" @@ -25,20 +524,20 @@ "type": "object", "properties": { "response": { - "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", "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", "type": "string" }, "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { @@ -78,12 +577,12 @@ "type": "string" }, "parameters": { - "description": "Optional. The collection of parameters associated with the event.", - "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" - } + }, + "description": "Optional. The collection of parameters associated with the event.", + "type": "object" }, "languageCode": { "description": "Required. The language of this query. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.", @@ -96,15 +595,13 @@ "description": "Represents an entity type.\nEntity types serve as a tool for extracting parameter values from natural\nlanguage queries.", "type": "object", "properties": { - "name": { - "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", - "type": "string" - }, "displayName": { "description": "Required. The name of the entity.", "type": "string" }, "kind": { + "description": "Required. Indicates the kind of entity type.", + "type": "string", "enumDescriptions": [ "Not specified. This value should be never used.", "Map entity types allow mapping of a group of synonyms to a canonical\nvalue.", @@ -114,21 +611,19 @@ "KIND_UNSPECIFIED", "KIND_MAP", "KIND_LIST" - ], - "description": "Required. Indicates the kind of entity type.", - "type": "string" + ] }, "autoExpansionMode": { - "enumDescriptions": [ - "Auto expansion disabled for the entity.", - "Allows an agent to recognize values that have not been explicitly\nlisted in the entity." - ], "enum": [ "AUTO_EXPANSION_MODE_UNSPECIFIED", "AUTO_EXPANSION_MODE_DEFAULT" ], "description": "Optional. Indicates whether the entity type can be automatically\nexpanded.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Auto expansion disabled for the entity.", + "Allows an agent to recognize values that have not been explicitly\nlisted in the entity." + ] }, "entities": { "description": "Optional. The collection of entities associated with the entity type.", @@ -136,6 +631,10 @@ "items": { "$ref": "EntityTypeEntity" } + }, + "name": { + "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", + "type": "string" } }, "id": "EntityType" @@ -171,30 +670,6 @@ "description": "Corresponds to the `Response` field in API.AI console.", "type": "object", "properties": { - "card": { - "$ref": "IntentMessageCard", - "description": "The card response." - }, - "basicCard": { - "$ref": "IntentMessageBasicCard", - "description": "The basic card response for Actions on Google." - }, - "carouselSelect": { - "$ref": "IntentMessageCarouselSelect", - "description": "The carousel card response for Actions on Google." - }, - "linkOutSuggestion": { - "description": "The link out suggestion chip for Actions on Google.", - "$ref": "IntentMessageLinkOutSuggestion" - }, - "simpleResponses": { - "description": "The voice and text-only responses for Actions on Google.", - "$ref": "IntentMessageSimpleResponses" - }, - "image": { - "description": "The image response.", - "$ref": "IntentMessageImage" - }, "payload": { "additionalProperties": { "description": "Properties of the object.", @@ -204,14 +679,16 @@ "type": "object" }, "text": { - "$ref": "IntentMessageText", - "description": "The text response." + "description": "The text response.", + "$ref": "IntentMessageText" }, "suggestions": { - "$ref": "IntentMessageSuggestions", - "description": "The suggestion chips for Actions on Google." + "description": "The suggestion chips for Actions on Google.", + "$ref": "IntentMessageSuggestions" }, "platform": { + "description": "Optional. The platform that this message is intended for.", + "type": "string", "enumDescriptions": [ "Not specified.", "Facebook.", @@ -233,33 +710,55 @@ "LINE", "VIBER", "ACTIONS_ON_GOOGLE" - ], - "description": "Optional. The platform that this message is intended for.", - "type": "string" + ] }, "listSelect": { - "description": "The list card response for Actions on Google.", - "$ref": "IntentMessageListSelect" + "$ref": "IntentMessageListSelect", + "description": "The list card response for Actions on Google." }, "quickReplies": { "$ref": "IntentMessageQuickReplies", "description": "The quick replies response." + }, + "card": { + "$ref": "IntentMessageCard", + "description": "The card response." + }, + "basicCard": { + "$ref": "IntentMessageBasicCard", + "description": "The basic card response for Actions on Google." + }, + "carouselSelect": { + "description": "The carousel card response for Actions on Google.", + "$ref": "IntentMessageCarouselSelect" + }, + "linkOutSuggestion": { + "$ref": "IntentMessageLinkOutSuggestion", + "description": "The link out suggestion chip for Actions on Google." + }, + "simpleResponses": { + "$ref": "IntentMessageSimpleResponses", + "description": "The voice and text-only responses for Actions on Google." + }, + "image": { + "$ref": "IntentMessageImage", + "description": "The image response." } }, "id": "IntentMessage" }, "ListContextsResponse": { "properties": { + "nextPageToken": { + "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", + "type": "string" + }, "contexts": { "description": "The list of contexts. There will be a maximum number of items\nreturned based on the page_size field in the request.", "type": "array", "items": { "$ref": "Context" } - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", - "type": "string" } }, "id": "ListContextsResponse", @@ -267,14 +766,7 @@ "type": "object" }, "Agent": { - "description": "Represents a conversational agent.", - "type": "object", "properties": { - "classificationThreshold": { - "description": "Optional. To filter out false positive results and still get variety in\nmatched natural language inputs for your agent, you can tune the machine\nlearning classification threshold. If the returned score value is less than\nthe threshold value, then a fallback intent is be triggered or, if there\nare no fallback intents defined, no intent will be triggered. The score\nvalues range from 0.0 (completely uncertain) to 1.0 (completely certain).\nIf set to 0.0, the default of 0.3 is used.", - "format": "float", - "type": "number" - }, "timeZone": { "description": "Required. The time zone of this agent from the\n[time zone database](https://www.iana.org/time-zones), e.g.,\nAmerica/New_York, Europe/Paris.", "type": "string" @@ -323,9 +815,16 @@ "avatarUri": { "description": "Optional. The URI of the agent's avatar.\nAvatars are used throughout API.AI console and in the self-hosted\n[Web Demo](https://dialogflow.com/docs/integrations/web-demo) integration.", "type": "string" + }, + "classificationThreshold": { + "description": "Optional. To filter out false positive results and still get variety in\nmatched natural language inputs for your agent, you can tune the machine\nlearning classification threshold. If the returned score value is less than\nthe threshold value, then a fallback intent is be triggered or, if there\nare no fallback intents defined, no intent will be triggered. The score\nvalues range from 0.0 (completely uncertain) to 1.0 (completely certain).\nIf set to 0.0, the default of 0.3 is used.", + "format": "float", + "type": "number" } }, - "id": "Agent" + "id": "Agent", + "description": "Represents a conversational agent.", + "type": "object" }, "EntityTypeBatch": { "description": "This message is a wrapper around a collection of entity types.", @@ -365,8 +864,8 @@ "type": "object", "properties": { "openUriAction": { - "description": "Required. Action to take when a user taps on the button.", - "$ref": "IntentMessageBasicCardButtonOpenUriAction" + "$ref": "IntentMessageBasicCardButtonOpenUriAction", + "description": "Required. Action to take when a user taps on the button." }, "title": { "description": "Required. The title of the button.", @@ -376,6 +875,8 @@ "id": "IntentMessageBasicCardButton" }, "IntentMessageSimpleResponse": { + "description": "The simple response message containing speech or text.", + "type": "object", "properties": { "displayText": { "description": "Optional. The text to display.", @@ -390,22 +891,12 @@ "type": "string" } }, - "id": "IntentMessageSimpleResponse", - "description": "The simple response message containing speech or text.", - "type": "object" + "id": "IntentMessageSimpleResponse" }, "IntentMessageListSelectItem": { "description": "An item in the list.", "type": "object", "properties": { - "title": { - "description": "Required. The title of the list item.", - "type": "string" - }, - "image": { - "$ref": "IntentMessageImage", - "description": "Optional. The image to display." - }, "description": { "description": "Optional. The main text describing the item.", "type": "string" @@ -413,20 +904,22 @@ "info": { "description": "Required. Additional information about this option.", "$ref": "IntentMessageSelectItemInfo" + }, + "title": { + "description": "Required. The title of the list item.", + "type": "string" + }, + "image": { + "$ref": "IntentMessageImage", + "description": "Optional. The image to display." } }, "id": "IntentMessageListSelectItem" }, "IntentMessageBasicCard": { + "description": "The basic card message. Useful for displaying information.", + "type": "object", "properties": { - "title": { - "description": "Optional. The title of the card.", - "type": "string" - }, - "image": { - "$ref": "IntentMessageImage", - "description": "Optional. The image for the card." - }, "formattedText": { "description": "Required, unless image is present. The body text of the card.", "type": "string" @@ -441,32 +934,20 @@ "subtitle": { "description": "Optional. The subtitle of the card.", "type": "string" - } - }, - "id": "IntentMessageBasicCard", - "description": "The basic card message. Useful for displaying information.", - "type": "object" - }, - "InputAudioConfig": { - "description": "Instructs the speech recognizer how to process the audio content.", - "type": "object", - "properties": { - "sampleRateHertz": { - "description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to [Cloud Speech API documentation](/speech/docs/basics) for more\ndetails.", - "format": "int32", - "type": "integer" }, - "languageCode": { - "description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.", + "title": { + "description": "Optional. The title of the card.", "type": "string" }, - "phraseHints": { - "description": "Optional. The collection of phrase hints which are used to boost accuracy\nof speech recognition.\nRefer to [Cloud Speech API documentation](/speech/docs/basics#phrase-hints)\nfor more details.", - "type": "array", - "items": { - "type": "string" - } - }, + "image": { + "$ref": "IntentMessageImage", + "description": "Optional. The image for the card." + } + }, + "id": "IntentMessageBasicCard" + }, + "InputAudioConfig": { + "properties": { "audioEncoding": { "enumDescriptions": [ "Not specified.", @@ -490,9 +971,27 @@ ], "description": "Required. Audio encoding of the audio content to process.", "type": "string" + }, + "sampleRateHertz": { + "description": "Required. Sample rate (in Hertz) of the audio content sent in the query.\nRefer to [Cloud Speech API documentation](/speech/docs/basics) for more\ndetails.", + "format": "int32", + "type": "integer" + }, + "languageCode": { + "description": "Required. The language of the supplied audio. Dialogflow does not do\ntranslations. See [Language\nSupport](https://dialogflow.com/docs/languages) for a list of the\ncurrently supported language codes. Note that queries in the same session\ndo not necessarily need to specify the same language.", + "type": "string" + }, + "phraseHints": { + "description": "Optional. The collection of phrase hints which are used to boost accuracy\nof speech recognition.\nRefer to [Cloud Speech API documentation](/speech/docs/basics#phrase-hints)\nfor more details.", + "type": "array", + "items": { + "type": "string" + } } }, - "id": "InputAudioConfig" + "id": "InputAudioConfig", + "description": "Instructs the speech recognizer how to process the audio content.", + "type": "object" }, "EntityTypeEntity": { "description": "Optional. Represents an entity.", @@ -531,6 +1030,8 @@ "type": "object" }, "SearchAgentsResponse": { + "description": "The response message for Agents.SearchAgents.", + "type": "object", "properties": { "agents": { "description": "The list of agents. There will be a maximum number of items returned based\non the page_size field in the request.", @@ -544,11 +1045,11 @@ "type": "string" } }, - "id": "SearchAgentsResponse", - "description": "The response message for Agents.SearchAgents.", - "type": "object" + "id": "SearchAgentsResponse" }, "IntentMessageCarouselSelect": { + "description": "The card for presenting a carousel of options to select from.", + "type": "object", "properties": { "items": { "description": "Required. Carousel items.", @@ -558,9 +1059,7 @@ } } }, - "id": "IntentMessageCarouselSelect", - "description": "The card for presenting a carousel of options to select from.", - "type": "object" + "id": "IntentMessageCarouselSelect" }, "BatchCreateEntitiesRequest": { "description": "The request message for EntityTypes.BatchCreateEntities.", @@ -610,8 +1109,6 @@ "id": "TextInput" }, "DetectIntentRequest": { - "description": "The request to detect user's intent.", - "type": "object", "properties": { "inputAudio": { "description": "Optional. The natural language speech audio to be processed. This field\nshould be populated iff `query_input` is set to an input audio config.\nA single request can contain up to 1 minute of speech audio data.", @@ -619,15 +1116,17 @@ "type": "string" }, "queryInput": { - "$ref": "QueryInput", - "description": "Required. The input specification. It can be set to:\n\n1. an audio config\n which instructs the speech recognizer how to process the speech audio,\n\n2. a conversational query in the form of text, or\n\n3. an event that specifies which intent to trigger." + "description": "Required. The input specification. It can be set to:\n\n1. an audio config\n which instructs the speech recognizer how to process the speech audio,\n\n2. a conversational query in the form of text, or\n\n3. an event that specifies which intent to trigger.", + "$ref": "QueryInput" }, "queryParams": { "$ref": "QueryParameters", "description": "Optional. The parameters of this query." } }, - "id": "DetectIntentRequest" + "id": "DetectIntentRequest", + "description": "The request to detect user's intent.", + "type": "object" }, "ListEntityTypesResponse": { "description": "The response message for EntityTypes.ListEntityTypes.", @@ -666,6 +1165,29 @@ "description": "Represents the result of conversational query or event processing.", "type": "object", "properties": { + "fulfillmentMessages": { + "description": "The collection of rich messages to present to the user.", + "type": "array", + "items": { + "$ref": "IntentMessage" + } + }, + "webhookPayload": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.", + "type": "object" + }, + "action": { + "description": "The action name from the matched intent.", + "type": "string" + }, + "webhookSource": { + "description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `source` field returned in the webhook response.", + "type": "string" + }, "fulfillmentText": { "description": "The text to be pronounced to the user or shown on the screen.", "type": "string" @@ -716,31 +1238,8 @@ "type": "string" }, "intent": { - "description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`.", - "$ref": "Intent" - }, - "fulfillmentMessages": { - "description": "The collection of rich messages to present to the user.", - "type": "array", - "items": { - "$ref": "IntentMessage" - } - }, - "webhookPayload": { - "description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `payload` field returned in the webhook response.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - } - }, - "action": { - "description": "The action name from the matched intent.", - "type": "string" - }, - "webhookSource": { - "description": "If the query was fulfilled by a webhook call, this field is set to the\nvalue of the `source` field returned in the webhook response.", - "type": "string" + "$ref": "Intent", + "description": "The intent that matched the conversational query. Some, not\nall fields are filled in this message, including but not limited to:\n`name`, `display_name` and `webhook_state`." } }, "id": "QueryResult" @@ -793,8 +1292,8 @@ "type": "object" }, "geoLocation": { - "$ref": "LatLng", - "description": "Optional. The geo location of this conversational query." + "description": "Optional. The geo location of this conversational query.", + "$ref": "LatLng" }, "resetContexts": { "description": "Optional. Specifies whether to delete all contexts in the current session\nbefore the new ones are activated.", @@ -815,7 +1314,13 @@ "id": "QueryParameters" }, "IntentMessageCard": { + "description": "The card response message.", + "type": "object", "properties": { + "imageUri": { + "description": "Optional. The public URI to an image file for the card.", + "type": "string" + }, "title": { "description": "Optional. The title of the card.", "type": "string" @@ -830,82 +1335,12 @@ "subtitle": { "description": "Optional. The subtitle of the card.", "type": "string" - }, - "imageUri": { - "description": "Optional. The public URI to an image file for the card.", - "type": "string" } }, - "id": "IntentMessageCard", - "description": "The card response message.", - "type": "object" + "id": "IntentMessageCard" }, "Intent": { - "description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.", - "type": "object", "properties": { - "webhookState": { - "description": "Required. Indicates whether webhooks are enabled for the intent.", - "type": "string", - "enumDescriptions": [ - "Webhook is disabled in the agent and in the intent.", - "Webhook is enabled in the agent and in the intent.", - "Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook." - ], - "enum": [ - "WEBHOOK_STATE_UNSPECIFIED", - "WEBHOOK_STATE_ENABLED", - "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" - ] - }, - "inputContextNames": { - "description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.", - "type": "array", - "items": { - "type": "string" - } - }, - "followupIntentInfo": { - "description": "Optional. Collection of information about all followup intents that have\nname of this intent as a root_name.", - "type": "array", - "items": { - "$ref": "IntentFollowupIntentInfo" - } - }, - "displayName": { - "description": "Required. The name of this intent.", - "type": "string" - }, - "rootFollowupIntentName": { - "description": "The unique identifier of the root intent in the chain of followup intents.\nIt identifies the correct followup intents chain for this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", - "type": "string" - }, - "isFallback": { - "description": "Optional. Indicates whether this is a fallback intent.", - "type": "boolean" - }, - "mlEnabled": { - "description": "Optional. Indicates whether Machine Learning is enabled for the intent.\nNote: If `ml_enabled` setting is set to false, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.", - "type": "boolean" - }, - "trainingPhrases": { - "description": "Optional. The collection of examples/templates that the agent is\ntrained on.", - "type": "array", - "items": { - "$ref": "IntentTrainingPhrase" - } - }, - "resetContexts": { - "description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.", - "type": "boolean" - }, - "parameters": { - "description": "Optional. The collection of parameters associated with the intent.", - "type": "array", - "items": { - "$ref": "IntentParameter" - } - }, "events": { "description": "Optional. The collection of event names that trigger the intent.\nIf the collection of input contexts is not empty, all of the contexts must\nbe present in the active user session for an event to trigger this intent.", "type": "array", @@ -972,14 +1407,86 @@ "action": { "description": "Optional. The name of the action associated with the intent.", "type": "string" + }, + "webhookState": { + "enum": [ + "WEBHOOK_STATE_UNSPECIFIED", + "WEBHOOK_STATE_ENABLED", + "WEBHOOK_STATE_ENABLED_FOR_SLOT_FILLING" + ], + "description": "Required. Indicates whether webhooks are enabled for the intent.", + "type": "string", + "enumDescriptions": [ + "Webhook is disabled in the agent and in the intent.", + "Webhook is enabled in the agent and in the intent.", + "Webhook is enabled in the agent and in the intent. Also, each slot\nfilling prompt is forwarded to the webhook." + ] + }, + "inputContextNames": { + "description": "Optional. The list of context names required for this intent to be\ntriggered.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/-/contexts/\u003cContext ID\u003e`.", + "type": "array", + "items": { + "type": "string" + } + }, + "followupIntentInfo": { + "description": "Optional. Collection of information about all followup intents that have\nname of this intent as a root_name.", + "type": "array", + "items": { + "$ref": "IntentFollowupIntentInfo" + } + }, + "displayName": { + "description": "Required. The name of this intent.", + "type": "string" + }, + "rootFollowupIntentName": { + "description": "The unique identifier of the root intent in the chain of followup intents.\nIt identifies the correct followup intents chain for this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", + "type": "string" + }, + "isFallback": { + "description": "Optional. Indicates whether this is a fallback intent.", + "type": "boolean" + }, + "mlEnabled": { + "description": "Optional. Indicates whether Machine Learning is enabled for the intent.\nNote: If `ml_enabled` setting is set to false, then this intent is not\ntaken into account during inference in `ML ONLY` match mode. Also,\nauto-markup in the UI is turned off.", + "type": "boolean" + }, + "trainingPhrases": { + "description": "Optional. The collection of examples/templates that the agent is\ntrained on.", + "type": "array", + "items": { + "$ref": "IntentTrainingPhrase" + } + }, + "resetContexts": { + "description": "Optional. Indicates whether to delete all contexts in the current\nsession when this intent is matched.", + "type": "boolean" + }, + "parameters": { + "description": "Optional. The collection of parameters associated with the intent.", + "type": "array", + "items": { + "$ref": "IntentParameter" + } } }, - "id": "Intent" + "id": "Intent", + "description": "Represents an intent.\nIntents convert a number of user expressions or patterns into an action. An\naction is an extraction of a user command or sentence semantics.", + "type": "object" }, "BatchUpdateEntityTypesRequest": { "description": "The request message for EntityTypes.BatchUpdateEntityTypes.", "type": "object", "properties": { + "entityTypeBatchUri": { + "description": "Warning: Importing entity types from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing entity types to update\nor create. The file format can either be a serialized proto (of\nEntityBatch type) or a JSON object. Note: The URI must start with\n\"gs://\".", + "type": "string" + }, + "entityTypeBatchInline": { + "description": "The collection of entity type to update or create.", + "$ref": "EntityTypeBatch" + }, "languageCode": { "description": "Optional. The language of entity synonyms defined in `entity_types`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", "type": "string" @@ -988,14 +1495,6 @@ "description": "Optional. The mask to control which fields get updated.", "format": "google-fieldmask", "type": "string" - }, - "entityTypeBatchUri": { - "description": "Warning: Importing entity types from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing entity types to update\nor create. The file format can either be a serialized proto (of\nEntityBatch type) or a JSON object. Note: The URI must start with\n\"gs://\".", - "type": "string" - }, - "entityTypeBatchInline": { - "$ref": "EntityTypeBatch", - "description": "The collection of entity type to update or create." } }, "id": "BatchUpdateEntityTypesRequest" @@ -1004,10 +1503,6 @@ "description": "Represents a part of a training phrase.", "type": "object", "properties": { - "entityType": { - "description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.", - "type": "string" - }, "alias": { "description": "Optional. The parameter name for the value extracted from the\nannotated part of the example.", "type": "string" @@ -1019,6 +1514,10 @@ "text": { "description": "Required. The text corresponding to the example or template,\nif there are no annotations. For\nannotated examples, it is the text for one of the example's parts.", "type": "string" + }, + "entityType": { + "description": "Optional. The entity type name prefixed with `@`. This field is\nrequired for the annotated part of the text and applies only to\nexamples.", + "type": "string" } }, "id": "IntentTrainingPhrasePart" @@ -1074,17 +1573,19 @@ "id": "IntentMessageListSelect" }, "IntentMessageSuggestion": { - "description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.", - "type": "object", "properties": { "title": { "description": "Required. The text shown the in the suggestion chip.", "type": "string" } }, - "id": "IntentMessageSuggestion" + "id": "IntentMessageSuggestion", + "description": "The suggestion chip message that the user can tap to quickly post a reply\nto the conversation.", + "type": "object" }, "IntentMessageCarouselSelectItem": { + "description": "An item in the carousel.", + "type": "object", "properties": { "title": { "description": "Required. Title of the carousel item.", @@ -1099,527 +1600,29 @@ "type": "string" }, "info": { - "$ref": "IntentMessageSelectItemInfo", - "description": "Required. Additional info about the option item." + "description": "Required. Additional info about the option item.", + "$ref": "IntentMessageSelectItemInfo" } }, - "id": "IntentMessageCarouselSelectItem", - "description": "An item in the carousel.", - "type": "object" + "id": "IntentMessageCarouselSelectItem" }, "IntentMessageQuickReplies": { - "description": "The quick replies response message.", - "type": "object", "properties": { + "title": { + "description": "Optional. The title of the collection of quick replies.", + "type": "string" + }, "quickReplies": { "description": "Optional. The collection of quick replies.", "type": "array", "items": { "type": "string" } - }, - "title": { - "description": "Optional. The title of the collection of quick replies.", - "type": "string" } }, - "id": "IntentMessageQuickReplies" - }, - "WebhookRequest": { - "description": "The request message for a webhook call.", - "type": "object", - "properties": { - "queryResult": { - "$ref": "QueryResult", - "description": "The result of the conversational query or event processing. Contains the\nsame value as `[Streaming]DetectIntentResponse.query_result`." - }, - "originalDetectIntentRequest": { - "$ref": "OriginalDetectIntentRequest", - "description": "Optional. The contents of the original request that was passed to\n`[Streaming]DetectIntent` call." - }, - "responseId": { - "description": "The unique identifier of the response. Contains the same value as\n`[Streaming]DetectIntentResponse.response_id`.", - "type": "string" - }, - "session": { - "description": "The unique identifier of detectIntent request session.\nCan be used to identify end-user inside webhook implementation.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.", - "type": "string" - } - }, - "id": "WebhookRequest" - }, - "RestoreAgentRequest": { - "description": "The request message for Agents.RestoreAgent.", - "type": "object", - "properties": { - "agentUri": { - "description": "Warning: Restoring agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to restore.\nNote: The URI must start with \"gs://\".", - "type": "string" - }, - "agentContent": { - "description": "The agent to restore.\n\nExample for how to restore an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:restore\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\" \\", - "format": "byte", - "type": "string" - } - }, - "id": "RestoreAgentRequest" - }, - "IntentTrainingPhrase": { - "description": "Represents an example or template that the agent is trained on.", - "type": "object", - "properties": { - "name": { - "description": "Required. The unique identifier of this training phrase.", - "type": "string" - }, - "timesAddedCount": { - "description": "Optional. Indicates how many times this example or template was added to\nthe intent. Each time a developer adds an existing sample by editing an\nintent or training, this counter is increased.", - "format": "int32", - "type": "integer" - }, - "type": { - "enum": [ - "TYPE_UNSPECIFIED", - "EXAMPLE", - "TEMPLATE" - ], - "description": "Required. The type of the training phrase.", - "type": "string", - "enumDescriptions": [ - "Not specified. This value should never be used.", - "Examples do not contain @-prefixed entity type names, but example parts\ncan be annotated with entity types.", - "Templates are not annotated with entity types, but they can contain\n@-prefixed entity type names as substrings." - ] - }, - "parts": { - "description": "Required. The collection of training phrase parts (can be annotated).\nFields: `entity_type`, `alias` and `user_defined` should be populated\nonly for the annotated parts of the training phrase.", - "type": "array", - "items": { - "$ref": "IntentTrainingPhrasePart" - } - } - }, - "id": "IntentTrainingPhrase" - }, - "ListIntentsResponse": { - "description": "The response message for Intents.ListIntents.", - "type": "object", - "properties": { - "intents": { - "description": "The list of agent intents. There will be a maximum number of items\nreturned based on the page_size field in the request.", - "type": "array", - "items": { - "$ref": "Intent" - } - }, - "nextPageToken": { - "description": "Token to retrieve the next page of results, or empty if there are no\nmore results in the list.", - "type": "string" - } - }, - "id": "ListIntentsResponse" - }, - "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", - "type": "object", - "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "format": "double", - "type": "number" - }, - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "format": "double", - "type": "number" - } - }, - "id": "LatLng" - }, - "Context": { - "description": "Represents a context.", - "type": "object", - "properties": { - "lifespanCount": { - "description": "Optional. The number of conversational query requests after which the\ncontext expires. If set to `0` (the default) the context expires\nimmediately. Contexts expire automatically after 10 minutes even if there\nare no matching queries.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.", - "type": "string" - }, - "parameters": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Optional. The collection of parameters associated with this context.\nRefer to [this doc](https://dialogflow.com/docs/actions-and-parameters) for\nsyntax.", - "type": "object" - } - }, - "id": "Context" - }, - "ImportAgentRequest": { - "description": "The request message for Agents.ImportAgent.", - "type": "object", - "properties": { - "agentContent": { - "description": "The agent to import.\n\nExample for how to import an agent via the command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:import\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary \"{\n 'agentContent': '$(cat \u003cagent zip file\u003e | base64 -w 0)'\n }\"", - "format": "byte", - "type": "string" - }, - "agentUri": { - "description": "Warning: Importing agents from a URI is not implemented yet.\nThis feature is coming soon.\n\nThe URI to a Google Cloud Storage file containing the agent to import.\nNote: The URI must start with \"gs://\".", - "type": "string" - } - }, - "id": "ImportAgentRequest" - }, - "BatchUpdateIntentsResponse": { - "description": "The response message for Intents.BatchUpdateIntents.", - "type": "object", - "properties": { - "intents": { - "description": "The collection of updated or created intents.", - "type": "array", - "items": { - "$ref": "Intent" - } - } - }, - "id": "BatchUpdateIntentsResponse" - }, - "IntentParameter": { - "description": "Represents intent parameters.", - "type": "object", - "properties": { - "prompts": { - "description": "Optional. The collection of prompts that the agent can present to the\nuser in order to collect value for the parameter.", - "type": "array", - "items": { - "type": "string" - } - }, - "defaultValue": { - "description": "Optional. The default value to use when the `value` yields an empty\nresult.\nDefault values can be extracted from contexts by using the following\nsyntax: `#context_name.parameter_name`.", - "type": "string" - }, - "mandatory": { - "description": "Optional. Indicates whether the parameter is required. That is,\nwhether the intent cannot be completed without collecting the parameter\nvalue.", - "type": "boolean" - }, - "name": { - "description": "The unique identifier of this parameter.", - "type": "string" - }, - "isList": { - "description": "Optional. Indicates whether the parameter represents a list of values.", - "type": "boolean" - }, - "value": { - "description": "Optional. The definition of the parameter value. It can be:\n- a constant string,\n- a parameter value defined as `$parameter_name`,\n- an original parameter value defined as `$parameter_name.original`,\n- a parameter value from some context defined as\n `#context_name.parameter_name`.", - "type": "string" - }, - "displayName": { - "description": "Required. The name of the parameter.", - "type": "string" - }, - "entityTypeDisplayName": { - "description": "Optional. The name of the entity type, prefixed with `@`, that\ndescribes values of the parameter. If the parameter is\nrequired, this must be provided.", - "type": "string" - } - }, - "id": "IntentParameter" - }, - "ExportAgentResponse": { - "description": "The response message for Agents.ExportAgent.", - "type": "object", - "properties": { - "agentUri": { - "description": "The URI to a file containing the exported agent. This field is populated\nonly if `agent_uri` is specified in `ExportAgentRequest`.", - "type": "string" - }, - "agentContent": { - "description": "The exported agent.\n\nExample for how to export an agent to a zip file via a command line:\n\ncurl \\\n 'https://dialogflow.googleapis.com/v2beta1/projects/\u003cproject_name\u003e/agent:export'\\\n -X POST \\\n -H 'Authorization: Bearer '$(gcloud auth print-access-token) \\\n -H 'Accept: application/json' \\\n -H 'Content-Type: application/json' \\\n --compressed \\\n --data-binary '{}' \\\n| grep agentContent | sed -e 's/.*\"agentContent\": \"\\([^\"]*\\)\".*/\\1/' \\\n| base64 --decode \u003e \u003cagent zip file\u003e", - "format": "byte", - "type": "string" - } - }, - "id": "ExportAgentResponse" - }, - "IntentMessageBasicCardButtonOpenUriAction": { - "description": "Opens the given URI.", - "type": "object", - "properties": { - "uri": { - "description": "Required. The HTTP or HTTPS scheme URI.", - "type": "string" - } - }, - "id": "IntentMessageBasicCardButtonOpenUriAction" - }, - "IntentMessageImage": { - "properties": { - "imageUri": { - "description": "Optional. The public URI to an image file.", - "type": "string" - } - }, - "id": "IntentMessageImage", - "description": "The image response message.", + "id": "IntentMessageQuickReplies", + "description": "The quick replies response message.", "type": "object" - }, - "BatchUpdateIntentsRequest": { - "description": "The request message for Intents.BatchUpdateIntents.", - "type": "object", - "properties": { - "intentBatchUri": { - "description": "Warning: Importing intents from a URI is not implemented yet.\nThis feature is coming soon.\nThe URI to a Google Cloud Storage file containing intents to update or\ncreate. The file format can either be a serialized proto (of IntentBatch\ntype) or JSON object. Note: The URI must start with \"gs://\".", - "type": "string" - }, - "intentView": { - "enumDescriptions": [ - "Training phrases field is not populated in the response.", - "All fields are populated." - ], - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "description": "Optional. The resource view to apply to the returned intent.", - "type": "string" - }, - "intentBatchInline": { - "description": "The collection of intents to update or create.", - "$ref": "IntentBatch" - }, - "languageCode": { - "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intents`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "BatchUpdateIntentsRequest" - }, - "TrainAgentRequest": { - "description": "The request message for Agents.TrainAgent.", - "type": "object", - "properties": {}, - "id": "TrainAgentRequest" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "SessionEntityType": { - "description": "Represents a session entity type.\n\nExtends or replaces a developer entity type at the user session level (we\nrefer to the entity types defined at the agent level as \"developer entity\ntypes\").\n\nNote: session entity types apply to all queries, regardless of the language.", - "type": "object", - "properties": { - "name": { - "description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.", - "type": "string" - }, - "entityOverrideMode": { - "enum": [ - "ENTITY_OVERRIDE_MODE_UNSPECIFIED", - "ENTITY_OVERRIDE_MODE_OVERRIDE", - "ENTITY_OVERRIDE_MODE_SUPPLEMENT" - ], - "description": "Required. Indicates whether the additional data should override or\nsupplement the developer entity type definition.", - "type": "string", - "enumDescriptions": [ - "Not specified. This value should be never used.", - "The collection of session entities overrides the collection of entities\nin the corresponding developer entity type.", - "The collection of session entities extends the collection of entities in\nthe corresponding developer entity type.\nCalls to `ListSessionEntityTypes`, `GetSessionEntityType`,\n`CreateSessionEntityType` and `UpdateSessionEntityType` return the full\ncollection of entities from the developer entity type in the agent's\ndefault language and the session entity type." - ] - }, - "entities": { - "description": "Required. The collection of entities associated with this session entity\ntype.", - "type": "array", - "items": { - "$ref": "EntityTypeEntity" - } - } - }, - "id": "SessionEntityType" - }, - "IntentMessageText": { - "description": "The text response message.", - "type": "object", - "properties": { - "text": { - "description": "Optional. The collection of the agent's responses.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "IntentMessageText" - }, - "BatchUpdateEntitiesRequest": { - "description": "The response message for EntityTypes.BatchCreateEntities.", - "type": "object", - "properties": { - "entities": { - "description": "Required. The collection of new entities to replace the existing entities.", - "type": "array", - "items": { - "$ref": "EntityTypeEntity" - } - }, - "languageCode": { - "description": "Optional. The language of entity synonyms defined in `entities`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "BatchUpdateEntitiesRequest" - }, - "WebhookResponse": { - "description": "The response message for a webhook call.", - "type": "object", - "properties": { - "fulfillmentMessages": { - "description": "Optional. The collection of rich messages to present to the user. This\nvalue is passed directly to `QueryResult.fulfillment_messages`.", - "type": "array", - "items": { - "$ref": "IntentMessage" - } - }, - "payload": { - "description": "Optional. This value is passed directly to `QueryResult.webhook_payload`.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - } - }, - "source": { - "description": "Optional. This value is passed directly to `QueryResult.webhook_source`.", - "type": "string" - }, - "followupEventInput": { - "description": "Optional. Makes the platform immediately invoke another `DetectIntent` call\ninternally with the specified event as input.", - "$ref": "EventInput" - }, - "outputContexts": { - "description": "Optional. The collection of output contexts. This value is passed directly\nto `QueryResult.output_contexts`.", - "type": "array", - "items": { - "$ref": "Context" - } - }, - "fulfillmentText": { - "description": "Optional. The text to be shown on the screen. This value is passed directly\nto `QueryResult.fulfillment_text`.", - "type": "string" - } - }, - "id": "WebhookResponse" - }, - "BatchDeleteIntentsRequest": { - "description": "The request message for Intents.BatchDeleteIntents.", - "type": "object", - "properties": { - "intents": { - "description": "Required. The collection of intents to delete. Only intent `name` must be\nfilled in.", - "type": "array", - "items": { - "$ref": "Intent" - } - } - }, - "id": "BatchDeleteIntentsRequest" - }, - "QueryInput": { - "description": "Represents the query input. It can contain either:\n\n1. An audio config which\n instructs the speech recognizer how to process the speech audio.\n\n2. A conversational query in the form of text,.\n\n3. An event that specifies which intent to trigger.", - "type": "object", - "properties": { - "event": { - "$ref": "EventInput", - "description": "The event to be processed." - }, - "text": { - "description": "The natural language text to be processed.", - "$ref": "TextInput" - }, - "audioConfig": { - "$ref": "InputAudioConfig", - "description": "Instructs the speech recognizer how to process the speech audio." - } - }, - "id": "QueryInput" - }, - "DetectIntentResponse": { - "properties": { - "webhookStatus": { - "$ref": "Status", - "description": "Specifies the status of the webhook request. `webhook_status`\nis never populated in webhook requests." - }, - "responseId": { - "description": "The unique identifier of the response. It can be used to\nlocate a response in the training example set or for reporting issues.", - "type": "string" - }, - "queryResult": { - "$ref": "QueryResult", - "description": "The results of the conversational query or event processing." - } - }, - "id": "DetectIntentResponse", - "description": "The message returned from the DetectIntent method.", - "type": "object" - }, - "IntentFollowupIntentInfo": { - "description": "Represents a single followup intent in the chain.", - "type": "object", - "properties": { - "followupIntentName": { - "description": "The unique identifier of the followup intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", - "type": "string" - }, - "parentFollowupIntentName": { - "description": "The unique identifier of the followup intent parent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", - "type": "string" - } - }, - "id": "IntentFollowupIntentInfo" - }, - "ExportAgentRequest": { - "properties": { - "agentUri": { - "description": "Warning: Exporting agents to a URI is not implemented yet.\nThis feature is coming soon.\n\nOptional. The Google Cloud Storage URI to export the agent to.\nNote: The URI must start with\n\"gs://\". If left unspecified, the serialized agent is returned inline.", - "type": "string" - } - }, - "id": "ExportAgentRequest", - "description": "The request message for Agents.ExportAgent.", - "type": "object" - }, - "IntentMessageLinkOutSuggestion": { - "description": "The suggestion chip message that allows the user to jump out to the app\nor website associated with this agent.", - "type": "object", - "properties": { - "destinationName": { - "description": "Required. The name of the app or site this chip is linking to.", - "type": "string" - }, - "uri": { - "description": "Required. The URI of the app or site to open when the user taps the\nsuggestion chip.", - "type": "string" - } - }, - "id": "IntentMessageLinkOutSuggestion" } }, "protocol": "rest", @@ -1646,37 +1649,95 @@ "ownerName": "Google", "resources": { "projects": { - "methods": { - "getAgent": { - "flatPath": "v2beta1/projects/{projectsId}/agent", - "path": "v2beta1/{+parent}/agent", - "id": "dialogflow.projects.getAgent", - "description": "Retrieves the specified agent.", - "response": { - "$ref": "Agent" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The project that the agent to fetch is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - }, "resources": { "agent": { "methods": { + "export": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent:export", + "path": "v2beta1/{+parent}/agent:export", + "id": "dialogflow.projects.agent.export", + "request": { + "$ref": "ExportAgentRequest" + }, + "description": "Exports the specified agent to a ZIP file.\n\n\nOperation \u003cresponse: ExportAgentResponse,\n metadata: google.protobuf.Struct\u003e" + }, + "restore": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "location": "path", + "description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent:restore", + "path": "v2beta1/{+parent}/agent:restore", + "id": "dialogflow.projects.agent.restore", + "request": { + "$ref": "RestoreAgentRequest" + }, + "description": "Restores the specified agent from a ZIP file.\n\nReplaces the current agent version with a new one. All the intents and\nentity types in the older version are deleted.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e" + }, + "import": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent:import", + "path": "v2beta1/{+parent}/agent:import", + "id": "dialogflow.projects.agent.import", + "description": "Imports the specified agent from a ZIP file.\n\nUploads new intents and entity types without deleting the existing ones.\nIntents and entity types with the same name are replaced with the new\nversions from ImportAgentRequest.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", + "request": { + "$ref": "ImportAgentRequest" + } + }, "search": { + "description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections).", "response": { "$ref": "SearchAgentsResponse" }, @@ -1685,23 +1746,23 @@ ], "httpMethod": "GET", "parameters": { - "parent": { - "location": "path", - "description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "type": "string", - "location": "query" - }, "pageSize": { "location": "query", "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", "format": "int32", "type": "integer" + }, + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The project to list agents from.\nFormat: `projects/\u003cProject ID or '-'\u003e`.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "Optional. The next_page_token value returned from a previous list request.", + "type": "string" } }, "scopes": [ @@ -1709,8 +1770,7 @@ ], "flatPath": "v2beta1/projects/{projectsId}/agent:search", "path": "v2beta1/{+parent}/agent:search", - "id": "dialogflow.projects.agent.search", - "description": "Returns the list of agents.\n\nSince there is at most one conversational agent per project, this method is\nuseful primarily for listing all agents across projects the caller has\naccess to. One can achieve that with a wildcard project collection id \"-\".\nRefer to [List\nSub-Collections](https://cloud.google.com/apis/design/design_patterns#list_sub-collections)." + "id": "dialogflow.projects.agent.search" }, "train": { "request": { @@ -1739,708 +1799,14 @@ "flatPath": "v2beta1/projects/{projectsId}/agent:train", "path": "v2beta1/{+parent}/agent:train", "id": "dialogflow.projects.agent.train" - }, - "export": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Required. The project that the agent to export is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent:export", - "path": "v2beta1/{+parent}/agent:export", - "id": "dialogflow.projects.agent.export", - "request": { - "$ref": "ExportAgentRequest" - }, - "description": "Exports the specified agent to a ZIP file.\n\n\nOperation \u003cresponse: ExportAgentResponse,\n metadata: google.protobuf.Struct\u003e" - }, - "restore": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The project that the agent to restore is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent:restore", - "path": "v2beta1/{+parent}/agent:restore", - "id": "dialogflow.projects.agent.restore", - "request": { - "$ref": "RestoreAgentRequest" - }, - "description": "Restores the specified agent from a ZIP file.\n\nReplaces the current agent version with a new one. All the intents and\nentity types in the older version are deleted.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e" - }, - "import": { - "description": "Imports the specified agent from a ZIP file.\n\nUploads new intents and entity types without deleting the existing ones.\nIntents and entity types with the same name are replaced with the new\nversions from ImportAgentRequest.\n\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", - "request": { - "$ref": "ImportAgentRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "Required. The project that the agent to import is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/agent:import", - "path": "v2beta1/{+parent}/agent:import", - "id": "dialogflow.projects.agent.import" } }, "resources": { - "entityTypes": { - "methods": { - "delete": { - "description": "Deletes the specified entity type.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the entity type to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.agent.entityTypes.delete" - }, - "list": { - "description": "Returns the list of all entity types in the specified agent.", - "httpMethod": "GET", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ListEntityTypesResponse" - }, - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. The next_page_token value returned from a previous list request.", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "location": "path", - "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent$" - }, - "languageCode": { - "location": "query", - "description": "Optional. The language to list entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes", - "id": "dialogflow.projects.agent.entityTypes.list", - "path": "v2beta1/{+parent}/entityTypes" - }, - "batchDelete": { - "path": "v2beta1/{+parent}/entityTypes:batchDelete", - "id": "dialogflow.projects.agent.entityTypes.batchDelete", - "request": { - "$ref": "BatchDeleteEntityTypesRequest" - }, - "description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "pattern": "^projects/[^/]+/agent$", - "location": "path", - "description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete" - }, - "create": { - "response": { - "$ref": "EntityType" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "location": "path", - "description": "Required. The agent to create a entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent$" - }, - "languageCode": { - "location": "query", - "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes", - "path": "v2beta1/{+parent}/entityTypes", - "id": "dialogflow.projects.agent.entityTypes.create", - "description": "Creates an entity type in the specified agent.", - "request": { - "$ref": "EntityType" - } - }, - "get": { - "description": "Retrieves the specified entity type.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "EntityType" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "location": "path", - "description": "Required. The name of the entity type.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.", - "required": true, - "type": "string" - }, - "languageCode": { - "location": "query", - "description": "Optional. The language to retrieve entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", - "id": "dialogflow.projects.agent.entityTypes.get", - "path": "v2beta1/{+name}" - }, - "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "EntityType" - }, - "parameters": { - "languageCode": { - "location": "query", - "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - }, - "updateMask": { - "location": "query", - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - }, - "name": { - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "location": "path", - "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", - "id": "dialogflow.projects.agent.entityTypes.patch", - "path": "v2beta1/{+name}", - "request": { - "$ref": "EntityType" - }, - "description": "Updates the specified entity type." - }, - "batchUpdate": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "pattern": "^projects/[^/]+/agent$", - "location": "path", - "description": "Required. The name of the agent to update or create entity types in.\nFormat: `projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate", - "path": "v2beta1/{+parent}/entityTypes:batchUpdate", - "id": "dialogflow.projects.agent.entityTypes.batchUpdate", - "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e", - "request": { - "$ref": "BatchUpdateEntityTypesRequest" - } - } - }, - "resources": { - "entities": { - "methods": { - "batchUpdate": { - "description": "Updates entities in the specified entity type (replaces the existing\ncollection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", - "request": { - "$ref": "BatchUpdateEntitiesRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "Required. The name of the entity type to update the entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate", - "path": "v2beta1/{+parent}/entities:batchUpdate", - "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate" - }, - "batchDelete": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the entity type to delete entries for. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete", - "path": "v2beta1/{+parent}/entities:batchDelete", - "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete", - "request": { - "$ref": "BatchDeleteEntitiesRequest" - }, - "description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e" - }, - "batchCreate": { - "request": { - "$ref": "BatchCreateEntitiesRequest" - }, - "description": "Creates multiple new entities in the specified entity type (extends the\nexisting collection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty\u003e", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "parent": { - "location": "path", - "description": "Required. The name of the entity type to create entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate", - "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate", - "path": "v2beta1/{+parent}/entities:batchCreate" - } - } - } - } - }, - "intents": { - "methods": { - "batchDelete": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "parent": { - "location": "path", - "description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete", - "id": "dialogflow.projects.agent.intents.batchDelete", - "path": "v2beta1/{+parent}/intents:batchDelete", - "request": { - "$ref": "BatchDeleteIntentsRequest" - }, - "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e" - }, - "create": { - "response": { - "$ref": "Intent" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "languageCode": { - "location": "query", - "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - }, - "intentView": { - "location": "query", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "description": "Optional. The resource view to apply to the returned intent.", - "type": "string" - }, - "parent": { - "location": "path", - "description": "Required. The agent to create a intent for.\nFormat: `projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/intents", - "path": "v2beta1/{+parent}/intents", - "id": "dialogflow.projects.agent.intents.create", - "request": { - "$ref": "Intent" - }, - "description": "Creates an intent in the specified agent." - }, - "get": { - "description": "Retrieves the specified intent.", - "response": { - "$ref": "Intent" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/intents/[^/]+$" - }, - "intentView": { - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "description": "Optional. The resource view to apply to the returned intent.", - "type": "string", - "location": "query" - }, - "languageCode": { - "description": "Optional. The language to retrieve training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.agent.intents.get" - }, - "patch": { - "request": { - "$ref": "Intent" - }, - "description": "Updates the specified intent.", - "response": { - "$ref": "Intent" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "intentView": { - "location": "query", - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "description": "Optional. The resource view to apply to the returned intent.", - "type": "string" - }, - "languageCode": { - "location": "query", - "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", - "type": "string" - }, - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/intents/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.agent.intents.patch" - }, - "batchUpdate": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate", - "path": "v2beta1/{+parent}/intents:batchUpdate", - "id": "dialogflow.projects.agent.intents.batchUpdate", - "request": { - "$ref": "BatchUpdateIntentsRequest" - }, - "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e" - }, - "delete": { - "description": "Deletes the specified intent.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Required. The name of the intent to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/intents/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.agent.intents.delete" - }, - "list": { - "description": "Returns the list of all intents in the specified agent.", - "response": { - "$ref": "ListIntentsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", - "format": "int32", - "type": "integer" - }, - "intentView": { - "enum": [ - "INTENT_VIEW_UNSPECIFIED", - "INTENT_VIEW_FULL" - ], - "description": "Optional. The resource view to apply to the returned intent.", - "type": "string", - "location": "query" - }, - "parent": { - "pattern": "^projects/[^/]+/agent$", - "location": "path", - "description": "Required. The agent to list all intents from.\nFormat: `projects/\u003cProject ID\u003e/agent`.", - "required": true, - "type": "string" - }, - "languageCode": { - "description": "Optional. The language to list training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent before they can be used.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/agent/intents", - "path": "v2beta1/{+parent}/intents", - "id": "dialogflow.projects.agent.intents.list" - } - } - }, "sessions": { "resources": { "entityTypes": { "methods": { - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "location": "path", - "description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", - "id": "dialogflow.projects.agent.sessions.entityTypes.delete", - "path": "v2beta1/{+name}", - "description": "Deletes the specified session entity type." - }, "list": { - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes", - "path": "v2beta1/{+parent}/entityTypes", - "id": "dialogflow.projects.agent.sessions.entityTypes.list", "description": "Returns the list of all session entity types in the specified session.", "response": { "$ref": "ListSessionEntityTypesResponse" @@ -2453,25 +1819,28 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "pageToken": { - "description": "Optional. The next_page_token value returned from a previous list request.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", - "format": "int32", - "type": "integer" - }, "parent": { "description": "Required. The session to list all session entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.", "required": true, "type": "string", "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional. The next_page_token value returned from a previous list request.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", + "format": "int32", + "type": "integer" } - } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes", + "path": "v2beta1/{+parent}/entityTypes", + "id": "dialogflow.projects.agent.sessions.entityTypes.list" }, "get": { "description": "Retrieves the specified session entity type.", @@ -2499,9 +1868,6 @@ "path": "v2beta1/{+name}" }, "patch": { - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.agent.sessions.entityTypes.patch", "description": "Updates the specified session entity type.", "request": { "$ref": "SessionEntityType" @@ -2518,19 +1884,22 @@ ], "parameters": { "name": { - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", - "location": "path", "description": "Required. The unique identifier of this session entity type. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", + "location": "path" }, "updateMask": { + "location": "query", "description": "Optional. The mask to control which fields get updated.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" } - } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.agent.sessions.entityTypes.patch" }, "create": { "request": { @@ -2546,11 +1915,11 @@ "httpMethod": "POST", "parameters": { "parent": { + "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "description": "Required. The session to create a session entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$" + "type": "string" } }, "scopes": [ @@ -2559,13 +1928,62 @@ "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes", "path": "v2beta1/{+parent}/entityTypes", "id": "dialogflow.projects.agent.sessions.entityTypes.create" + }, + "delete": { + "description": "Deletes the specified session entity type.", + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "description": "Required. The name of the entity type to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/entityTypes/\u003cEntity Type\nDisplay Name\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/sessions/[^/]+/entityTypes/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/entityTypes/{entityTypesId}", + "id": "dialogflow.projects.agent.sessions.entityTypes.delete", + "path": "v2beta1/{+name}" } } }, "contexts": { "methods": { + "delete": { + "description": "Deletes the specified context.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.agent.sessions.contexts.delete" + }, "list": { - "description": "Returns the list of all contexts in the specified session.", "response": { "$ref": "ListContextsResponse" }, @@ -2590,18 +2008,18 @@ "location": "query" }, "pageSize": { + "location": "query", "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" } }, "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts", "path": "v2beta1/{+parent}/contexts", - "id": "dialogflow.projects.agent.sessions.contexts.list" + "id": "dialogflow.projects.agent.sessions.contexts.list", + "description": "Returns the list of all contexts in the specified session." }, "get": { - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", "id": "dialogflow.projects.agent.sessions.contexts.get", "path": "v2beta1/{+name}", "description": "Retrieves the specified context.", @@ -2623,7 +2041,8 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}" }, "patch": { "response": { @@ -2634,18 +2053,18 @@ ], "httpMethod": "PATCH", "parameters": { - "updateMask": { - "description": "Optional. The mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, "name": { - "location": "path", "description": "Required. The unique identifier of the context. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.\nNote: The Context ID is always converted to lowercase.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$" + "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", + "location": "path" + }, + "updateMask": { + "location": "query", + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "type": "string" } }, "scopes": [ @@ -2660,10 +2079,6 @@ "description": "Updates the specified context." }, "create": { - "description": "Creates a context.", - "request": { - "$ref": "Context" - }, "response": { "$ref": "Context" }, @@ -2685,31 +2100,10 @@ }, "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts", "path": "v2beta1/{+parent}/contexts", - "id": "dialogflow.projects.agent.sessions.contexts.create" - }, - "delete": { - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts/{contextsId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.agent.sessions.contexts.delete", - "description": "Deletes the specified context.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Required. The name of the context to delete. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e/contexts/\u003cContext ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+/contexts/[^/]+$", - "location": "path" - } + "id": "dialogflow.projects.agent.sessions.contexts.create", + "description": "Creates a context.", + "request": { + "$ref": "Context" } } } @@ -2717,9 +2111,6 @@ }, "methods": { "deleteContexts": { - "path": "v2beta1/{+parent}/contexts", - "id": "dialogflow.projects.agent.sessions.deleteContexts", - "description": "Deletes all active contexts in the specified session.", "response": { "$ref": "Empty" }, @@ -2732,22 +2123,19 @@ ], "parameters": { "parent": { - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", "location": "path", "description": "Required. The name of the session to delete all contexts from. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/agent/sessions/[^/]+$" } }, - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts" + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}/contexts", + "path": "v2beta1/{+parent}/contexts", + "id": "dialogflow.projects.agent.sessions.deleteContexts", + "description": "Deletes all active contexts in the specified session." }, "detectIntent": { - "path": "v2beta1/{+session}:detectIntent", - "id": "dialogflow.projects.agent.sessions.detectIntent", - "description": "Processes a natural language query and returns structured, actionable data\nas a result. This method is not idempotent, because it may cause contexts\nand session entity types to be updated, which in turn might affect\nresults of future queries.", - "request": { - "$ref": "DetectIntentRequest" - }, "response": { "$ref": "DetectIntentResponse" }, @@ -2760,14 +2148,602 @@ ], "parameters": { "session": { + "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", + "location": "path", "description": "Required. The name of the session this query is sent to. Format:\n`projects/\u003cProject ID\u003e/agent/sessions/\u003cSession ID\u003e`.\nIt's up to the API caller to choose an appropriate session ID. It can be\na random number or some type of user identifier (preferably hashed).\nThe length of the session ID must not exceed 36 bytes.", "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent", + "path": "v2beta1/{+session}:detectIntent", + "id": "dialogflow.projects.agent.sessions.detectIntent", + "description": "Processes a natural language query and returns structured, actionable data\nas a result. This method is not idempotent, because it may cause contexts\nand session entity types to be updated, which in turn might affect\nresults of future queries.", + "request": { + "$ref": "DetectIntentRequest" + } + } + } + }, + "entityTypes": { + "methods": { + "delete": { + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.agent.entityTypes.delete", + "description": "Deletes the specified entity type.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", + "location": "path", + "description": "Required. The name of the entity type to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns the list of all entity types in the specified agent.", + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListEntityTypesResponse" + }, + "parameters": { + "languageCode": { + "location": "query", + "description": "Optional. The language to list entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string" + }, + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", "type": "string", - "pattern": "^projects/[^/]+/agent/sessions/[^/]+$", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "Required. The agent to list all entity types from.\nFormat: `projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", "location": "path" } }, - "flatPath": "v2beta1/projects/{projectsId}/agent/sessions/{sessionsId}:detectIntent" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes", + "id": "dialogflow.projects.agent.entityTypes.list", + "path": "v2beta1/{+parent}/entityTypes" + }, + "batchDelete": { + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchDelete", + "path": "v2beta1/{+parent}/entityTypes:batchDelete", + "id": "dialogflow.projects.agent.entityTypes.batchDelete", + "request": { + "$ref": "BatchDeleteEntityTypesRequest" + }, + "description": "Deletes entity types in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes", + "path": "v2beta1/{+parent}/entityTypes", + "id": "dialogflow.projects.agent.entityTypes.create", + "description": "Creates an entity type in the specified agent.", + "request": { + "$ref": "EntityType" + }, + "response": { + "$ref": "EntityType" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "description": "Required. The agent to create a entity type for.\nFormat: `projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", + "location": "path" + }, + "languageCode": { + "location": "query", + "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string" + } + } + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "EntityType" + }, + "parameters": { + "languageCode": { + "description": "Optional. The language to retrieve entity synonyms for. If not specified,\nthe agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string", + "location": "query" + }, + "name": { + "description": "Required. The name of the entity type.\nFormat: `projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntityType ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", + "id": "dialogflow.projects.agent.entityTypes.get", + "path": "v2beta1/{+name}", + "description": "Retrieves the specified entity type." + }, + "patch": { + "request": { + "$ref": "EntityType" + }, + "description": "Updates the specified entity type.", + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "EntityType" + }, + "parameters": { + "name": { + "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", + "location": "path", + "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of the entity type. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", + "required": true, + "type": "string" + }, + "languageCode": { + "description": "Optional. The language of entity synonyms defined in `entity_type`. If not\nspecified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string", + "location": "query" + }, + "updateMask": { + "location": "query", + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}", + "id": "dialogflow.projects.agent.entityTypes.patch", + "path": "v2beta1/{+name}" + }, + "batchUpdate": { + "description": "Updates/Creates multiple entity types in the specified agent.\n\nOperation \u003cresponse: BatchUpdateEntityTypesResponse,\n metadata: google.protobuf.Struct\u003e", + "request": { + "$ref": "BatchUpdateEntityTypesRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "description": "Required. The name of the agent to update or create entity types in.\nFormat: `projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", + "location": "path" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes:batchUpdate", + "path": "v2beta1/{+parent}/entityTypes:batchUpdate", + "id": "dialogflow.projects.agent.entityTypes.batchUpdate" + } + }, + "resources": { + "entities": { + "methods": { + "batchCreate": { + "id": "dialogflow.projects.agent.entityTypes.entities.batchCreate", + "path": "v2beta1/{+parent}/entities:batchCreate", + "request": { + "$ref": "BatchCreateEntitiesRequest" + }, + "description": "Creates multiple new entities in the specified entity type (extends the\nexisting collection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty\u003e", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "parent": { + "location": "path", + "description": "Required. The name of the entity type to create entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchCreate" + }, + "batchUpdate": { + "description": "Updates entities in the specified entity type (replaces the existing\ncollection of entries).\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", + "request": { + "$ref": "BatchUpdateEntitiesRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", + "location": "path", + "description": "Required. The name of the entity type to update the entities in. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchUpdate", + "path": "v2beta1/{+parent}/entities:batchUpdate", + "id": "dialogflow.projects.agent.entityTypes.entities.batchUpdate" + }, + "batchDelete": { + "request": { + "$ref": "BatchDeleteEntitiesRequest" + }, + "description": "Deletes entities in the specified entity type.\n\nOperation \u003cresponse: google.protobuf.Empty,\n metadata: google.protobuf.Struct\u003e", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Required. The name of the entity type to delete entries for. Format:\n`projects/\u003cProject ID\u003e/agent/entityTypes/\u003cEntity Type ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/entityTypes/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/entityTypes/{entityTypesId}/entities:batchDelete", + "path": "v2beta1/{+parent}/entities:batchDelete", + "id": "dialogflow.projects.agent.entityTypes.entities.batchDelete" + } + } + } + } + }, + "intents": { + "methods": { + "get": { + "description": "Retrieves the specified intent.", + "response": { + "$ref": "Intent" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "languageCode": { + "description": "Optional. The language to retrieve training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string", + "location": "query" + }, + "name": { + "description": "Required. The name of the intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/intents/[^/]+$", + "location": "path" + }, + "intentView": { + "location": "query", + "enum": [ + "INTENT_VIEW_UNSPECIFIED", + "INTENT_VIEW_FULL" + ], + "description": "Optional. The resource view to apply to the returned intent.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.agent.intents.get" + }, + "patch": { + "response": { + "$ref": "Intent" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "intentView": { + "enum": [ + "INTENT_VIEW_UNSPECIFIED", + "INTENT_VIEW_FULL" + ], + "description": "Optional. The resource view to apply to the returned intent.", + "type": "string", + "location": "query" + }, + "languageCode": { + "location": "query", + "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string" + }, + "updateMask": { + "description": "Optional. The mask to control which fields get updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "name": { + "description": "Required for all methods except `create` (`create` populates the name\nautomatically.\nThe unique identifier of this intent.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/intents/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.agent.intents.patch", + "request": { + "$ref": "Intent" + }, + "description": "Updates the specified intent." + }, + "batchUpdate": { + "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchUpdate", + "path": "v2beta1/{+parent}/intents:batchUpdate", + "id": "dialogflow.projects.agent.intents.batchUpdate", + "request": { + "$ref": "BatchUpdateIntentsRequest" + }, + "description": "Updates/Creates multiple intents in the specified agent.\n\nOperation \u003cresponse: BatchUpdateIntentsResponse\u003e", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Required. The name of the agent to update or create intents in.\nFormat: `projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "delete": { + "flatPath": "v2beta1/projects/{projectsId}/agent/intents/{intentsId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.agent.intents.delete", + "description": "Deletes the specified intent.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Required. The name of the intent to delete.\nFormat: `projects/\u003cProject ID\u003e/agent/intents/\u003cIntent ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent/intents/[^/]+$", + "location": "path" + } + } + }, + "list": { + "response": { + "$ref": "ListIntentsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "pageToken": { + "description": "Optional. The next_page_token value returned from a previous list request.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of items to return in a single page. By\ndefault 100 and at most 1000.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "intentView": { + "enum": [ + "INTENT_VIEW_UNSPECIFIED", + "INTENT_VIEW_FULL" + ], + "description": "Optional. The resource view to apply to the returned intent.", + "type": "string", + "location": "query" + }, + "parent": { + "description": "Required. The agent to list all intents from.\nFormat: `projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", + "location": "path" + }, + "languageCode": { + "location": "query", + "description": "Optional. The language to list training phrases, parameters and rich\nmessages for. If not specified, the agent's default language is used.\n[More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent before they can be used.", + "type": "string" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/agent/intents", + "path": "v2beta1/{+parent}/intents", + "id": "dialogflow.projects.agent.intents.list", + "description": "Returns the list of all intents in the specified agent." + }, + "batchDelete": { + "request": { + "$ref": "BatchDeleteIntentsRequest" + }, + "description": "Deletes intents in the specified agent.\n\nOperation \u003cresponse: google.protobuf.Empty\u003e", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "parent": { + "description": "Required. The name of the agent to delete all entities types for. Format:\n`projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/agent$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/intents:batchDelete", + "id": "dialogflow.projects.agent.intents.batchDelete", + "path": "v2beta1/{+parent}/intents:batchDelete" + }, + "create": { + "response": { + "$ref": "Intent" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "intentView": { + "enum": [ + "INTENT_VIEW_UNSPECIFIED", + "INTENT_VIEW_FULL" + ], + "description": "Optional. The resource view to apply to the returned intent.", + "type": "string", + "location": "query" + }, + "parent": { + "pattern": "^projects/[^/]+/agent$", + "location": "path", + "description": "Required. The agent to create a intent for.\nFormat: `projects/\u003cProject ID\u003e/agent`.", + "required": true, + "type": "string" + }, + "languageCode": { + "description": "Optional. The language of training phrases, parameters and rich messages\ndefined in `intent`. If not specified, the agent's default language is\nused. [More than a dozen\nlanguages](https://dialogflow.com/docs/reference/language) are supported.\nNote: languages must be enabled in the agent, before they can be used.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent/intents", + "path": "v2beta1/{+parent}/intents", + "id": "dialogflow.projects.agent.intents.create", + "request": { + "$ref": "Intent" + }, + "description": "Creates an intent in the specified agent." } } } @@ -2776,6 +2752,10 @@ "operations": { "methods": { "get": { + "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}", + "path": "v2beta1/{+name}", + "id": "dialogflow.projects.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.", "response": { "$ref": "Operation" }, @@ -2794,39 +2774,41 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/projects/{projectsId}/operations/{operationsId}", - "path": "v2beta1/{+name}", - "id": "dialogflow.projects.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." + ] } } } + }, + "methods": { + "getAgent": { + "response": { + "$ref": "Agent" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "parent": { + "description": "Required. The project that the agent to fetch is associated with.\nFormat: `projects/\u003cProject ID\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/projects/{projectsId}/agent", + "path": "v2beta1/{+parent}/agent", + "id": "dialogflow.projects.getAgent", + "description": "Retrieves the specified agent." + } } } }, "parameters": { - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", @@ -2843,21 +2825,21 @@ "type": "string" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "uploadType": { - "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, "$.xgafv": { "enumDescriptions": [ "v1 error format", @@ -2872,13 +2854,11 @@ "type": "string" }, "callback": { + "location": "query", "description": "JSONP", - "type": "string", - "location": "query" + "type": "string" }, "alt": { - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -2890,6 +2870,29 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], + "location": "query", + "description": "Data format for response.", + "default": "json" + }, + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", "location": "query" } }, @@ -2898,8 +2901,5 @@ "kind": "discovery#restDescription", "description": "An end-to-end development suite for conversational interfaces (e.g., chatbots, voice-powered apps and devices).", "servicePath": "", - "basePath": "", - "revision": "20171229", - "documentationLink": "https://cloud.google.com/dialogflow-enterprise/", - "id": "dialogflow:v2beta1" + "basePath": "" }
diff --git a/digitalassetlinks/v1/digitalassetlinks-api.json b/digitalassetlinks/v1/digitalassetlinks-api.json index ee636a5..e2ec1f7 100644 --- a/digitalassetlinks/v1/digitalassetlinks-api.json +++ b/digitalassetlinks/v1/digitalassetlinks-api.json
@@ -1,15 +1,4 @@ { - "kind": "discovery#restDescription", - "description": "API for discovering relationships between online assets such as web sites or mobile apps.", - "servicePath": "", - "rootUrl": "https://digitalassetlinks.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "digitalassetlinks", - "batchPath": "batch", - "revision": "20180103", - "documentationLink": "https://developers.google.com/digital-asset-links/", - "id": "digitalassetlinks:v1", "title": "Digital Asset Links API", "ownerName": "Google", "discoveryVersion": "v1", @@ -18,53 +7,62 @@ "statements": { "methods": { "list": { + "description": "Retrieves a list of all statements from a given source that match the\nspecified target and statement string.\n\nThe API guarantees that all statements with secure source assets, such as\nHTTPS websites or Android apps, have been made in a secure way by the owner\nof those assets, as described in the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).\nSpecifically, you should consider that for insecure websites (that is,\nwhere the URL starts with `http://` instead of `https://`), this guarantee\ncannot be made.\n\nThe `List` command is most useful in cases where the API client wants to\nknow all the ways in which two assets are related, or enumerate all the\nrelationships from a particular source asset. Example: a feature that\nhelps users navigate to related items. When a mobile app is running on a\ndevice, the feature would make it easy to navigate to the corresponding web\nsite or Google+ profile.", "response": { "$ref": "ListResponse" }, "parameterOrder": [], "httpMethod": "GET", "parameters": { - "source.androidApp.certificate.sha256Fingerprint": { - "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).", - "type": "string", - "location": "query" - }, - "relation": { - "description": "Use only associations that match the specified relation.\n\nSee the [`Statement`](#Statement) message for a detailed definition of\nrelation strings.\n\nFor a query to match a statement, one of the following must be true:\n\n* both the query's and the statement's relation strings match exactly,\n or\n* the query's relation string is empty or missing.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.", - "type": "string", - "location": "query" - }, "source.web.site": { + "location": "query", "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED", - "type": "string", - "location": "query" + "type": "string" }, "source.androidApp.packageName": { "location": "query", "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED", "type": "string" + }, + "source.androidApp.certificate.sha256Fingerprint": { + "location": "query", + "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).", + "type": "string" + }, + "relation": { + "location": "query", + "description": "Use only associations that match the specified relation.\n\nSee the [`Statement`](#Statement) message for a detailed definition of\nrelation strings.\n\nFor a query to match a statement, one of the following must be true:\n\n* both the query's and the statement's relation strings match exactly,\n or\n* the query's relation string is empty or missing.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.", + "type": "string" } }, "flatPath": "v1/statements:list", "path": "v1/statements:list", - "id": "digitalassetlinks.statements.list", - "description": "Retrieves a list of all statements from a given source that match the\nspecified target and statement string.\n\nThe API guarantees that all statements with secure source assets, such as\nHTTPS websites or Android apps, have been made in a secure way by the owner\nof those assets, as described in the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).\nSpecifically, you should consider that for insecure websites (that is,\nwhere the URL starts with `http://` instead of `https://`), this guarantee\ncannot be made.\n\nThe `List` command is most useful in cases where the API client wants to\nknow all the ways in which two assets are related, or enumerate all the\nrelationships from a particular source asset. Example: a feature that\nhelps users navigate to related items. When a mobile app is running on a\ndevice, the feature would make it easy to navigate to the corresponding web\nsite or Google+ profile." + "id": "digitalassetlinks.statements.list" } } }, "assetlinks": { "methods": { "check": { + "flatPath": "v1/assetlinks:check", + "path": "v1/assetlinks:check", + "id": "digitalassetlinks.assetlinks.check", + "description": "Determines whether the specified (directional) relationship exists between\nthe specified source and target assets.\n\nThe relation describes the intent of the link between the two assets as\nclaimed by the source asset. An example for such relationships is the\ndelegation of privileges or permissions.\n\nThis command is most often used by infrastructure systems to check\npreconditions for an action. For example, a client may want to know if it\nis OK to send a web URL to a particular mobile app instead. The client can\ncheck for the relevant asset link from the website to the mobile app to\ndecide if the operation should be allowed.\n\nA note about security: if you specify a secure asset as the source, such as\nan HTTPS website or an Android app, the API will ensure that any\nstatements used to generate the response have been made in a secure way by\nthe owner of that asset. Conversely, if the source asset is an insecure\nHTTP website (that is, the URL starts with `http://` instead of `https://`),\nthe API cannot verify its statements securely, and it is not possible to\nensure that the website's statements have not been altered by a third\nparty. For more information, see the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md).", "response": { "$ref": "CheckResponse" }, "parameterOrder": [], "httpMethod": "GET", "parameters": { + "target.web.site": { + "location": "query", + "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED", + "type": "string" + }, "target.androidApp.certificate.sha256Fingerprint": { + "location": "query", "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).", - "type": "string", - "location": "query" + "type": "string" }, "source.web.site": { "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED", @@ -72,40 +70,41 @@ "location": "query" }, "source.androidApp.packageName": { + "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED", + "type": "string", + "location": "query" + }, + "target.androidApp.packageName": { "location": "query", "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED", "type": "string" }, - "target.androidApp.packageName": { - "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED", - "type": "string", - "location": "query" - }, "source.androidApp.certificate.sha256Fingerprint": { + "location": "query", "description": "The uppercase SHA-265 fingerprint of the certificate. From the PEM\n certificate, it can be acquired like this:\n\n $ keytool -printcert -file $CERTFILE | grep SHA256:\n SHA256: 14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83: \\\n 42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nor like this:\n\n $ openssl x509 -in $CERTFILE -noout -fingerprint -sha256\n SHA256 Fingerprint=14:6D:E9:83:C5:73:06:50:D8:EE:B9:95:2F:34:FC:64: \\\n 16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:44:E5\n\nIn this example, the contents of this field would be `14:6D:E9:83:C5:73:\n06:50:D8:EE:B9:95:2F:34:FC:64:16:A0:83:42:E6:1D:BE:A8:8A:04:96:B2:3F:CF:\n44:E5`.\n\nIf these tools are not available to you, you can convert the PEM\ncertificate into the DER format, compute the SHA-256 hash of that string\nand represent the result as a hexstring (that is, uppercase hexadecimal\nrepresentations of each octet, separated by colons).", - "type": "string", - "location": "query" + "type": "string" }, "relation": { + "location": "query", "description": "Query string for the relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nFor a query to match an asset link, both the query's and the asset link's\nrelation strings must match exactly.\n\nExample: A query with relation `delegate_permission/common.handle_all_urls`\nmatches an asset link with relation\n`delegate_permission/common.handle_all_urls`.", - "type": "string", - "location": "query" - }, - "target.web.site": { - "description": "Web assets are identified by a URL that contains only the scheme, hostname\nand port parts. The format is\n\n http[s]://\u003chostname\u003e[:\u003cport\u003e]\n\nHostnames must be fully qualified: they must end in a single period\n(\"`.`\").\n\nOnly the schemes \"http\" and \"https\" are currently allowed.\n\nPort numbers are given as a decimal number, and they must be omitted if the\nstandard port numbers are used: 80 for http and 443 for https.\n\nWe call this limited URL the \"site\". All URLs that share the same scheme,\nhostname and port are considered to be a part of the site and thus belong\nto the web asset.\n\nExample: the asset with the site `https://www.google.com` contains all\nthese URLs:\n\n * `https://www.google.com/`\n * `https://www.google.com:443/`\n * `https://www.google.com/foo`\n * `https://www.google.com/foo?bar`\n * `https://www.google.com/foo#bar`\n * `https://user@password:www.google.com/`\n\nBut it does not contain these URLs:\n\n * `http://www.google.com/` (wrong scheme)\n * `https://google.com/` (hostname does not match)\n * `https://www.google.com:444/` (port does not match)\nREQUIRED", - "type": "string", - "location": "query" + "type": "string" } - }, - "flatPath": "v1/assetlinks:check", - "path": "v1/assetlinks:check", - "id": "digitalassetlinks.assetlinks.check", - "description": "Determines whether the specified (directional) relationship exists between\nthe specified source and target assets.\n\nThe relation describes the intent of the link between the two assets as\nclaimed by the source asset. An example for such relationships is the\ndelegation of privileges or permissions.\n\nThis command is most often used by infrastructure systems to check\npreconditions for an action. For example, a client may want to know if it\nis OK to send a web URL to a particular mobile app instead. The client can\ncheck for the relevant asset link from the website to the mobile app to\ndecide if the operation should be allowed.\n\nA note about security: if you specify a secure asset as the source, such as\nan HTTPS website or an Android app, the API will ensure that any\nstatements used to generate the response have been made in a secure way by\nthe owner of that asset. Conversely, if the source asset is an insecure\nHTTP website (that is, the URL starts with `http://` instead of `https://`),\nthe API cannot verify its statements securely, and it is not possible to\nensure that the website's statements have not been altered by a third\nparty. For more information, see the [Digital Asset Links technical design\nspecification](https://github.com/google/digitalassetlinks/blob/master/well-known/details.md)." + } } } } }, "parameters": { + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", @@ -123,9 +122,9 @@ "type": "string" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "$.xgafv": { "enumDescriptions": [ @@ -146,7 +145,6 @@ "location": "query" }, "alt": { - "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -159,12 +157,13 @@ "json", "media", "proto" - ] + ], + "type": "string" }, "key": { + "location": "query", "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.", - "type": "string", - "location": "query" + "type": "string" }, "access_token": { "description": "OAuth access token.", @@ -177,26 +176,14 @@ "location": "query" }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" + "default": "true" } }, "schemas": { "Asset": { - "description": "Uniquely identifies an asset.\n\nA digital asset is an identifiable and addressable online entity that\ntypically provides some service or content. Examples of assets are websites,\nAndroid apps, Twitter feeds, and Plus Pages.", - "type": "object", "properties": { "web": { "description": "Set if this is a web asset.", @@ -207,12 +194,20 @@ "description": "Set if this is an Android App asset." } }, - "id": "Asset" + "id": "Asset", + "description": "Uniquely identifies an asset.\n\nA digital asset is an identifiable and addressable online entity that\ntypically provides some service or content. Examples of assets are websites,\nAndroid apps, Twitter feeds, and Plus Pages.", + "type": "object" }, "CheckResponse": { - "description": "Response message for the CheckAssetLinks call.", - "type": "object", "properties": { + "linked": { + "description": "Set to true if the assets specified in the request are linked by the\nrelation specified in the request.", + "type": "boolean" + }, + "debugString": { + "description": "Human-readable message containing information intended to help end users\nunderstand, reproduce and debug the result.\n\n\nThe message will be in English and we are currently not planning to offer\nany translations.\n\nPlease note that no guarantees are made about the contents or format of\nthis string. Any aspect of it may be subject to change without notice.\nYou should not attempt to programmatically parse this data. For\nprogrammatic access, use the error_code field below.", + "type": "string" + }, "maxAge": { "description": "From serving time, how much longer the response should be considered valid\nbarring further updates.\nREQUIRED", "format": "google-duration", @@ -235,7 +230,6 @@ "description": "Error codes that describe the result of the Check operation.", "type": "array", "items": { - "type": "string", "enum": [ "ERROR_CODE_UNSPECIFIED", "ERROR_CODE_INVALID_QUERY", @@ -248,19 +242,14 @@ "ERROR_CODE_MALFORMED_CONTENT", "ERROR_CODE_SECURE_ASSET_INCLUDES_INSECURE", "ERROR_CODE_FETCH_BUDGET_EXHAUSTED" - ] + ], + "type": "string" } - }, - "linked": { - "description": "Set to true if the assets specified in the request are linked by the\nrelation specified in the request.", - "type": "boolean" - }, - "debugString": { - "description": "Human-readable message containing information intended to help end users\nunderstand, reproduce and debug the result.\n\n\nThe message will be in English and we are currently not planning to offer\nany translations.\n\nPlease note that no guarantees are made about the contents or format of\nthis string. Any aspect of it may be subject to change without notice.\nYou should not attempt to programmatically parse this data. For\nprogrammatic access, use the error_code field below.", - "type": "string" } }, - "id": "CheckResponse" + "id": "CheckResponse", + "description": "Response message for the CheckAssetLinks call.", + "type": "object" }, "WebAsset": { "description": "Describes a web asset.", @@ -333,6 +322,10 @@ "description": "Describes a reliable statement that has been made about the relationship\nbetween a source asset and a target asset.\n\nStatements are always made by the source asset, either directly or by\ndelegating to a statement list that is stored elsewhere.\n\nFor more detailed definitions of statements and assets, please refer\nto our [API documentation landing\npage](/digital-asset-links/v1/getting-started).", "type": "object", "properties": { + "target": { + "$ref": "Asset", + "description": "Every statement has a target asset.\nREQUIRED" + }, "source": { "$ref": "Asset", "description": "Every statement has a source asset.\nREQUIRED" @@ -340,10 +333,6 @@ "relation": { "description": "The relation identifies the use of the statement as intended by the source\nasset's owner (that is, the person or entity who issued the statement).\nEvery complete statement has a relation.\n\nWe identify relations with strings of the format `\u003ckind\u003e/\u003cdetail\u003e`, where\n`\u003ckind\u003e` must be one of a set of pre-defined purpose categories, and\n`\u003cdetail\u003e` is a free-form lowercase alphanumeric string that describes the\nspecific use case of the statement.\n\nRefer to [our API documentation](/digital-asset-links/v1/relation-strings)\nfor the current list of supported relations.\n\nExample: `delegate_permission/common.handle_all_urls`\nREQUIRED", "type": "string" - }, - "target": { - "$ref": "Asset", - "description": "Every statement has a target asset.\nREQUIRED" } }, "id": "Statement" @@ -363,13 +352,13 @@ "description": "Describes an android app asset.", "type": "object", "properties": { - "certificate": { - "description": "Because there is no global enforcement of package name uniqueness, we also\nrequire a signing certificate, which in combination with the package name\nuniquely identifies an app.\n\nSome apps' signing keys are rotated, so they may be signed by different\nkeys over time. We treat these as distinct assets, since we use (package\nname, cert) as the unique ID. This should not normally pose any problems\nas both versions of the app will make the same or similar statements.\nOther assets making statements about the app will have to be updated when a\nkey is rotated, however.\n\n(Note that the syntaxes for publishing and querying for statements contain\nsyntactic sugar to easily let you specify apps that are known by multiple\ncertificates.)\nREQUIRED", - "$ref": "CertificateInfo" - }, "packageName": { "description": "Android App assets are naturally identified by their Java package name.\nFor example, the Google Maps app uses the package name\n`com.google.android.apps.maps`.\nREQUIRED", "type": "string" + }, + "certificate": { + "$ref": "CertificateInfo", + "description": "Because there is no global enforcement of package name uniqueness, we also\nrequire a signing certificate, which in combination with the package name\nuniquely identifies an app.\n\nSome apps' signing keys are rotated, so they may be signed by different\nkeys over time. We treat these as distinct assets, since we use (package\nname, cert) as the unique ID. This should not normally pose any problems\nas both versions of the app will make the same or similar statements.\nOther assets making statements about the app will have to be updated when a\nkey is rotated, however.\n\n(Note that the syntaxes for publishing and querying for statements contain\nsyntactic sugar to easily let you specify apps that are known by multiple\ncertificates.)\nREQUIRED" } }, "id": "AndroidAppAsset" @@ -377,9 +366,20 @@ }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "version": "v1", - "baseUrl": "https://digitalassetlinks.googleapis.com/" + "baseUrl": "https://digitalassetlinks.googleapis.com/", + "kind": "discovery#restDescription", + "description": "API for discovering relationships between online assets such as web sites or mobile apps.", + "servicePath": "", + "rootUrl": "https://digitalassetlinks.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "digitalassetlinks", + "batchPath": "batch", + "revision": "20180103", + "documentationLink": "https://developers.google.com/digital-asset-links/", + "id": "digitalassetlinks:v1" }
diff --git a/dlp/v2beta1/dlp-api.json b/dlp/v2beta1/dlp-api.json index ed5ae56..e951d7f 100644 --- a/dlp/v2beta1/dlp-api.json +++ b/dlp/v2beta1/dlp-api.json
@@ -1,149 +1,575 @@ { + "ownerDomain": "google.com", + "name": "dlp", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "DLP API", + "ownerName": "Google", + "resources": { + "content": { + "methods": { + "inspect": { + "request": { + "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest" + }, + "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/content:inspect", + "id": "dlp.content.inspect", + "path": "v2beta1/content:inspect" + }, + "redact": { + "id": "dlp.content.redact", + "path": "v2beta1/content:redact", + "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size.", + "request": { + "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest" + }, + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v2beta1/content:redact" + }, + "deidentify": { + "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size.", + "request": { + "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v2beta1/content:deidentify", + "path": "v2beta1/content:deidentify", + "id": "dlp.content.deidentify" + } + } + }, + "rootCategories": { + "methods": { + "list": { + "response": { + "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "languageCode": { + "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2beta1/rootCategories", + "path": "v2beta1/rootCategories", + "id": "dlp.rootCategories.list", + "description": "Returns the list of root categories of sensitive information." + } + }, + "resources": { + "infoTypes": { + "methods": { + "list": { + "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes", + "path": "v2beta1/rootCategories/{+category}/infoTypes", + "id": "dlp.rootCategories.infoTypes.list", + "description": "Returns sensitive information types for given category.", + "response": { + "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse" + }, + "parameterOrder": [ + "category" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "category": { + "location": "path", + "description": "Category name as returned by ListRootCategories.", + "required": true, + "type": "string", + "pattern": "^[^/]+$" + }, + "languageCode": { + "location": "query", + "description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.", + "type": "string" + } + } + } + } + } + } + }, + "riskAnalysis": { + "resources": { + "operations": { + "methods": { + "cancel": { + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^riskAnalysis/operations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel", + "path": "v2beta1/{+name}:cancel", + "id": "dlp.riskAnalysis.operations.cancel", + "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.", + "request": { + "$ref": "GoogleLongrunningCancelOperationRequest" + } + }, + "delete": { + "description": "This method is not supported and the server returns `UNIMPLEMENTED`.", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^riskAnalysis/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}", + "path": "v2beta1/{+name}", + "id": "dlp.riskAnalysis.operations.delete" + }, + "list": { + "description": "Fetches the list of long running operations.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "parameters": { + "filter": { + "location": "query", + "description": "Filters by `done`. That is, `done=true` or `done=false`.", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^riskAnalysis/operations$", + "location": "path" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The list page size. The maximum allowed value is 256 and the default is 100.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/riskAnalysis/operations", + "id": "dlp.riskAnalysis.operations.list", + "path": "v2beta1/{+name}" + }, + "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.", + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^riskAnalysis/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}", + "path": "v2beta1/{+name}", + "id": "dlp.riskAnalysis.operations.get" + } + } + } + } + }, + "dataSource": { + "methods": { + "analyze": { + "request": { + "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest" + }, + "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/dataSource:analyze", + "id": "dlp.dataSource.analyze", + "path": "v2beta1/dataSource:analyze" + } + } + }, + "inspect": { + "resources": { + "results": { + "resources": { + "findings": { + "methods": { + "list": { + "response": { + "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.", + "format": "int32", + "type": "integer" + }, + "filter": { + "description": "Restricts findings to items that match. Supports info_type and likelihood.\n\nExamples:\n\n- info_type=EMAIL_ADDRESS\n- info_type=PHONE_NUMBER,EMAIL_ADDRESS\n- likelihood=VERY_LIKELY\n- likelihood=VERY_LIKELY,LIKELY\n- info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY", + "type": "string", + "location": "query" + }, + "name": { + "description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to InspectDataSource.\nShould be in the format of `inspect/results/{id}`.", + "required": true, + "type": "string", + "pattern": "^inspect/results/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "The value returned by the last `ListInspectFindingsResponse`; indicates\nthat this is a continuation of a prior `ListInspectFindings` call, and that\nthe system should return the next page of data.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2beta1/inspect/results/{resultsId}/findings", + "path": "v2beta1/{+name}/findings", + "id": "dlp.inspect.results.findings.list", + "description": "Returns list of results for given inspect operation result set id." + } + } + } + } + }, + "operations": { + "methods": { + "list": { + "flatPath": "v2beta1/inspect/operations", + "id": "dlp.inspect.operations.list", + "path": "v2beta1/{+name}", + "description": "Fetches the list of long running operations.", + "httpMethod": "GET", + "response": { + "$ref": "GoogleLongrunningListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "pageSize": { + "description": "The list page size. The maximum allowed value is 256 and the default is 100.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "location": "query", + "description": "Filters by `done`. That is, `done=true` or `done=false`.", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^inspect/operations$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^inspect/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta1/inspect/operations/{operationsId}", + "path": "v2beta1/{+name}", + "id": "dlp.inspect.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." + }, + "create": { + "id": "dlp.inspect.operations.create", + "path": "v2beta1/inspect/operations", + "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.", + "request": { + "$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest" + }, + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "GoogleLongrunningOperation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v2beta1/inspect/operations" + }, + "cancel": { + "request": { + "$ref": "GoogleLongrunningCancelOperationRequest" + }, + "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^inspect/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel", + "id": "dlp.inspect.operations.cancel", + "path": "v2beta1/{+name}:cancel" + }, + "delete": { + "description": "This method is not supported and the server returns `UNIMPLEMENTED`.", + "httpMethod": "DELETE", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string", + "pattern": "^inspect/operations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta1/inspect/operations/{operationsId}", + "id": "dlp.inspect.operations.delete", + "path": "v2beta1/{+name}" + } + } + } + } + } + }, + "parameters": { + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + } + }, + "version": "v2beta1", + "baseUrl": "https://dlp.googleapis.com/", + "kind": "discovery#restDescription", + "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", + "servicePath": "", + "basePath": "", + "id": "dlp:v2beta1", + "documentationLink": "https://cloud.google.com/dlp/docs/", + "revision": "20180103", + "discoveryVersion": "v1", + "version_module": true, "schemas": { - "GooglePrivacyDlpV2beta1CreateInspectOperationRequest": { - "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.", - "type": "object", - "properties": { - "operationConfig": { - "$ref": "GooglePrivacyDlpV2beta1OperationConfig", - "description": "Additional configuration settings for long running operations." - }, - "inspectConfig": { - "description": "Configuration for the inspector.", - "$ref": "GooglePrivacyDlpV2beta1InspectConfig" - }, - "storageConfig": { - "description": "Specification of the data set to process.", - "$ref": "GooglePrivacyDlpV2beta1StorageConfig" - }, - "outputConfig": { - "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig", - "description": "Optional location to store findings." - } - }, - "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest" - }, - "GooglePrivacyDlpV2beta1TaggedField": { - "description": "A column with a semantic tag attached.", - "type": "object", - "properties": { - "infoType": { - "$ref": "GooglePrivacyDlpV2beta1InfoType", - "description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders." - }, - "inferred": { - "$ref": "GoogleProtobufEmpty", - "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data" - }, - "field": { - "$ref": "GooglePrivacyDlpV2beta1FieldId", - "description": "Identifies the column. [required]" - }, - "customTag": { - "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1TaggedField" - }, - "GooglePrivacyDlpV2beta1InfoTypeStatistics": { - "description": "Statistics regarding a specific InfoType.", - "type": "object", - "properties": { - "infoType": { - "$ref": "GooglePrivacyDlpV2beta1InfoType", - "description": "The type of finding this stat is for." - }, - "count": { - "description": "Number of findings for this info type.", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics" - }, - "GooglePrivacyDlpV2beta1RedactContentResponse": { - "description": "Results of redacting a list of items.", - "type": "object", - "properties": { - "items": { - "description": "The redacted content.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1ContentItem" - } - } - }, - "id": "GooglePrivacyDlpV2beta1RedactContentResponse" - }, - "GooglePrivacyDlpV2beta1PropertyReference": { - "description": "A reference to a property relative to the Datastore kind expressions.", - "type": "object", - "properties": { - "name": { - "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1PropertyReference" - }, - "GooglePrivacyDlpV2beta1FieldTransformation": { - "description": "The transformation to apply to the field.", - "type": "object", - "properties": { - "infoTypeTransformations": { - "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`.", - "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations" - }, - "fields": { - "description": "Input field(s) to apply the transformation to. [required]", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1FieldId" - } - }, - "primitiveTransformation": { - "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation", - "description": "Apply the transformation to the entire field." - }, - "condition": { - "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85.", - "$ref": "GooglePrivacyDlpV2beta1RecordCondition" - } - }, - "id": "GooglePrivacyDlpV2beta1FieldTransformation" - }, - "GooglePrivacyDlpV2beta1OutputStorageConfig": { - "description": "Cloud repository for storing output.", - "type": "object", - "properties": { - "table": { - "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", - "description": "Store findings in a new table in the dataset." - }, - "storagePath": { - "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id", - "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath" - } - }, - "id": "GooglePrivacyDlpV2beta1OutputStorageConfig" - }, - "GooglePrivacyDlpV2beta1BucketingConfig": { - "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.", - "type": "object", - "properties": { - "buckets": { - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1Bucket" - } - } - }, - "id": "GooglePrivacyDlpV2beta1BucketingConfig" - }, "GooglePrivacyDlpV2beta1DeidentifyContentResponse": { - "description": "Results of de-identifying a list of items.", - "type": "object", "properties": { "items": { "type": "array", @@ -159,9 +585,12 @@ } } }, - "id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse" + "id": "GooglePrivacyDlpV2beta1DeidentifyContentResponse", + "description": "Results of de-identifying a list of items.", + "type": "object" }, "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": { + "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass", "description": "The set of columns' values that share the same k-anonymity value.", "type": "object", "properties": { @@ -177,59 +606,67 @@ "$ref": "GooglePrivacyDlpV2beta1Value" } } - }, - "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass" + } }, "GoogleLongrunningOperation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", "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" + "error": { + "$ref": "GoogleRpcStatus", + "description": "The error result of the operation in case of failure or cancellation." }, - "response": { - "description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.", + "metadata": { + "description": "This field will contain an InspectOperationMetadata object for `inspect.operations.create` or a RiskAnalysisOperationMetadata object for `dataSource.analyze`. This will always be returned with the Operation.", "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" } }, - "name": { - "description": "The server-assigned name. The `name` should have the format of `inspect/operations/\u003cidentifier\u003e`.", - "type": "string" + "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" }, - "error": { - "$ref": "GoogleRpcStatus", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { + "response": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "This field will contain an InspectOperationMetadata object for `inspect.operations.create` or a RiskAnalysisOperationMetadata object for `dataSource.analyze`. This will always be returned with the Operation.", + "description": "This field will contain an InspectOperationResult object for `inspect.operations.create` or a RiskAnalysisOperationResult object for `dataSource.analyze`.", "type": "object" + }, + "name": { + "type": "string", + "description": "The server-assigned name. The `name` should have the format of `inspect/operations/\u003cidentifier\u003e`." } }, - "id": "GoogleLongrunningOperation" + "id": "GoogleLongrunningOperation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object" }, "GooglePrivacyDlpV2beta1InspectOperationMetadata": { "description": "Metadata returned within GetOperation for an inspect request.", "type": "object", "properties": { - "infoTypeStats": { - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics" - } + "requestStorageConfig": { + "$ref": "GooglePrivacyDlpV2beta1StorageConfig", + "description": "The storage config used to create the Operation." + }, + "processedBytes": { + "description": "Total size in bytes that were processed.", + "format": "int64", + "type": "string" }, "totalEstimatedBytes": { "description": "Estimate of the number of bytes to process.", "format": "int64", "type": "string" }, + "infoTypeStats": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1InfoTypeStatistics" + } + }, "requestInspectConfig": { "description": "The inspect config used to create the Operation.", "$ref": "GooglePrivacyDlpV2beta1InspectConfig" @@ -242,21 +679,11 @@ "description": "The time which this request was started.", "format": "google-datetime", "type": "string" - }, - "requestStorageConfig": { - "$ref": "GooglePrivacyDlpV2beta1StorageConfig", - "description": "The storage config used to create the Operation." - }, - "processedBytes": { - "description": "Total size in bytes that were processed.", - "format": "int64", - "type": "string" } }, "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata" }, "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey": { - "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt", "type": "object", "properties": { "wrappedKey": { @@ -269,18 +696,19 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey" + "id": "GooglePrivacyDlpV2beta1KmsWrappedCryptoKey", + "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt" }, "GooglePrivacyDlpV2beta1InfoType": { - "description": "Type of information detected by the API.", - "type": "object", "properties": { "name": { "description": "Name of the information type.", "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1InfoType" + "id": "GooglePrivacyDlpV2beta1InfoType", + "description": "Type of information detected by the API.", + "type": "object" }, "GooglePrivacyDlpV2beta1CharsToIgnore": { "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.", @@ -290,14 +718,6 @@ "type": "string" }, "commonCharactersToIgnore": { - "enumDescriptions": [ - "", - "0-9", - "A-Z", - "a-z", - "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~", - "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]" - ], "enum": [ "CHARACTER_GROUP_UNSPECIFIED", "NUMERIC", @@ -306,7 +726,15 @@ "PUNCTUATION", "WHITESPACE" ], - "type": "string" + "type": "string", + "enumDescriptions": [ + "", + "0-9", + "A-Z", + "a-z", + "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~", + "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]" + ] } }, "id": "GooglePrivacyDlpV2beta1CharsToIgnore" @@ -315,10 +743,6 @@ "description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\nThe resulting value will be a hyphenated string of\nlower_bound-upper_bound.\nThis can be used on data of type: double, long.\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.", "type": "object", "properties": { - "lowerBound": { - "description": "Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”. [Required].", - "$ref": "GooglePrivacyDlpV2beta1Value" - }, "bucketSize": { "description": "Size of each bucket (except for minimum and maximum buckets). So if\n`lower_bound` = 10, `upper_bound` = 89, and `bucket_size` = 10, then the\nfollowing buckets would be used: -10, 10-20, 20-30, 30-40, 40-50, 50-60,\n60-70, 70-80, 80-89, 89+. Precision up to 2 decimals works. [Required].", "format": "double", @@ -327,6 +751,10 @@ "upperBound": { "$ref": "GooglePrivacyDlpV2beta1Value", "description": "Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”.\n[Required]." + }, + "lowerBound": { + "$ref": "GooglePrivacyDlpV2beta1Value", + "description": "Lower bound value of buckets. All values less than `lower_bound` are\ngrouped together into a single bucket; for example if `lower_bound` = 10,\nthen all values less than 10 are replaced with the value “-10”. [Required]." } }, "id": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig" @@ -353,22 +781,8 @@ }, "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult" }, - "GooglePrivacyDlpV2beta1CategoryDescription": { - "description": "Info Type Category description.", - "type": "object", - "properties": { - "displayName": { - "description": "Human readable form of the category name.", - "type": "string" - }, - "name": { - "description": "Internal name of the category.", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1CategoryDescription" - }, "GooglePrivacyDlpV2beta1Conditions": { + "id": "GooglePrivacyDlpV2beta1Conditions", "type": "object", "properties": { "conditions": { @@ -377,13 +791,42 @@ "$ref": "GooglePrivacyDlpV2beta1Condition" } } + } + }, + "GooglePrivacyDlpV2beta1CategoryDescription": { + "description": "Info Type Category description.", + "type": "object", + "properties": { + "name": { + "description": "Internal name of the category.", + "type": "string" + }, + "displayName": { + "description": "Human readable form of the category name.", + "type": "string" + } }, - "id": "GooglePrivacyDlpV2beta1Conditions" + "id": "GooglePrivacyDlpV2beta1CategoryDescription" }, "GooglePrivacyDlpV2beta1PrimitiveTransformation": { "description": "A rule for transforming a value.", "type": "object", "properties": { + "timePartConfig": { + "$ref": "GooglePrivacyDlpV2beta1TimePartConfig" + }, + "fixedSizeBucketingConfig": { + "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig" + }, + "characterMaskConfig": { + "$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig" + }, + "redactConfig": { + "$ref": "GooglePrivacyDlpV2beta1RedactConfig" + }, + "bucketingConfig": { + "$ref": "GooglePrivacyDlpV2beta1BucketingConfig" + }, "replaceWithInfoTypeConfig": { "$ref": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig" }, @@ -395,38 +838,22 @@ }, "replaceConfig": { "$ref": "GooglePrivacyDlpV2beta1ReplaceValueConfig" - }, - "timePartConfig": { - "$ref": "GooglePrivacyDlpV2beta1TimePartConfig" - }, - "fixedSizeBucketingConfig": { - "$ref": "GooglePrivacyDlpV2beta1FixedSizeBucketingConfig" - }, - "characterMaskConfig": { - "$ref": "GooglePrivacyDlpV2beta1CharacterMaskConfig" - }, - "bucketingConfig": { - "$ref": "GooglePrivacyDlpV2beta1BucketingConfig" - }, - "redactConfig": { - "$ref": "GooglePrivacyDlpV2beta1RedactConfig" } }, "id": "GooglePrivacyDlpV2beta1PrimitiveTransformation" }, "GooglePrivacyDlpV2beta1CategoricalStatsConfig": { - "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.", - "type": "object", "properties": { "field": { "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.", "$ref": "GooglePrivacyDlpV2beta1FieldId" } }, - "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig" + "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig", + "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.", + "type": "object" }, "GooglePrivacyDlpV2beta1Finding": { - "description": "Represents a piece of potentially sensitive content.", "type": "object", "properties": { "infoType": { @@ -467,7 +894,8 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1Finding" + "id": "GooglePrivacyDlpV2beta1Finding", + "description": "Represents a piece of potentially sensitive content." }, "GooglePrivacyDlpV2beta1KMapEstimationConfig": { "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.", @@ -495,6 +923,7 @@ "id": "GooglePrivacyDlpV2beta1KMapEstimationConfig" }, "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": { + "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata", "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.", "type": "object", "properties": { @@ -504,33 +933,32 @@ "type": "string" }, "requestedSourceTable": { - "description": "Input dataset to compute metrics over.", - "$ref": "GooglePrivacyDlpV2beta1BigQueryTable" + "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", + "description": "Input dataset to compute metrics over." }, "requestedPrivacyMetric": { - "description": "Privacy metric to compute.", - "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric" + "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric", + "description": "Privacy metric to compute." } - }, - "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata" + } }, "GoogleLongrunningListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleLongrunningOperation" } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" } }, - "id": "GoogleLongrunningListOperationsResponse" + "id": "GoogleLongrunningListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object" }, "GooglePrivacyDlpV2beta1Row": { "type": "object", @@ -545,18 +973,18 @@ "id": "GooglePrivacyDlpV2beta1Row" }, "GoogleProtobufEmpty": { + "id": "GoogleProtobufEmpty", "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 `{}`.", "type": "object", - "properties": {}, - "id": "GoogleProtobufEmpty" + "properties": {} }, "GooglePrivacyDlpV2beta1ListInspectFindingsResponse": { "description": "Response to the ListInspectFindings request.", "type": "object", "properties": { "result": { - "description": "The results.", - "$ref": "GooglePrivacyDlpV2beta1InspectResult" + "$ref": "GooglePrivacyDlpV2beta1InspectResult", + "description": "The results." }, "nextPageToken": { "description": "If not empty, indicates that there may be more results that match the\nrequest; this value should be passed in a new `ListInspectFindingsRequest`.", @@ -569,11 +997,6 @@ "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.", "type": "object", "properties": { - "maxAnonymity": { - "description": "Always greater than or equal to min_anonymity.", - "format": "int64", - "type": "string" - }, "bucketSize": { "description": "Number of records within these anonymity bounds.", "format": "int64", @@ -590,6 +1013,11 @@ "description": "Always positive.", "format": "int64", "type": "string" + }, + "maxAnonymity": { + "description": "Always greater than or equal to min_anonymity.", + "format": "int64", + "type": "string" } }, "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket" @@ -599,7 +1027,6 @@ "type": "object", "properties": { "logicalOperator": { - "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.", "type": "string", "enumDescriptions": [ "", @@ -608,7 +1035,8 @@ "enum": [ "LOGICAL_OPERATOR_UNSPECIFIED", "AND" - ] + ], + "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`." }, "conditions": { "$ref": "GooglePrivacyDlpV2beta1Conditions" @@ -617,14 +1045,14 @@ "id": "GooglePrivacyDlpV2beta1Expressions" }, "GooglePrivacyDlpV2beta1CloudStorageOptions": { - "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.", "type": "object", "properties": { "fileSet": { "$ref": "GooglePrivacyDlpV2beta1FileSet" } }, - "id": "GooglePrivacyDlpV2beta1CloudStorageOptions" + "id": "GooglePrivacyDlpV2beta1CloudStorageOptions", + "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket." }, "GooglePrivacyDlpV2beta1CloudStoragePath": { "description": "A location in Cloud Storage.", @@ -638,9 +1066,15 @@ "id": "GooglePrivacyDlpV2beta1CloudStoragePath" }, "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": { - "description": "Histogram bucket of equivalence class sizes in the table.", "type": "object", "properties": { + "bucketValues": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass" + }, + "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20." + }, "equivalenceClassSizeLowerBound": { "description": "Lower bound on the size of the equivalence classes in this bucket.", "format": "int64", @@ -655,18 +1089,13 @@ "description": "Total number of records in this bucket.", "format": "int64", "type": "string" - }, - "bucketValues": { - "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass" - } } }, - "id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket" + "id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket", + "description": "Histogram bucket of equivalence class sizes in the table." }, "GooglePrivacyDlpV2beta1InspectOperationResult": { + "id": "GooglePrivacyDlpV2beta1InspectOperationResult", "description": "The operational data.", "type": "object", "properties": { @@ -674,8 +1103,38 @@ "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `inspect/results/{id}`.", "type": "string" } + } + }, + "GooglePrivacyDlpV2beta1Range": { + "description": "Generic half-open interval [start, end)", + "type": "object", + "properties": { + "start": { + "type": "string", + "description": "Index of the first character of the range (inclusive).", + "format": "int64" + }, + "end": { + "description": "Index of the last character of the range (exclusive).", + "format": "int64", + "type": "string" + } }, - "id": "GooglePrivacyDlpV2beta1InspectOperationResult" + "id": "GooglePrivacyDlpV2beta1Range" + }, + "GooglePrivacyDlpV2beta1CategoricalStatsResult": { + "properties": { + "valueFrequencyHistogramBuckets": { + "description": "Histogram of value frequencies in the column.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket" + } + } + }, + "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult", + "description": "Result of the categorical stats computation.", + "type": "object" }, "GooglePrivacyDlpV2beta1LDiversityResult": { "description": "Result of the l-diversity computation.", @@ -691,81 +1150,49 @@ }, "id": "GooglePrivacyDlpV2beta1LDiversityResult" }, - "GooglePrivacyDlpV2beta1CategoricalStatsResult": { - "description": "Result of the categorical stats computation.", - "type": "object", - "properties": { - "valueFrequencyHistogramBuckets": { - "description": "Histogram of value frequencies in the column.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket" - } - } - }, - "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult" - }, - "GooglePrivacyDlpV2beta1Range": { - "description": "Generic half-open interval [start, end)", - "type": "object", - "properties": { - "end": { - "description": "Index of the last character of the range (exclusive).", - "format": "int64", - "type": "string" - }, - "start": { - "description": "Index of the first character of the range (inclusive).", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1Range" - }, "GoogleTypeTimeOfDay": { + "id": "GoogleTypeTimeOfDay", "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`.", "type": "object", "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", "type": "integer" }, "seconds": { + "type": "integer", "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" + "format": "int32" }, "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", + "type": "integer" } - }, - "id": "GoogleTypeTimeOfDay" + } }, "GooglePrivacyDlpV2beta1DeidentifyConfig": { - "description": "The configuration that controls how the data will change.", "type": "object", "properties": { "recordTransformations": { - "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.", - "$ref": "GooglePrivacyDlpV2beta1RecordTransformations" + "$ref": "GooglePrivacyDlpV2beta1RecordTransformations", + "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table." }, "infoTypeTransformations": { "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere.", "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations" } }, - "id": "GooglePrivacyDlpV2beta1DeidentifyConfig" + "id": "GooglePrivacyDlpV2beta1DeidentifyConfig", + "description": "The configuration that controls how the data will change." }, "GooglePrivacyDlpV2beta1LDiversityConfig": { - "description": "l-diversity metric, used for analysis of reidentification risk.", "type": "object", "properties": { "sensitiveAttribute": { @@ -780,16 +1207,13 @@ } } }, - "id": "GooglePrivacyDlpV2beta1LDiversityConfig" + "id": "GooglePrivacyDlpV2beta1LDiversityConfig", + "description": "l-diversity metric, used for analysis of reidentification risk." }, "GooglePrivacyDlpV2beta1StorageConfig": { "description": "Shared message indicating Cloud storage type.", "type": "object", "properties": { - "cloudStorageOptions": { - "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions", - "description": "Google Cloud Storage options specification." - }, "datastoreOptions": { "description": "Google Cloud Datastore options specification.", "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions" @@ -797,6 +1221,10 @@ "bigQueryOptions": { "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions", "description": "BigQuery options specification." + }, + "cloudStorageOptions": { + "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions", + "description": "Google Cloud Storage options specification." } }, "id": "GooglePrivacyDlpV2beta1StorageConfig" @@ -814,25 +1242,24 @@ "id": "GooglePrivacyDlpV2beta1OperationConfig" }, "GooglePrivacyDlpV2beta1BigQueryOptions": { - "description": "Options defining BigQuery table and row identifiers.", "type": "object", "properties": { + "tableReference": { + "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", + "description": "Complete BigQuery table reference." + }, "identifyingFields": { "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1FieldId" } - }, - "tableReference": { - "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", - "description": "Complete BigQuery table reference." } }, - "id": "GooglePrivacyDlpV2beta1BigQueryOptions" + "id": "GooglePrivacyDlpV2beta1BigQueryOptions", + "description": "Options defining BigQuery table and row identifiers." }, "GooglePrivacyDlpV2beta1PrivacyMetric": { - "description": "Privacy metric to compute for reidentification risk analysis.", "type": "object", "properties": { "numericalStatsConfig": { @@ -851,9 +1278,11 @@ "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig" } }, - "id": "GooglePrivacyDlpV2beta1PrivacyMetric" + "id": "GooglePrivacyDlpV2beta1PrivacyMetric", + "description": "Privacy metric to compute for reidentification risk analysis." }, "GooglePrivacyDlpV2beta1ReplaceConfig": { + "id": "GooglePrivacyDlpV2beta1ReplaceConfig", "type": "object", "properties": { "infoType": { @@ -864,8 +1293,7 @@ "description": "Content replacing sensitive information of given type. Max 256 chars.", "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta1ReplaceConfig" + } }, "GooglePrivacyDlpV2beta1NumericalStatsConfig": { "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.", @@ -879,13 +1307,12 @@ "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig" }, "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": { - "description": "The set of columns' values that share the same l-diversity value.", "type": "object", "properties": { "equivalenceClassSize": { + "type": "string", "description": "Size of the k-anonymity equivalence class.", - "format": "int64", - "type": "string" + "format": "int64" }, "quasiIdsValues": { "description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request.", @@ -895,9 +1322,9 @@ } }, "numDistinctSensitiveValues": { + "type": "string", "description": "Number of distinct sensitive values in this equivalence class.", - "format": "int64", - "type": "string" + "format": "int64" }, "topSensitiveValues": { "description": "Estimated frequencies of top sensitive values.", @@ -907,18 +1334,19 @@ } } }, - "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass" + "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass", + "description": "The set of columns' values that share the same l-diversity value." }, "GooglePrivacyDlpV2beta1DeidentificationSummary": { "description": "High level summary of deidentification.", "type": "object", "properties": { "transformationSummaries": { - "description": "Transformations applied to the dataset.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1TransformationSummary" - } + }, + "description": "Transformations applied to the dataset." }, "transformedBytes": { "description": "Total size in bytes that were transformed in some way.", @@ -929,20 +1357,21 @@ "id": "GooglePrivacyDlpV2beta1DeidentificationSummary" }, "GooglePrivacyDlpV2beta1RecordCondition": { - "description": "A condition for determining whether a transformation should be applied to\na field.", "type": "object", "properties": { "expressions": { "$ref": "GooglePrivacyDlpV2beta1Expressions" } }, - "id": "GooglePrivacyDlpV2beta1RecordCondition" + "id": "GooglePrivacyDlpV2beta1RecordCondition", + "description": "A condition for determining whether a transformation should be applied to\na field." }, "GooglePrivacyDlpV2beta1TimePartConfig": { "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.", "type": "object", "properties": { "partToExtract": { + "type": "string", "enumDescriptions": [ "", "[000-9999]", @@ -960,15 +1389,12 @@ "DAY_OF_WEEK", "WEEK_OF_YEAR", "HOUR_OF_DAY" - ], - "type": "string" + ] } }, "id": "GooglePrivacyDlpV2beta1TimePartConfig" }, "GooglePrivacyDlpV2beta1ListInfoTypesResponse": { - "description": "Response to the ListInfoTypes request.", - "type": "object", "properties": { "infoTypes": { "description": "Set of sensitive info types belonging to a category.", @@ -978,7 +1404,9 @@ } } }, - "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse" + "id": "GooglePrivacyDlpV2beta1ListInfoTypesResponse", + "description": "Response to the ListInfoTypes request.", + "type": "object" }, "GooglePrivacyDlpV2beta1CloudStorageKey": { "description": "Record key for a finding in a Cloud Storage file.", @@ -1000,10 +1428,6 @@ "description": "Result of the numerical stats computation.", "type": "object", "properties": { - "minValue": { - "description": "Minimum value appearing in the column.", - "$ref": "GooglePrivacyDlpV2beta1Value" - }, "maxValue": { "$ref": "GooglePrivacyDlpV2beta1Value", "description": "Maximum value appearing in the column." @@ -1014,6 +1438,10 @@ "items": { "$ref": "GooglePrivacyDlpV2beta1Value" } + }, + "minValue": { + "$ref": "GooglePrivacyDlpV2beta1Value", + "description": "Minimum value appearing in the column." } }, "id": "GooglePrivacyDlpV2beta1NumericalStatsResult" @@ -1023,8 +1451,8 @@ "type": "object", "properties": { "wordList": { - "$ref": "GooglePrivacyDlpV2beta1WordList", - "description": "List of words or phrases to search for." + "description": "List of words or phrases to search for.", + "$ref": "GooglePrivacyDlpV2beta1WordList" } }, "id": "GooglePrivacyDlpV2beta1Dictionary" @@ -1033,10 +1461,6 @@ "description": "Options defining a data set within Google Cloud Datastore.", "type": "object", "properties": { - "partitionId": { - "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.", - "$ref": "GooglePrivacyDlpV2beta1PartitionId" - }, "kind": { "$ref": "GooglePrivacyDlpV2beta1KindExpression", "description": "The kind to process." @@ -1047,6 +1471,10 @@ "items": { "$ref": "GooglePrivacyDlpV2beta1Projection" } + }, + "partitionId": { + "$ref": "GooglePrivacyDlpV2beta1PartitionId", + "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty." } }, "id": "GooglePrivacyDlpV2beta1DatastoreOptions" @@ -1076,26 +1504,11 @@ "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.", "type": "object", "properties": { - "customInfoTypes": { - "description": "Custom info types provided by the user.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1CustomInfoType" - } - }, "excludeTypes": { "description": "When true, excludes type information of the findings.", "type": "boolean" }, "minLikelihood": { - "enumDescriptions": [ - "Default value; information with all likelihoods is included.", - "Few matching elements.", - "", - "Some matching elements.", - "", - "Many matching elements." - ], "enum": [ "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", @@ -1105,14 +1518,22 @@ "VERY_LIKELY" ], "description": "Only returns findings equal or above this threshold.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Default value; information with all likelihoods is included.", + "Few matching elements.", + "", + "Some matching elements.", + "", + "Many matching elements." + ] }, "infoTypeLimits": { - "description": "Configuration of findings limit given for specified info types.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1InfoTypeLimit" - } + }, + "description": "Configuration of findings limit given for specified info types." }, "maxFindings": { "description": "Limits the number of findings per content item or long running operation.", @@ -1129,41 +1550,48 @@ "includeQuote": { "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.", "type": "boolean" + }, + "customInfoTypes": { + "description": "Custom info types provided by the user.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1CustomInfoType" + } } }, "id": "GooglePrivacyDlpV2beta1InspectConfig" }, "GooglePrivacyDlpV2beta1Projection": { - "description": "A representation of a Datastore property in a projection.", - "type": "object", "properties": { "property": { "description": "The property to project.", "$ref": "GooglePrivacyDlpV2beta1PropertyReference" } }, - "id": "GooglePrivacyDlpV2beta1Projection" + "id": "GooglePrivacyDlpV2beta1Projection", + "description": "A representation of a Datastore property in a projection.", + "type": "object" }, "GooglePrivacyDlpV2beta1RedactConfig": { + "id": "GooglePrivacyDlpV2beta1RedactConfig", "description": "Redact a given value. For example, if used with an `InfoTypeTransformation`\ntransforming PHONE_NUMBER, and input 'My phone number is 206-555-0123', the\noutput would be 'My phone number is '.", "type": "object", - "properties": {}, - "id": "GooglePrivacyDlpV2beta1RedactConfig" + "properties": {} }, "GooglePrivacyDlpV2beta1Key": { "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.", "type": "object", "properties": { - "partitionId": { - "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.", - "$ref": "GooglePrivacyDlpV2beta1PartitionId" - }, "path": { "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1PathElement" } + }, + "partitionId": { + "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.", + "$ref": "GooglePrivacyDlpV2beta1PartitionId" } }, "id": "GooglePrivacyDlpV2beta1Key" @@ -1173,8 +1601,8 @@ "type": "object", "properties": { "cryptoKey": { - "description": "The key used by the hash function.", - "$ref": "GooglePrivacyDlpV2beta1CryptoKey" + "$ref": "GooglePrivacyDlpV2beta1CryptoKey", + "description": "The key used by the hash function." } }, "id": "GooglePrivacyDlpV2beta1CryptoHashConfig" @@ -1183,16 +1611,16 @@ "description": "Request to search for potentially sensitive info in a list of items.", "type": "object", "properties": { + "inspectConfig": { + "$ref": "GooglePrivacyDlpV2beta1InspectConfig", + "description": "Configuration for the inspector." + }, "items": { "description": "The list of items to inspect. Items in a single request are\nconsidered \"related\" unless inspect_config.independent_inputs is true.\nUp to 100 are allowed per request.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1ContentItem" } - }, - "inspectConfig": { - "$ref": "GooglePrivacyDlpV2beta1InspectConfig", - "description": "Configuration for the inspector." } }, "id": "GooglePrivacyDlpV2beta1InspectContentRequest" @@ -1219,51 +1647,35 @@ }, "id": "GoogleTypeDate" }, + "GooglePrivacyDlpV2beta1ImageRedactionConfig": { + "description": "Configuration for determining how redaction of images should occur.", + "type": "object", + "properties": { + "redactionColor": { + "$ref": "GooglePrivacyDlpV2beta1Color", + "description": "The color to use when redacting content from an image. If not specified,\nthe default is black." + }, + "redactAllText": { + "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.", + "type": "boolean" + }, + "infoType": { + "$ref": "GooglePrivacyDlpV2beta1InfoType", + "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig." + } + }, + "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig" + }, "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig": { "description": "Replace each matching finding with the name of the info_type.", "type": "object", "properties": {}, "id": "GooglePrivacyDlpV2beta1ReplaceWithInfoTypeConfig" }, - "GooglePrivacyDlpV2beta1ImageRedactionConfig": { - "description": "Configuration for determining how redaction of images should occur.", - "type": "object", - "properties": { - "infoType": { - "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig.", - "$ref": "GooglePrivacyDlpV2beta1InfoType" - }, - "redactionColor": { - "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.", - "$ref": "GooglePrivacyDlpV2beta1Color" - }, - "redactAllText": { - "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.", - "type": "boolean" - } - }, - "id": "GooglePrivacyDlpV2beta1ImageRedactionConfig" - }, "GooglePrivacyDlpV2beta1Location": { "description": "Specifies the location of the finding.", "type": "object", "properties": { - "recordKey": { - "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object.", - "$ref": "GooglePrivacyDlpV2beta1RecordKey" - }, - "tableLocation": { - "$ref": "GooglePrivacyDlpV2beta1TableLocation", - "description": "The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table." - }, - "codepointRange": { - "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text.", - "$ref": "GooglePrivacyDlpV2beta1Range" - }, - "fieldId": { - "$ref": "GooglePrivacyDlpV2beta1FieldId", - "description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object." - }, "imageBoxes": { "description": "The area within the image that contained the finding.\nProvided when the content is an image.", "type": "array", @@ -1274,6 +1686,22 @@ "byteRange": { "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image.", "$ref": "GooglePrivacyDlpV2beta1Range" + }, + "recordKey": { + "$ref": "GooglePrivacyDlpV2beta1RecordKey", + "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object." + }, + "tableLocation": { + "description": "The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table.", + "$ref": "GooglePrivacyDlpV2beta1TableLocation" + }, + "codepointRange": { + "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text.", + "$ref": "GooglePrivacyDlpV2beta1Range" + }, + "fieldId": { + "description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object.", + "$ref": "GooglePrivacyDlpV2beta1FieldId" } }, "id": "GooglePrivacyDlpV2beta1Location" @@ -1288,37 +1716,6 @@ }, "id": "GooglePrivacyDlpV2beta1RecordSuppression" }, - "GooglePrivacyDlpV2beta1UnwrappedCryptoKey": { - "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.", - "type": "object", - "properties": { - "key": { - "description": "The AES 128/192/256 bit key. [required]", - "format": "byte", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey" - }, - "GooglePrivacyDlpV2beta1CustomInfoType": { - "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.", - "type": "object", - "properties": { - "infoType": { - "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.", - "$ref": "GooglePrivacyDlpV2beta1InfoType" - }, - "dictionary": { - "description": "Dictionary-based custom info type.", - "$ref": "GooglePrivacyDlpV2beta1Dictionary" - }, - "surrogateType": { - "$ref": "GooglePrivacyDlpV2beta1SurrogateType", - "description": "Surrogate info type." - } - }, - "id": "GooglePrivacyDlpV2beta1CustomInfoType" - }, "GooglePrivacyDlpV2beta1InfoTypeDescription": { "description": "Description of the information type (infoType).", "type": "object", @@ -1341,19 +1738,49 @@ }, "id": "GooglePrivacyDlpV2beta1InfoTypeDescription" }, + "GooglePrivacyDlpV2beta1CustomInfoType": { + "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.", + "type": "object", + "properties": { + "surrogateType": { + "$ref": "GooglePrivacyDlpV2beta1SurrogateType", + "description": "Surrogate info type." + }, + "infoType": { + "$ref": "GooglePrivacyDlpV2beta1InfoType", + "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types." + }, + "dictionary": { + "$ref": "GooglePrivacyDlpV2beta1Dictionary", + "description": "Dictionary-based custom info type." + } + }, + "id": "GooglePrivacyDlpV2beta1CustomInfoType" + }, + "GooglePrivacyDlpV2beta1UnwrappedCryptoKey": { + "description": "Using raw keys is prone to security risks due to accidentally\nleaking the key. Choose another type of key if possible.", + "type": "object", + "properties": { + "key": { + "description": "The AES 128/192/256 bit key. [required]", + "format": "byte", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta1UnwrappedCryptoKey" + }, "GooglePrivacyDlpV2beta1EntityId": { - "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.", "type": "object", "properties": { "field": { - "$ref": "GooglePrivacyDlpV2beta1FieldId", - "description": "Composite key indicating which field contains the entity identifier." + "description": "Composite key indicating which field contains the entity identifier.", + "$ref": "GooglePrivacyDlpV2beta1FieldId" } }, - "id": "GooglePrivacyDlpV2beta1EntityId" + "id": "GooglePrivacyDlpV2beta1EntityId", + "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity." }, "GooglePrivacyDlpV2beta1AuxiliaryTable": { - "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).", "type": "object", "properties": { "quasiIds": { @@ -1364,19 +1791,18 @@ } }, "relativeFrequency": { - "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]", - "$ref": "GooglePrivacyDlpV2beta1FieldId" + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]" }, "table": { "description": "Auxiliary table location. [required]", "$ref": "GooglePrivacyDlpV2beta1BigQueryTable" } }, - "id": "GooglePrivacyDlpV2beta1AuxiliaryTable" + "id": "GooglePrivacyDlpV2beta1AuxiliaryTable", + "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable)." }, "GooglePrivacyDlpV2beta1KMapEstimationResult": { - "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", - "type": "object", "properties": { "kMapEstimationHistogram": { "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.", @@ -1386,11 +1812,11 @@ } } }, - "id": "GooglePrivacyDlpV2beta1KMapEstimationResult" + "id": "GooglePrivacyDlpV2beta1KMapEstimationResult", + "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", + "type": "object" }, "GoogleRpcStatus": { - "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.", - "type": "object", "properties": { "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", @@ -1402,18 +1828,20 @@ "type": "string" }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } - } + }, + "type": "object" + }, + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." } }, - "id": "GoogleRpcStatus" + "id": "GoogleRpcStatus", + "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.", + "type": "object" }, "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": { "description": "A tuple of values for the quasi-identifier columns.", @@ -1435,13 +1863,10 @@ "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues" }, "GooglePrivacyDlpV2beta1PathElement": { + "id": "GooglePrivacyDlpV2beta1PathElement", "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", "type": "object", "properties": { - "name": { - "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", - "type": "string" - }, "kind": { "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", "type": "string" @@ -1450,9 +1875,12 @@ "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", "format": "int64", "type": "string" + }, + "name": { + "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", + "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta1PathElement" + } }, "GooglePrivacyDlpV2beta1SummaryResult": { "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.", @@ -1487,16 +1915,16 @@ "type": "object", "properties": { "tableId": { - "description": "Name of the table.", - "type": "string" + "type": "string", + "description": "Name of the table." }, "projectId": { "description": "The Google Cloud Platform project ID of the project containing the table.\nIf omitted, project ID is inferred from the API call.", "type": "string" }, "datasetId": { - "description": "Dataset ID of the table.", - "type": "string" + "type": "string", + "description": "Dataset ID of the table." } }, "id": "GooglePrivacyDlpV2beta1BigQueryTable" @@ -1506,11 +1934,11 @@ "type": "object", "properties": { "categories": { - "description": "List of all into type categories supported by the API.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1CategoryDescription" - } + }, + "description": "List of all into type categories supported by the API." } }, "id": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse" @@ -1551,58 +1979,39 @@ }, "id": "GooglePrivacyDlpV2beta1FileSet" }, + "GooglePrivacyDlpV2beta1InfoTypeTransformation": { + "description": "A transformation to apply to text that is identified as a specific\ninfo_type.", + "type": "object", + "properties": { + "infoTypes": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1InfoType" + }, + "description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation." + }, + "primitiveTransformation": { + "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation", + "description": "Primitive transformation to apply to the info type. [required]" + } + }, + "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation" + }, "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest": { "description": "Request for creating a risk analysis operation.", "type": "object", "properties": { "sourceTable": { - "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", - "description": "Input dataset to compute metrics over." + "description": "Input dataset to compute metrics over.", + "$ref": "GooglePrivacyDlpV2beta1BigQueryTable" }, "privacyMetric": { - "description": "Privacy metric to compute.", - "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric" + "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric", + "description": "Privacy metric to compute." } }, "id": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest" }, - "GooglePrivacyDlpV2beta1InfoTypeTransformation": { - "description": "A transformation to apply to text that is identified as a specific\ninfo_type.", - "type": "object", - "properties": { - "primitiveTransformation": { - "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation", - "description": "Primitive transformation to apply to the info type. [required]" - }, - "infoTypes": { - "description": "Info types to apply the transformation to. Empty list will match all\navailable info types for this transformation.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1InfoType" - } - } - }, - "id": "GooglePrivacyDlpV2beta1InfoTypeTransformation" - }, - "GooglePrivacyDlpV2beta1Bucket": { - "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.", - "type": "object", - "properties": { - "min": { - "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.", - "$ref": "GooglePrivacyDlpV2beta1Value" - }, - "max": { - "description": "Upper bound of the range, exclusive; type must match min.", - "$ref": "GooglePrivacyDlpV2beta1Value" - }, - "replacementValue": { - "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range.", - "$ref": "GooglePrivacyDlpV2beta1Value" - } - }, - "id": "GooglePrivacyDlpV2beta1Bucket" - }, "GooglePrivacyDlpV2beta1KAnonymityResult": { "description": "Result of the k-anonymity computation.", "type": "object", @@ -1617,38 +2026,55 @@ }, "id": "GooglePrivacyDlpV2beta1KAnonymityResult" }, + "GooglePrivacyDlpV2beta1Bucket": { + "description": "Buckets represented as ranges, along with replacement values. Ranges must\nbe non-overlapping.", + "type": "object", + "properties": { + "min": { + "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused.", + "$ref": "GooglePrivacyDlpV2beta1Value" + }, + "max": { + "description": "Upper bound of the range, exclusive; type must match min.", + "$ref": "GooglePrivacyDlpV2beta1Value" + }, + "replacementValue": { + "$ref": "GooglePrivacyDlpV2beta1Value", + "description": "Replacement value for this bucket. If not provided\nthe default behavior will be to hyphenate the min-max range." + } + }, + "id": "GooglePrivacyDlpV2beta1Bucket" + }, "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": { "description": "Histogram bucket of value frequencies in the column.", "type": "object", "properties": { - "bucketSize": { - "description": "Total number of records in this bucket.", - "format": "int64", - "type": "string" - }, "valueFrequencyUpperBound": { "description": "Upper bound on the value frequency of the values in this bucket.", "format": "int64", "type": "string" }, "valueFrequencyLowerBound": { + "type": "string", "description": "Lower bound on the value frequency of the values in this bucket.", - "format": "int64", - "type": "string" + "format": "int64" }, "bucketValues": { - "description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1ValueFrequency" - } + }, + "description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20." + }, + "bucketSize": { + "description": "Total number of records in this bucket.", + "format": "int64", + "type": "string" } }, "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket" }, "GooglePrivacyDlpV2beta1TableLocation": { - "description": "Location of a finding within a table.", - "type": "object", "properties": { "rowIndex": { "description": "The zero-based index of the row where the finding is located.", @@ -1656,25 +2082,9 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1TableLocation" - }, - "GooglePrivacyDlpV2beta1KAnonymityConfig": { - "description": "k-anonymity metric, used for analysis of reidentification risk.", - "type": "object", - "properties": { - "quasiIds": { - "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1FieldId" - } - }, - "entityId": { - "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\".", - "$ref": "GooglePrivacyDlpV2beta1EntityId" - } - }, - "id": "GooglePrivacyDlpV2beta1KAnonymityConfig" + "id": "GooglePrivacyDlpV2beta1TableLocation", + "description": "Location of a finding within a table.", + "type": "object" }, "GooglePrivacyDlpV2beta1DatastoreKey": { "description": "Record key for a finding in Cloud Datastore.", @@ -1687,6 +2097,24 @@ }, "id": "GooglePrivacyDlpV2beta1DatastoreKey" }, + "GooglePrivacyDlpV2beta1KAnonymityConfig": { + "properties": { + "entityId": { + "$ref": "GooglePrivacyDlpV2beta1EntityId", + "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\"." + }, + "quasiIds": { + "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1FieldId" + } + } + }, + "id": "GooglePrivacyDlpV2beta1KAnonymityConfig", + "description": "k-anonymity metric, used for analysis of reidentification risk.", + "type": "object" + }, "GooglePrivacyDlpV2beta1RecordKey": { "description": "Message for a unique key indicating a record that contains a finding.", "type": "object", @@ -1701,12 +2129,14 @@ "id": "GooglePrivacyDlpV2beta1RecordKey" }, "GooglePrivacyDlpV2beta1DeidentifyContentRequest": { - "description": "Request to de-identify a list of items.", - "type": "object", "properties": { + "deidentifyConfig": { + "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig", + "description": "Configuration for the de-identification of the list of content items." + }, "inspectConfig": { - "$ref": "GooglePrivacyDlpV2beta1InspectConfig", - "description": "Configuration for the inspector." + "description": "Configuration for the inspector.", + "$ref": "GooglePrivacyDlpV2beta1InspectConfig" }, "items": { "description": "The list of items to inspect. Up to 100 are allowed per request.\nAll items will be treated as text/*.", @@ -1714,13 +2144,11 @@ "items": { "$ref": "GooglePrivacyDlpV2beta1ContentItem" } - }, - "deidentifyConfig": { - "description": "Configuration for the de-identification of the list of content items.", - "$ref": "GooglePrivacyDlpV2beta1DeidentifyConfig" } }, - "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest" + "id": "GooglePrivacyDlpV2beta1DeidentifyContentRequest", + "description": "Request to de-identify a list of items.", + "type": "object" }, "GooglePrivacyDlpV2beta1InspectResult": { "description": "All the findings for a single scanned item.", @@ -1741,17 +2169,17 @@ "id": "GooglePrivacyDlpV2beta1InspectResult" }, "GooglePrivacyDlpV2beta1QuasiIdField": { - "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.", - "type": "object", "properties": { - "field": { - "$ref": "GooglePrivacyDlpV2beta1FieldId" - }, "customTag": { "type": "string" + }, + "field": { + "$ref": "GooglePrivacyDlpV2beta1FieldId" } }, - "id": "GooglePrivacyDlpV2beta1QuasiIdField" + "id": "GooglePrivacyDlpV2beta1QuasiIdField", + "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.", + "type": "object" }, "GooglePrivacyDlpV2beta1ImageLocation": { "description": "Bounding box encompassing detected text within an image.", @@ -1781,36 +2209,36 @@ "id": "GooglePrivacyDlpV2beta1ImageLocation" }, "GooglePrivacyDlpV2beta1ReplaceValueConfig": { - "description": "Replace each input value with a given `Value`.", "type": "object", "properties": { "newValue": { - "description": "Value to replace it with.", - "$ref": "GooglePrivacyDlpV2beta1Value" + "$ref": "GooglePrivacyDlpV2beta1Value", + "description": "Value to replace it with." } }, - "id": "GooglePrivacyDlpV2beta1ReplaceValueConfig" + "id": "GooglePrivacyDlpV2beta1ReplaceValueConfig", + "description": "Replace each input value with a given `Value`." }, "GooglePrivacyDlpV2beta1ContentItem": { "description": "Container structure for the content to inspect.", "type": "object", "properties": { - "type": { - "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.", - "type": "string" - }, "value": { "description": "String data to inspect or redact.", "type": "string" }, "table": { - "$ref": "GooglePrivacyDlpV2beta1Table", - "description": "Structured content for inspection." + "description": "Structured content for inspection.", + "$ref": "GooglePrivacyDlpV2beta1Table" }, "data": { "description": "Content data to inspect or redact.", "format": "byte", "type": "string" + }, + "type": { + "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: all \"text\" types, octet streams, PNG images,\nJPEG images.", + "type": "string" } }, "id": "GooglePrivacyDlpV2beta1ContentItem" @@ -1824,13 +2252,6 @@ "$ref": "GooglePrivacyDlpV2beta1InfoType" }, "commonAlphabet": { - "enumDescriptions": [ - "", - "[0-9] (radix of 10)", - "[0-9A-F] (radix of 16)", - "[0-9A-Z] (radix of 36)", - "[0-9A-Za-z] (radix of 62)" - ], "enum": [ "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED", "NUMERIC", @@ -1838,7 +2259,14 @@ "UPPER_CASE_ALPHA_NUMERIC", "ALPHA_NUMERIC" ], - "type": "string" + "type": "string", + "enumDescriptions": [ + "", + "[0-9] (radix of 10)", + "[0-9A-F] (radix of 16)", + "[0-9A-Z] (radix of 36)", + "[0-9A-Za-z] (radix of 62)" + ] }, "radix": { "description": "The native way to select the alphabet. Must be in the range [2, 62].", @@ -1850,8 +2278,8 @@ "type": "string" }, "cryptoKey": { - "description": "The key used by the encryption algorithm. [required]", - "$ref": "GooglePrivacyDlpV2beta1CryptoKey" + "$ref": "GooglePrivacyDlpV2beta1CryptoKey", + "description": "The key used by the encryption algorithm. [required]" }, "context": { "$ref": "GooglePrivacyDlpV2beta1FieldId", @@ -1882,24 +2310,21 @@ }, "id": "GooglePrivacyDlpV2beta1Color" }, - "GooglePrivacyDlpV2beta1Table": { - "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.", + "GooglePrivacyDlpV2beta1ValueFrequency": { "type": "object", "properties": { - "rows": { - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1Row" - } + "value": { + "$ref": "GooglePrivacyDlpV2beta1Value", + "description": "A value contained in the field in question." }, - "headers": { - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1FieldId" - } + "count": { + "description": "How many times the value is contained in the field.", + "format": "int64", + "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1Table" + "id": "GooglePrivacyDlpV2beta1ValueFrequency", + "description": "A value of a field, including its frequency." }, "GooglePrivacyDlpV2beta1SurrogateType": { "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.", @@ -1907,21 +2332,40 @@ "properties": {}, "id": "GooglePrivacyDlpV2beta1SurrogateType" }, - "GooglePrivacyDlpV2beta1ValueFrequency": { - "description": "A value of a field, including its frequency.", + "GooglePrivacyDlpV2beta1Table": { "type": "object", "properties": { - "count": { - "description": "How many times the value is contained in the field.", - "format": "int64", - "type": "string" + "headers": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1FieldId" + } }, - "value": { - "$ref": "GooglePrivacyDlpV2beta1Value", - "description": "A value contained in the field in question." + "rows": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1Row" + } } }, - "id": "GooglePrivacyDlpV2beta1ValueFrequency" + "id": "GooglePrivacyDlpV2beta1Table", + "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed." + }, + "GooglePrivacyDlpV2beta1InfoTypeLimit": { + "description": "Max findings configuration per info type, per content item or long running\noperation.", + "type": "object", + "properties": { + "infoType": { + "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit.", + "$ref": "GooglePrivacyDlpV2beta1InfoType" + }, + "maxFindings": { + "description": "Max findings limit for the given infoType.", + "format": "int32", + "type": "integer" + } + }, + "id": "GooglePrivacyDlpV2beta1InfoTypeLimit" }, "GooglePrivacyDlpV2beta1CryptoKey": { "description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.", @@ -1939,26 +2383,21 @@ }, "id": "GooglePrivacyDlpV2beta1CryptoKey" }, - "GooglePrivacyDlpV2beta1InfoTypeLimit": { - "description": "Max findings configuration per info type, per content item or long running\noperation.", - "type": "object", - "properties": { - "infoType": { - "$ref": "GooglePrivacyDlpV2beta1InfoType", - "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit." - }, - "maxFindings": { - "description": "Max findings limit for the given infoType.", - "format": "int32", - "type": "integer" - } - }, - "id": "GooglePrivacyDlpV2beta1InfoTypeLimit" - }, "GooglePrivacyDlpV2beta1LDiversityHistogramBucket": { + "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket", "description": "Histogram bucket of sensitive value frequencies in the table.", "type": "object", "properties": { + "bucketSize": { + "type": "string", + "description": "Total number of records in this bucket.", + "format": "int64" + }, + "sensitiveValueFrequencyUpperBound": { + "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "format": "int64", + "type": "string" + }, "sensitiveValueFrequencyLowerBound": { "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", "format": "int64", @@ -1970,24 +2409,20 @@ "items": { "$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass" } - }, - "bucketSize": { - "description": "Total number of records in this bucket.", - "format": "int64", - "type": "string" - }, - "sensitiveValueFrequencyUpperBound": { - "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", - "format": "int64", - "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket" + } }, "GooglePrivacyDlpV2beta1Value": { "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.", "type": "object", "properties": { + "timeValue": { + "$ref": "GoogleTypeTimeOfDay" + }, + "integerValue": { + "type": "string", + "format": "int64" + }, "stringValue": { "type": "string" }, @@ -2004,28 +2439,17 @@ "floatValue": { "format": "double", "type": "number" - }, - "timeValue": { - "$ref": "GoogleTypeTimeOfDay" - }, - "integerValue": { - "format": "int64", - "type": "string" } }, "id": "GooglePrivacyDlpV2beta1Value" }, "GooglePrivacyDlpV2beta1Condition": { - "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.", - "type": "object", "properties": { "field": { - "$ref": "GooglePrivacyDlpV2beta1FieldId", - "description": "Field within the record this condition is evaluated against. [required]" + "description": "Field within the record this condition is evaluated against. [required]", + "$ref": "GooglePrivacyDlpV2beta1FieldId" }, "operator": { - "description": "Operator used to compare the field or info type to the value. [required]", - "type": "string", "enumDescriptions": [ "", "Equal.", @@ -2045,14 +2469,18 @@ "GREATER_THAN_OR_EQUALS", "LESS_THAN_OR_EQUALS", "EXISTS" - ] + ], + "description": "Operator used to compare the field or info type to the value. [required]", + "type": "string" }, "value": { "$ref": "GooglePrivacyDlpV2beta1Value", "description": "Value to compare against. [Required, except for `EXISTS` tests.]" } }, - "id": "GooglePrivacyDlpV2beta1Condition" + "id": "GooglePrivacyDlpV2beta1Condition", + "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.", + "type": "object" }, "GooglePrivacyDlpV2beta1PartitionId": { "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.", @@ -2084,13 +2512,7 @@ "id": "GooglePrivacyDlpV2beta1InspectContentResponse" }, "GooglePrivacyDlpV2beta1RedactContentRequest": { - "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.", - "type": "object", "properties": { - "inspectConfig": { - "$ref": "GooglePrivacyDlpV2beta1InspectConfig", - "description": "Configuration for the inspector." - }, "items": { "description": "The list of items to inspect. Up to 100 are allowed per request.", "type": "array", @@ -2099,11 +2521,11 @@ } }, "replaceConfigs": { - "description": "The strings to replace findings text findings with. Must specify at least\none of these or one ImageRedactionConfig if redacting images.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1ReplaceConfig" - } + }, + "description": "The strings to replace findings text findings with. Must specify at least\none of these or one ImageRedactionConfig if redacting images." }, "imageRedactionConfigs": { "description": "The configuration for specifying what content to redact from images.", @@ -2111,9 +2533,15 @@ "items": { "$ref": "GooglePrivacyDlpV2beta1ImageRedactionConfig" } + }, + "inspectConfig": { + "$ref": "GooglePrivacyDlpV2beta1InspectConfig", + "description": "Configuration for the inspector." } }, - "id": "GooglePrivacyDlpV2beta1RedactContentRequest" + "id": "GooglePrivacyDlpV2beta1RedactContentRequest", + "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.", + "type": "object" }, "GooglePrivacyDlpV2beta1WordList": { "description": "Message defining a list of words or phrases to search for in the data.", @@ -2141,8 +2569,6 @@ "id": "GooglePrivacyDlpV2beta1FieldId" }, "GooglePrivacyDlpV2beta1TransformationSummary": { - "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.", - "type": "object", "properties": { "results": { "type": "array", @@ -2151,8 +2577,8 @@ } }, "field": { - "description": "Set if the transformation was limited to a specific FieldId.", - "$ref": "GooglePrivacyDlpV2beta1FieldId" + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "Set if the transformation was limited to a specific FieldId." }, "fieldTransformations": { "description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.", @@ -2175,11 +2601,13 @@ "description": "Set if the transformation was limited to a specific info_type." }, "transformation": { - "description": "The specific transformation these stats apply to.", - "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation" + "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation", + "description": "The specific transformation these stats apply to." } }, - "id": "GooglePrivacyDlpV2beta1TransformationSummary" + "id": "GooglePrivacyDlpV2beta1TransformationSummary", + "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.", + "type": "object" }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", @@ -2188,13 +2616,10 @@ "id": "GoogleLongrunningCancelOperationRequest" }, "GooglePrivacyDlpV2beta1CharacterMaskConfig": { + "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig", "description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.", "type": "object", "properties": { - "reverseOrder": { - "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***", - "type": "boolean" - }, "numberToMask": { "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.", "format": "int32", @@ -2210,9 +2635,12 @@ "maskingCharacter": { "description": "Character to mask the sensitive values—for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.", "type": "string" + }, + "reverseOrder": { + "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***", + "type": "boolean" } - }, - "id": "GooglePrivacyDlpV2beta1CharacterMaskConfig" + } }, "GooglePrivacyDlpV2beta1TransientCryptoKey": { "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the operation/request finishes.", @@ -2224,13 +2652,154 @@ } }, "id": "GooglePrivacyDlpV2beta1TransientCryptoKey" + }, + "GooglePrivacyDlpV2beta1CreateInspectOperationRequest": { + "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.", + "type": "object", + "properties": { + "inspectConfig": { + "description": "Configuration for the inspector.", + "$ref": "GooglePrivacyDlpV2beta1InspectConfig" + }, + "storageConfig": { + "$ref": "GooglePrivacyDlpV2beta1StorageConfig", + "description": "Specification of the data set to process." + }, + "outputConfig": { + "description": "Optional location to store findings.", + "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig" + }, + "operationConfig": { + "description": "Additional configuration settings for long running operations.", + "$ref": "GooglePrivacyDlpV2beta1OperationConfig" + } + }, + "id": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest" + }, + "GooglePrivacyDlpV2beta1TaggedField": { + "description": "A column with a semantic tag attached.", + "type": "object", + "properties": { + "customTag": { + "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", + "type": "string" + }, + "infoType": { + "$ref": "GooglePrivacyDlpV2beta1InfoType", + "description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders." + }, + "inferred": { + "$ref": "GoogleProtobufEmpty", + "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data" + }, + "field": { + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "Identifies the column. [required]" + } + }, + "id": "GooglePrivacyDlpV2beta1TaggedField" + }, + "GooglePrivacyDlpV2beta1RedactContentResponse": { + "description": "Results of redacting a list of items.", + "type": "object", + "properties": { + "items": { + "description": "The redacted content.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1ContentItem" + } + } + }, + "id": "GooglePrivacyDlpV2beta1RedactContentResponse" + }, + "GooglePrivacyDlpV2beta1InfoTypeStatistics": { + "description": "Statistics regarding a specific InfoType.", + "type": "object", + "properties": { + "infoType": { + "description": "The type of finding this stat is for.", + "$ref": "GooglePrivacyDlpV2beta1InfoType" + }, + "count": { + "description": "Number of findings for this info type.", + "format": "int64", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics" + }, + "GooglePrivacyDlpV2beta1PropertyReference": { + "id": "GooglePrivacyDlpV2beta1PropertyReference", + "description": "A reference to a property relative to the Datastore kind expressions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", + "type": "string" + } + } + }, + "GooglePrivacyDlpV2beta1OutputStorageConfig": { + "description": "Cloud repository for storing output.", + "type": "object", + "properties": { + "storagePath": { + "$ref": "GooglePrivacyDlpV2beta1CloudStoragePath", + "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id" + }, + "table": { + "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", + "description": "Store findings in a new table in the dataset." + } + }, + "id": "GooglePrivacyDlpV2beta1OutputStorageConfig" + }, + "GooglePrivacyDlpV2beta1FieldTransformation": { + "description": "The transformation to apply to the field.", + "type": "object", + "properties": { + "infoTypeTransformations": { + "$ref": "GooglePrivacyDlpV2beta1InfoTypeTransformations", + "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`." + }, + "fields": { + "description": "Input field(s) to apply the transformation to. [required]", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1FieldId" + } + }, + "primitiveTransformation": { + "$ref": "GooglePrivacyDlpV2beta1PrimitiveTransformation", + "description": "Apply the transformation to the entire field." + }, + "condition": { + "$ref": "GooglePrivacyDlpV2beta1RecordCondition", + "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85." + } + }, + "id": "GooglePrivacyDlpV2beta1FieldTransformation" + }, + "GooglePrivacyDlpV2beta1BucketingConfig": { + "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.", + "type": "object", + "properties": { + "buckets": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1Bucket" + } + } + }, + "id": "GooglePrivacyDlpV2beta1BucketingConfig" } }, + "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", "canonicalName": "DLP", "auth": { "oauth2": { @@ -2241,574 +2810,5 @@ } } }, - "rootUrl": "https://dlp.googleapis.com/", - "ownerDomain": "google.com", - "name": "dlp", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "DLP API", - "ownerName": "Google", - "resources": { - "content": { - "methods": { - "deidentify": { - "flatPath": "v2beta1/content:deidentify", - "path": "v2beta1/content:deidentify", - "id": "dlp.content.deidentify", - "description": "De-identifies potentially sensitive info from a list of strings.\nThis method has limits on input size and output size.", - "request": { - "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta1DeidentifyContentResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {} - }, - "inspect": { - "flatPath": "v2beta1/content:inspect", - "path": "v2beta1/content:inspect", - "id": "dlp.content.inspect", - "description": "Finds potentially sensitive info in a list of strings.\nThis method has limits on input size, processing time, and output size.", - "request": { - "$ref": "GooglePrivacyDlpV2beta1InspectContentRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta1InspectContentResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {} - }, - "redact": { - "response": { - "$ref": "GooglePrivacyDlpV2beta1RedactContentResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/content:redact", - "path": "v2beta1/content:redact", - "id": "dlp.content.redact", - "request": { - "$ref": "GooglePrivacyDlpV2beta1RedactContentRequest" - }, - "description": "Redacts potentially sensitive info from a list of strings.\nThis method has limits on input size, processing time, and output size." - } - } - }, - "rootCategories": { - "methods": { - "list": { - "description": "Returns the list of root categories of sensitive information.", - "response": { - "$ref": "GooglePrivacyDlpV2beta1ListRootCategoriesResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "languageCode": { - "description": "Optional language code for localized friendly category names.\nIf omitted or if localized strings are not available,\nen-US strings will be returned.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2beta1/rootCategories", - "path": "v2beta1/rootCategories", - "id": "dlp.rootCategories.list" - } - }, - "resources": { - "infoTypes": { - "methods": { - "list": { - "description": "Returns sensitive information types for given category.", - "response": { - "$ref": "GooglePrivacyDlpV2beta1ListInfoTypesResponse" - }, - "parameterOrder": [ - "category" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "category": { - "description": "Category name as returned by ListRootCategories.", - "required": true, - "type": "string", - "pattern": "^[^/]+$", - "location": "path" - }, - "languageCode": { - "description": "Optional BCP-47 language code for localized info type friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2beta1/rootCategories/{rootCategoriesId}/infoTypes", - "path": "v2beta1/rootCategories/{+category}/infoTypes", - "id": "dlp.rootCategories.infoTypes.list" - } - } - } - } - }, - "riskAnalysis": { - "resources": { - "operations": { - "methods": { - "cancel": { - "request": { - "$ref": "GoogleLongrunningCancelOperationRequest" - }, - "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^riskAnalysis/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}:cancel", - "id": "dlp.riskAnalysis.operations.cancel", - "path": "v2beta1/{+name}:cancel" - }, - "delete": { - "description": "This method is not supported and the server returns `UNIMPLEMENTED`.", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^riskAnalysis/operations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}", - "path": "v2beta1/{+name}", - "id": "dlp.riskAnalysis.operations.delete" - }, - "list": { - "description": "Fetches the list of long running operations.", - "httpMethod": "GET", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "filter": { - "location": "query", - "description": "Filters by `done`. That is, `done=true` or `done=false`.", - "type": "string" - }, - "name": { - "location": "path", - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^riskAnalysis/operations$" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The list page size. The maximum allowed value is 256 and the default is 100.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/riskAnalysis/operations", - "id": "dlp.riskAnalysis.operations.list", - "path": "v2beta1/{+name}" - }, - "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.", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^riskAnalysis/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/riskAnalysis/operations/{operationsId}", - "path": "v2beta1/{+name}", - "id": "dlp.riskAnalysis.operations.get" - } - } - } - } - }, - "dataSource": { - "methods": { - "analyze": { - "flatPath": "v2beta1/dataSource:analyze", - "id": "dlp.dataSource.analyze", - "path": "v2beta1/dataSource:analyze", - "request": { - "$ref": "GooglePrivacyDlpV2beta1AnalyzeDataSourceRiskRequest" - }, - "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository.", - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, - "inspect": { - "resources": { - "results": { - "resources": { - "findings": { - "methods": { - "list": { - "description": "Returns list of results for given inspect operation result set id.", - "response": { - "$ref": "GooglePrivacyDlpV2beta1ListInspectFindingsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "filter": { - "location": "query", - "description": "Restricts findings to items that match. Supports info_type and likelihood.\n\nExamples:\n\n- info_type=EMAIL_ADDRESS\n- info_type=PHONE_NUMBER,EMAIL_ADDRESS\n- likelihood=VERY_LIKELY\n- likelihood=VERY_LIKELY,LIKELY\n- info_type=EMAIL_ADDRESS,likelihood=VERY_LIKELY,LIKELY", - "type": "string" - }, - "name": { - "location": "path", - "description": "Identifier of the results set returned as metadata of\nthe longrunning operation created by a call to InspectDataSource.\nShould be in the format of `inspect/results/{id}`.", - "required": true, - "type": "string", - "pattern": "^inspect/results/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "The value returned by the last `ListInspectFindingsResponse`; indicates\nthat this is a continuation of a prior `ListInspectFindings` call, and that\nthe system should return the next page of data.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Maximum number of results to return.\nIf 0, the implementation selects a reasonable value.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/inspect/results/{resultsId}/findings", - "path": "v2beta1/{+name}/findings", - "id": "dlp.inspect.results.findings.list" - } - } - } - } - }, - "operations": { - "methods": { - "cancel": { - "flatPath": "v2beta1/inspect/operations/{operationsId}:cancel", - "path": "v2beta1/{+name}:cancel", - "id": "dlp.inspect.operations.cancel", - "description": "Cancels an operation. Use the `inspect.operations.get` to check whether the cancellation succeeded or the operation completed despite cancellation.", - "request": { - "$ref": "GoogleLongrunningCancelOperationRequest" - }, - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^inspect/operations/[^/]+$" - } - } - }, - "delete": { - "description": "This method is not supported and the server returns `UNIMPLEMENTED`.", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^inspect/operations/[^/]+$" - } - }, - "flatPath": "v2beta1/inspect/operations/{operationsId}", - "path": "v2beta1/{+name}", - "id": "dlp.inspect.operations.delete" - }, - "list": { - "description": "Fetches the list of long running operations.", - "httpMethod": "GET", - "response": { - "$ref": "GoogleLongrunningListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "pageSize": { - "description": "The list page size. The maximum allowed value is 256 and the default is 100.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "Filters by `done`. That is, `done=true` or `done=false`.", - "type": "string" - }, - "name": { - "location": "path", - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^inspect/operations$" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/inspect/operations", - "id": "dlp.inspect.operations.list", - "path": "v2beta1/{+name}" - }, - "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", - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^inspect/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta1/inspect/operations/{operationsId}", - "id": "dlp.inspect.operations.get", - "path": "v2beta1/{+name}" - }, - "create": { - "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository.", - "request": { - "$ref": "GooglePrivacyDlpV2beta1CreateInspectOperationRequest" - }, - "response": { - "$ref": "GoogleLongrunningOperation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {}, - "flatPath": "v2beta1/inspect/operations", - "path": "v2beta1/inspect/operations", - "id": "dlp.inspect.operations.create" - } - } - } - } - } - }, - "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - } - }, - "version": "v2beta1", - "baseUrl": "https://dlp.googleapis.com/", - "servicePath": "", - "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", - "kind": "discovery#restDescription", - "basePath": "", - "id": "dlp:v2beta1", - "documentationLink": "https://cloud.google.com/dlp/docs/", - "revision": "20180103", - "discoveryVersion": "v1", - "version_module": true + "rootUrl": "https://dlp.googleapis.com/" }
diff --git a/dlp/v2beta2/dlp-api.json b/dlp/v2beta2/dlp-api.json index 26008f0..f5ca463 100644 --- a/dlp/v2beta2/dlp-api.json +++ b/dlp/v2beta2/dlp-api.json
@@ -1,11 +1,1733 @@ { + "rootUrl": "https://dlp.googleapis.com/", + "ownerDomain": "google.com", + "name": "dlp", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "DLP API", + "ownerName": "Google", + "resources": { + "infoTypes": { + "methods": { + "list": { + "flatPath": "v2beta2/infoTypes", + "path": "v2beta2/infoTypes", + "id": "dlp.infoTypes.list", + "description": "Returns sensitive information types DLP supports.", + "response": { + "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "languageCode": { + "description": "Optional BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.", + "type": "string", + "location": "query" + }, + "filter": { + "description": "Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.", + "type": "string", + "location": "query" + } + } + } + } + }, + "organizations": { + "resources": { + "deidentifyTemplates": { + "methods": { + "patch": { + "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.organizations.deidentifyTemplates.patch", + "description": "Updates the inspect template.", + "request": { + "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", + "location": "path" + } + } + }, + "get": { + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "location": "path", + "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.organizations.deidentifyTemplates.get", + "description": "Gets an inspect template." + }, + "list": { + "description": "Lists inspect templates.", + "response": { + "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "location": "query", + "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "format": "int32", + "type": "integer" + }, + "parent": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates", + "path": "v2beta2/{+parent}/deidentifyTemplates", + "id": "dlp.organizations.deidentifyTemplates.list" + }, + "create": { + "request": { + "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest" + }, + "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" + }, + "parameters": { + "parent": { + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates", + "id": "dlp.organizations.deidentifyTemplates.create", + "path": "v2beta2/{+parent}/deidentifyTemplates" + }, + "delete": { + "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", + "id": "dlp.organizations.deidentifyTemplates.delete", + "path": "v2beta2/{+name}", + "description": "Deletes inspect templates.", + "httpMethod": "DELETE", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "inspectTemplates": { + "methods": { + "patch": { + "parameters": { + "name": { + "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.organizations.inspectTemplates.patch", + "request": { + "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest" + }, + "description": "Updates the inspect template.", + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH" + }, + "get": { + "httpMethod": "GET", + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", + "location": "path", + "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342`." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", + "id": "dlp.organizations.inspectTemplates.get", + "path": "v2beta2/{+name}", + "description": "Gets an inspect template." + }, + "list": { + "description": "Lists inspect templates.", + "httpMethod": "GET", + "response": { + "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageToken": { + "location": "query", + "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", + "type": "string" + }, + "pageSize": { + "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "location": "path", + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates", + "id": "dlp.organizations.inspectTemplates.list", + "path": "v2beta2/{+parent}/inspectTemplates" + }, + "create": { + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates", + "id": "dlp.organizations.inspectTemplates.create", + "path": "v2beta2/{+parent}/inspectTemplates", + "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.", + "request": { + "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest" + } + }, + "delete": { + "description": "Deletes inspect templates.", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.organizations.inspectTemplates.delete" + } + } + } + } + }, + "projects": { + "resources": { + "dlpJobs": { + "methods": { + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/dlpJobs/[^/]+$", + "location": "path", + "description": "The name of the DlpJob resource to be deleted." + } + }, + "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.dlpJobs.delete", + "description": "Deletes a long-running DlpJob. This method indicates that the client is\nno longer interested in the DlpJob result. The job will be cancelled if\npossible.", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE" + }, + "list": { + "description": "Lists DlpJobs that match the specified filter in the request.", + "response": { + "$ref": "GooglePrivacyDlpV2beta2ListDlpJobsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "filter": { + "location": "query", + "description": "Optional. Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n\nThe length of this field should be no more than 500 characters.", + "type": "string" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + }, + "type": { + "location": "query", + "enum": [ + "DLP_JOB_TYPE_UNSPECIFIED", + "INSPECT_JOB", + "RISK_ANALYSIS_JOB" + ], + "description": "The type of job. Defaults to `DlpJobType.INSPECT`", + "type": "string" + }, + "parent": { + "description": "The parent resource name, for example projects/my-project-id.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/dlpJobs", + "path": "v2beta2/{+parent}/dlpJobs", + "id": "dlp.projects.dlpJobs.list" + }, + "get": { + "id": "dlp.projects.dlpJobs.get", + "path": "v2beta2/{+name}", + "description": "Gets the latest state of a long-running DlpJob.", + "httpMethod": "GET", + "response": { + "$ref": "GooglePrivacyDlpV2beta2DlpJob" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/dlpJobs/[^/]+$", + "location": "path", + "description": "The name of the DlpJob resource.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}" + }, + "cancel": { + "request": { + "$ref": "GooglePrivacyDlpV2beta2CancelDlpJobRequest" + }, + "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "The name of the DlpJob resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/dlpJobs/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel", + "path": "v2beta2/{+name}:cancel", + "id": "dlp.projects.dlpJobs.cancel" + } + } + }, + "inspectTemplates": { + "methods": { + "delete": { + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "location": "path", + "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.inspectTemplates.delete", + "description": "Deletes inspect templates." + }, + "patch": { + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", + "location": "path", + "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.inspectTemplates.patch", + "description": "Updates the inspect template.", + "request": { + "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest" + } + }, + "get": { + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", + "location": "path", + "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342`." + } + }, + "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.inspectTemplates.get", + "description": "Gets an inspect template." + }, + "list": { + "response": { + "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id." + }, + "pageToken": { + "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates", + "path": "v2beta2/{+parent}/inspectTemplates", + "id": "dlp.projects.inspectTemplates.list", + "description": "Lists inspect templates." + }, + "create": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates", + "path": "v2beta2/{+parent}/inspectTemplates", + "id": "dlp.projects.inspectTemplates.create", + "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.", + "request": { + "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST" + } + } + }, + "content": { + "methods": { + "inspect": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/content:inspect", + "path": "v2beta2/{+parent}/content:inspect", + "id": "dlp.projects.content.inspect", + "description": "Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n[How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for\nimages](/dlp/docs/inspecting-images)", + "request": { + "$ref": "GooglePrivacyDlpV2beta2InspectContentRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta2InspectContentResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST" + }, + "reidentify": { + "request": { + "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest" + }, + "description": "Re-identify content that has been de-identified.", + "response": { + "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "The parent resource name.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/content:reidentify", + "path": "v2beta2/{+parent}/content:reidentify", + "id": "dlp.projects.content.reidentify" + }, + "deidentify": { + "description": "De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\n[How-to guide](/dlp/docs/deidentify-sensitive-data)", + "request": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/content:deidentify", + "path": "v2beta2/{+parent}/content:deidentify", + "id": "dlp.projects.content.deidentify" + } + } + }, + "dataSource": { + "methods": { + "inspect": { + "path": "v2beta2/{+parent}/dataSource:inspect", + "id": "dlp.projects.dataSource.inspect", + "request": { + "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceRequest" + }, + "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository. [How-to guide](/dlp/docs/inspecting-storage)", + "response": { + "$ref": "GooglePrivacyDlpV2beta2DlpJob" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "The parent resource name, for example projects/my-project-id.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/dataSource:inspect" + }, + "analyze": { + "response": { + "$ref": "GooglePrivacyDlpV2beta2DlpJob" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/dataSource:analyze", + "path": "v2beta2/{+parent}/dataSource:analyze", + "id": "dlp.projects.dataSource.analyze", + "request": { + "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest" + }, + "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository. [How-to guide}(/dlp/docs/compute-risk-analysis)" + } + } + }, + "deidentifyTemplates": { + "methods": { + "create": { + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" + }, + "parameters": { + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates", + "id": "dlp.projects.deidentifyTemplates.create", + "path": "v2beta2/{+parent}/deidentifyTemplates", + "request": { + "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest" + }, + "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage." + }, + "delete": { + "description": "Deletes inspect templates.", + "response": { + "$ref": "GoogleProtobufEmpty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.deidentifyTemplates.delete" + }, + "patch": { + "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.deidentifyTemplates.patch", + "description": "Updates the inspect template.", + "request": { + "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", + "location": "path" + } + } + }, + "get": { + "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", + "path": "v2beta2/{+name}", + "id": "dlp.projects.deidentifyTemplates.get", + "description": "Gets an inspect template.", + "response": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Lists inspect templates.", + "httpMethod": "GET", + "response": { + "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", + "format": "int32", + "type": "integer" + }, + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates", + "id": "dlp.projects.deidentifyTemplates.list", + "path": "v2beta2/{+parent}/deidentifyTemplates" + } + } + }, + "image": { + "methods": { + "redact": { + "description": "Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\n[How-to guide](/dlp/docs/redacting-sensitive-data-images)", + "request": { + "$ref": "GooglePrivacyDlpV2beta2RedactImageRequest" + }, + "response": { + "$ref": "GooglePrivacyDlpV2beta2RedactImageResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "location": "path", + "description": "The parent resource name, for example projects/my-project-id.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "flatPath": "v2beta2/projects/{projectsId}/image:redact", + "path": "v2beta2/{+parent}/image:redact", + "id": "dlp.projects.image.redact" + } + } + } + } + } + }, + "parameters": { + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "alt": { + "location": "query", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "enumDescriptions": [ + "Responses with Content-Type of application/json", + "Media download with context-dependent Content-Type", + "Responses with Content-Type of application/x-protobuf" + ] + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + } + }, + "version": "v2beta2", + "baseUrl": "https://dlp.googleapis.com/", + "kind": "discovery#restDescription", + "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", + "servicePath": "", + "basePath": "", "revision": "20180103", "documentationLink": "https://cloud.google.com/dlp/docs/", "id": "dlp:v2beta2", "discoveryVersion": "v1", "version_module": true, "schemas": { + "GooglePrivacyDlpV2beta2BucketingConfig": { + "type": "object", + "properties": { + "buckets": { + "description": "Set of buckets. Ranges must be non-overlapping.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2Bucket" + } + } + }, + "id": "GooglePrivacyDlpV2beta2BucketingConfig", + "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing." + }, + "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket": { + "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.", + "type": "object", + "properties": { + "bucketValues": { + "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues" + } + }, + "minAnonymity": { + "description": "Always positive.", + "format": "int64", + "type": "string" + }, + "maxAnonymity": { + "description": "Always greater than or equal to min_anonymity.", + "format": "int64", + "type": "string" + }, + "bucketSize": { + "type": "string", + "description": "Number of records within these anonymity bounds.", + "format": "int64" + } + }, + "id": "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket" + }, + "GooglePrivacyDlpV2beta2PrivacyMetric": { + "properties": { + "kMapEstimationConfig": { + "$ref": "GooglePrivacyDlpV2beta2KMapEstimationConfig" + }, + "lDiversityConfig": { + "$ref": "GooglePrivacyDlpV2beta2LDiversityConfig" + }, + "numericalStatsConfig": { + "$ref": "GooglePrivacyDlpV2beta2NumericalStatsConfig" + }, + "kAnonymityConfig": { + "$ref": "GooglePrivacyDlpV2beta2KAnonymityConfig" + }, + "categoricalStatsConfig": { + "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsConfig" + } + }, + "id": "GooglePrivacyDlpV2beta2PrivacyMetric", + "description": "Privacy metric to compute for reidentification risk analysis.", + "type": "object" + }, + "GooglePrivacyDlpV2beta1QuasiIdField": { + "type": "object", + "properties": { + "customTag": { + "type": "string" + }, + "field": { + "$ref": "GooglePrivacyDlpV2beta1FieldId" + } + }, + "id": "GooglePrivacyDlpV2beta1QuasiIdField", + "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model." + }, + "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey": { + "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt", + "type": "object", + "properties": { + "wrappedKey": { + "description": "The wrapped data crypto key. [required]", + "format": "byte", + "type": "string" + }, + "cryptoKeyName": { + "type": "string", + "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]" + } + }, + "id": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey" + }, + "GooglePrivacyDlpV2beta2KAnonymityResult": { + "description": "Result of the k-anonymity computation.", + "type": "object", + "properties": { + "equivalenceClassHistogramBuckets": { + "description": "Histogram of k-anonymity equivalence classes.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket" + } + } + }, + "id": "GooglePrivacyDlpV2beta2KAnonymityResult" + }, + "GooglePrivacyDlpV2beta2Result": { + "type": "object", + "properties": { + "processedBytes": { + "description": "Total size in bytes that were processed.", + "format": "int64", + "type": "string" + }, + "totalEstimatedBytes": { + "description": "Estimate of the number of bytes to process.", + "format": "int64", + "type": "string" + }, + "infoTypeStats": { + "description": "Statistics of how many instances of each info type were found during\ninspect job.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2InfoTypeStatistics" + } + } + }, + "id": "GooglePrivacyDlpV2beta2Result" + }, + "GooglePrivacyDlpV2beta2CustomInfoType": { + "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.", + "type": "object", + "properties": { + "surrogateType": { + "$ref": "GooglePrivacyDlpV2beta2SurrogateType", + "description": "Surrogate info type." + }, + "infoType": { + "$ref": "GooglePrivacyDlpV2beta2InfoType", + "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types." + }, + "dictionary": { + "description": "Dictionary-based custom info type.", + "$ref": "GooglePrivacyDlpV2beta2Dictionary" + } + }, + "id": "GooglePrivacyDlpV2beta2CustomInfoType" + }, + "GooglePrivacyDlpV2beta2DeidentifyContentResponse": { + "description": "Results of de-identifying a ContentItem.", + "type": "object", + "properties": { + "overview": { + "description": "An overview of the changes that were made on the `item`.", + "$ref": "GooglePrivacyDlpV2beta2TransformationOverview" + }, + "item": { + "$ref": "GooglePrivacyDlpV2beta2ContentItem", + "description": "The de-identified item." + } + }, + "id": "GooglePrivacyDlpV2beta2DeidentifyContentResponse" + }, + "GooglePrivacyDlpV2beta1ValueFrequency": { + "type": "object", + "properties": { + "value": { + "description": "A value contained in the field in question.", + "$ref": "GooglePrivacyDlpV2beta1Value" + }, + "count": { + "type": "string", + "description": "How many times the value is contained in the field.", + "format": "int64" + } + }, + "id": "GooglePrivacyDlpV2beta1ValueFrequency", + "description": "A value of a field, including its frequency." + }, + "GooglePrivacyDlpV2beta1SurrogateType": { + "properties": {}, + "id": "GooglePrivacyDlpV2beta1SurrogateType", + "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.", + "type": "object" + }, + "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig": { + "description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation; however when used in the `ReidentifyContent` API method,\nit serves the opposite function by reversing the surrogate back into\nthe original identifier.\nThe identifier must be encoded as ASCII.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nIdentifiers must be at least two characters long.\nIn the case that the identifier is the empty string, it will be skipped.", + "type": "object", + "properties": { + "surrogateInfoType": { + "$ref": "GooglePrivacyDlpV2beta2InfoType", + "description": "The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE" + }, + "commonAlphabet": { + "enumDescriptions": [ + "", + "[0-9] (radix of 10)", + "[0-9A-F] (radix of 16)", + "[0-9A-Z] (radix of 36)", + "[0-9A-Za-z] (radix of 62)" + ], + "enum": [ + "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED", + "NUMERIC", + "HEXADECIMAL", + "UPPER_CASE_ALPHA_NUMERIC", + "ALPHA_NUMERIC" + ], + "type": "string" + }, + "radix": { + "description": "The native way to select the alphabet. Must be in the range [2, 62].", + "format": "int32", + "type": "integer" + }, + "customAlphabet": { + "type": "string", + "description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter." + }, + "cryptoKey": { + "$ref": "GooglePrivacyDlpV2beta2CryptoKey", + "description": "The key used by the encryption algorithm. [required]" + }, + "context": { + "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2", + "$ref": "GooglePrivacyDlpV2beta2FieldId" + } + }, + "id": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig" + }, + "GooglePrivacyDlpV2beta1InfoTypeLimit": { + "description": "Max findings configuration per info type, per content item or long running\noperation.", + "type": "object", + "properties": { + "infoType": { + "$ref": "GooglePrivacyDlpV2beta1InfoType", + "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit." + }, + "maxFindings": { + "description": "Max findings limit for the given infoType.", + "format": "int32", + "type": "integer" + } + }, + "id": "GooglePrivacyDlpV2beta1InfoTypeLimit" + }, + "GooglePrivacyDlpV2beta2FindingLimits": { + "type": "object", + "properties": { + "maxFindingsPerInfoType": { + "description": "Configuration of findings limit given for specified infoTypes.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2InfoTypeLimit" + } + }, + "maxFindingsPerItem": { + "description": "Max number of findings that will be returned for each item scanned.", + "format": "int32", + "type": "integer" + }, + "maxFindingsPerRequest": { + "description": "Max total number of findings that will be returned per request/job.", + "format": "int32", + "type": "integer" + } + }, + "id": "GooglePrivacyDlpV2beta2FindingLimits" + }, + "GooglePrivacyDlpV2beta2DlpJob": { + "properties": { + "startTime": { + "description": "Time when the job started.", + "format": "google-datetime", + "type": "string" + }, + "inspectDetails": { + "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceDetails", + "description": "Results from inspecting a data source." + }, + "errorResults": { + "type": "array", + "items": { + "$ref": "GoogleRpcStatus" + }, + "description": "A stream of errors encountered running the job." + }, + "createTime": { + "description": "Time when the job was created.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "enumDescriptions": [ + "", + "The job has not yet started.", + "The job is currently running.", + "The job is no longer running.", + "The job was canceled before it could complete.", + "The job had an error and did not complete." + ], + "enum": [ + "JOB_STATE_UNSPECIFIED", + "PENDING", + "RUNNING", + "DONE", + "CANCELED", + "FAILED" + ], + "description": "State of a job.", + "type": "string" + }, + "riskDetails": { + "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails", + "description": "Results from analyzing risk of a data source." + }, + "name": { + "description": "The server-assigned name.", + "type": "string" + }, + "type": { + "enum": [ + "DLP_JOB_TYPE_UNSPECIFIED", + "INSPECT_JOB", + "RISK_ANALYSIS_JOB" + ], + "description": "The type of job.", + "type": "string", + "enumDescriptions": [ + "", + "The job inspected Google Cloud for sensitive data.", + "The job executed a Risk Analysis computation." + ] + }, + "endTime": { + "description": "Time when the job finished.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta2DlpJob", + "description": "Combines all of the information about a DLP job.", + "type": "object" + }, + "GooglePrivacyDlpV2beta1LDiversityHistogramBucket": { + "description": "Histogram bucket of sensitive value frequencies in the table.", + "type": "object", + "properties": { + "sensitiveValueFrequencyLowerBound": { + "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "format": "int64", + "type": "string" + }, + "bucketValues": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass" + }, + "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20." + }, + "bucketSize": { + "description": "Total number of records in this bucket.", + "format": "int64", + "type": "string" + }, + "sensitiveValueFrequencyUpperBound": { + "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "format": "int64", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket" + }, + "GooglePrivacyDlpV2beta2Dictionary": { + "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.", + "type": "object", + "properties": { + "wordList": { + "$ref": "GooglePrivacyDlpV2beta2WordList", + "description": "List of words or phrases to search for." + } + }, + "id": "GooglePrivacyDlpV2beta2Dictionary" + }, + "GooglePrivacyDlpV2beta1Value": { + "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.", + "type": "object", + "properties": { + "timestampValue": { + "format": "google-datetime", + "type": "string" + }, + "booleanValue": { + "type": "boolean" + }, + "floatValue": { + "format": "double", + "type": "number" + }, + "timeValue": { + "$ref": "GoogleTypeTimeOfDay" + }, + "integerValue": { + "format": "int64", + "type": "string" + }, + "stringValue": { + "type": "string" + }, + "dateValue": { + "$ref": "GoogleTypeDate" + } + }, + "id": "GooglePrivacyDlpV2beta1Value" + }, + "GooglePrivacyDlpV2beta2RecordCondition": { + "type": "object", + "properties": { + "expressions": { + "$ref": "GooglePrivacyDlpV2beta2Expressions", + "description": "An expression." + } + }, + "id": "GooglePrivacyDlpV2beta2RecordCondition", + "description": "A condition for determining whether a transformation should be applied to\na field." + }, + "GooglePrivacyDlpV2beta2LDiversityHistogramBucket": { + "type": "object", + "properties": { + "bucketSize": { + "description": "Total number of equivalence classes in this bucket.", + "format": "int64", + "type": "string" + }, + "sensitiveValueFrequencyUpperBound": { + "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "format": "int64", + "type": "string" + }, + "sensitiveValueFrequencyLowerBound": { + "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", + "format": "int64", + "type": "string" + }, + "bucketValues": { + "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass" + } + } + }, + "id": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket" + }, + "GooglePrivacyDlpV2beta2KindExpression": { + "description": "A representation of a Datastore kind.", + "type": "object", + "properties": { + "name": { + "description": "The name of the kind.", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta2KindExpression" + }, + "GooglePrivacyDlpV2beta1PartitionId": { + "id": "GooglePrivacyDlpV2beta1PartitionId", + "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.", + "type": "object", + "properties": { + "namespaceId": { + "description": "If not empty, the ID of the namespace to which the entities belong.", + "type": "string" + }, + "projectId": { + "description": "The ID of the project to which the entities belong.", + "type": "string" + } + } + }, + "GooglePrivacyDlpV2beta2InspectResult": { + "description": "All the findings for a single scanned item.", + "type": "object", + "properties": { + "findingsTruncated": { + "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.", + "type": "boolean" + }, + "findings": { + "description": "List of findings for an item.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2Finding" + } + } + }, + "id": "GooglePrivacyDlpV2beta2InspectResult" + }, + "GooglePrivacyDlpV2beta2CryptoHashConfig": { + "type": "object", + "properties": { + "cryptoKey": { + "$ref": "GooglePrivacyDlpV2beta2CryptoKey", + "description": "The key used by the hash function." + } + }, + "id": "GooglePrivacyDlpV2beta2CryptoHashConfig", + "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nThe key size must be either 32 or 64 bytes.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed." + }, + "GooglePrivacyDlpV2beta2TimePartConfig": { + "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.", + "type": "object", + "properties": { + "partToExtract": { + "enum": [ + "TIME_PART_UNSPECIFIED", + "YEAR", + "MONTH", + "DAY_OF_MONTH", + "DAY_OF_WEEK", + "WEEK_OF_YEAR", + "HOUR_OF_DAY" + ], + "type": "string", + "enumDescriptions": [ + "", + "[0-9999]", + "[1-12]", + "[1-31]", + "[1-7]", + "[1-52]", + "[0-23]" + ] + } + }, + "id": "GooglePrivacyDlpV2beta2TimePartConfig" + }, + "GooglePrivacyDlpV2beta1WordList": { + "type": "object", + "properties": { + "words": { + "description": "Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "GooglePrivacyDlpV2beta1WordList", + "description": "Message defining a list of words or phrases to search for in the data." + }, + "GooglePrivacyDlpV2beta2ImageLocation": { + "description": "Bounding box encompassing detected text within an image.", + "type": "object", + "properties": { + "height": { + "description": "Height of the bounding box in pixels.", + "format": "int32", + "type": "integer" + }, + "top": { + "description": "Top coordinate of the bounding box. (0,0) is upper left.", + "format": "int32", + "type": "integer" + }, + "left": { + "description": "Left coordinate of the bounding box. (0,0) is upper left.", + "format": "int32", + "type": "integer" + }, + "width": { + "description": "Width of the bounding box in pixels.", + "format": "int32", + "type": "integer" + } + }, + "id": "GooglePrivacyDlpV2beta2ImageLocation" + }, + "GooglePrivacyDlpV2beta1FieldId": { + "description": "General identifier of a data field in a storage service.", + "type": "object", + "properties": { + "columnName": { + "description": "Name describing the field.", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta1FieldId" + }, + "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest": { + "description": "Request message for UpdateInspectTemplate.", + "type": "object", + "properties": { + "inspectTemplate": { + "description": "New InspectTemplate value.", + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" + }, + "updateMask": { + "description": "Mask to control which fields get updated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest" + }, + "GooglePrivacyDlpV2beta2InspectDataSourceRequest": { + "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.", + "type": "object", + "properties": { + "jobConfig": { + "description": "A configuration for the job.", + "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig" + } + }, + "id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest" + }, + "GooglePrivacyDlpV2beta2Expressions": { + "description": "An expression, consisting or an operator and conditions.", + "type": "object", + "properties": { + "logicalOperator": { + "enumDescriptions": [ + "", + "" + ], + "enum": [ + "LOGICAL_OPERATOR_UNSPECIFIED", + "AND" + ], + "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.", + "type": "string" + }, + "conditions": { + "$ref": "GooglePrivacyDlpV2beta2Conditions" + } + }, + "id": "GooglePrivacyDlpV2beta2Expressions" + }, + "GooglePrivacyDlpV2beta2TransformationSummary": { + "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.", + "type": "object", + "properties": { + "recordSuppress": { + "$ref": "GooglePrivacyDlpV2beta2RecordSuppression", + "description": "The specific suppression option these stats apply to." + }, + "infoType": { + "$ref": "GooglePrivacyDlpV2beta2InfoType", + "description": "Set if the transformation was limited to a specific info_type." + }, + "transformation": { + "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation", + "description": "The specific transformation these stats apply to." + }, + "results": { + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2SummaryResult" + } + }, + "field": { + "description": "Set if the transformation was limited to a specific FieldId.", + "$ref": "GooglePrivacyDlpV2beta2FieldId" + }, + "fieldTransformations": { + "description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2FieldTransformation" + } + }, + "transformedBytes": { + "description": "Total size in bytes that were transformed in some way.", + "format": "int64", + "type": "string" + } + }, + "id": "GooglePrivacyDlpV2beta2TransformationSummary" + }, "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig": { + "id": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig", + "description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of\n\u003clower_bound\u003e-\u003cupper_bound\u003e, i.e if lower_bound = 10 and upper_bound = 20\nall values that are within this bucket will be replaced with \"10-20\".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.", + "type": "object", "properties": { "upperBound": { "description": "Upper bound value of buckets. All values greater than upper_bound are\ngrouped together into a single bucket; for example if `upper_bound` = 89,\nthen all values greater than 89 are replaced with the value “89+”.\n[Required].", @@ -20,10 +1742,7 @@ "format": "double", "type": "number" } - }, - "id": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig", - "description": "Buckets values based on fixed size ranges. The\nBucketing transformation can provide all of this functionality,\nbut requires more configuration. This message is provided as a convenience to\nthe user for simple bucketing strategies.\n\nThe transformed value will be a hyphenated string of\n\u003clower_bound\u003e-\u003cupper_bound\u003e, i.e if lower_bound = 10 and upper_bound = 20\nall values that are within this bucket will be replaced with \"10-20\".\n\nThis can be used on data of type: double, long.\n\nIf the bound Value type differs from the type of data\nbeing transformed, we will first attempt converting the type of the data to\nbe transformed to match the type of the bound before comparing.", - "type": "object" + } }, "GooglePrivacyDlpV2beta2CancelDlpJobRequest": { "description": "The request message for canceling a DLP job.", @@ -32,7 +1751,6 @@ "id": "GooglePrivacyDlpV2beta2CancelDlpJobRequest" }, "GooglePrivacyDlpV2beta2Row": { - "type": "object", "properties": { "values": { "type": "array", @@ -41,32 +1759,13 @@ } } }, - "id": "GooglePrivacyDlpV2beta2Row" + "id": "GooglePrivacyDlpV2beta2Row", + "type": "object" }, "GooglePrivacyDlpV2beta2Finding": { "description": "Represents a piece of potentially sensitive content.", "type": "object", "properties": { - "likelihood": { - "enum": [ - "LIKELIHOOD_UNSPECIFIED", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Estimate of how likely it is that the `info_type` is correct.", - "type": "string", - "enumDescriptions": [ - "Default value; information with all likelihoods is included.", - "Few matching elements.", - "", - "Some matching elements.", - "", - "Many matching elements." - ] - }, "infoType": { "description": "The type of content that might have been found.\nProvided if requested by the `InspectConfig`.", "$ref": "GooglePrivacyDlpV2beta2InfoType" @@ -83,16 +1782,34 @@ "location": { "$ref": "GooglePrivacyDlpV2beta2Location", "description": "Where the content was found." + }, + "likelihood": { + "enumDescriptions": [ + "Default value; information with all likelihoods is included.", + "Few matching elements.", + "", + "Some matching elements.", + "", + "Many matching elements." + ], + "enum": [ + "LIKELIHOOD_UNSPECIFIED", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Estimate of how likely it is that the `info_type` is correct.", + "type": "string" } }, "id": "GooglePrivacyDlpV2beta2Finding" }, "GooglePrivacyDlpV2beta1TaggedField": { + "description": "A column with a semantic tag attached.", + "type": "object", "properties": { - "customTag": { - "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", - "type": "string" - }, "infoType": { "$ref": "GooglePrivacyDlpV2beta1InfoType", "description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders." @@ -102,30 +1819,34 @@ "$ref": "GoogleProtobufEmpty" }, "field": { - "description": "Identifies the column. [required]", - "$ref": "GooglePrivacyDlpV2beta1FieldId" + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "Identifies the column. [required]" + }, + "customTag": { + "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", + "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1TaggedField", - "description": "A column with a semantic tag attached.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1TaggedField" }, "GooglePrivacyDlpV2beta2PartitionId": { + "id": "GooglePrivacyDlpV2beta2PartitionId", "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.", "type": "object", "properties": { "projectId": { - "description": "The ID of the project to which the entities belong.", - "type": "string" + "type": "string", + "description": "The ID of the project to which the entities belong." }, "namespaceId": { - "description": "If not empty, the ID of the namespace to which the entities belong.", - "type": "string" + "type": "string", + "description": "If not empty, the ID of the namespace to which the entities belong." } - }, - "id": "GooglePrivacyDlpV2beta2PartitionId" + } }, "GooglePrivacyDlpV2beta2Conditions": { + "description": "A collection of conditions.", + "type": "object", "properties": { "conditions": { "type": "array", @@ -134,20 +1855,12 @@ } } }, - "id": "GooglePrivacyDlpV2beta2Conditions", - "description": "A collection of conditions.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2Conditions" }, "GooglePrivacyDlpV2beta2CharacterMaskConfig": { + "description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.", + "type": "object", "properties": { - "maskingCharacter": { - "description": "Character to mask the sensitive values—for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits.", - "type": "string" - }, - "reverseOrder": { - "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***", - "type": "boolean" - }, "numberToMask": { "description": "Number of characters to mask. If not set, all matching chars will be\nmasked. Skipped characters do not count towards this tally.", "format": "int32", @@ -159,13 +1872,21 @@ "items": { "$ref": "GooglePrivacyDlpV2beta2CharsToIgnore" } + }, + "maskingCharacter": { + "type": "string", + "description": "Character to mask the sensitive values—for example, \"*\" for an\nalphabetic string such as name, or \"0\" for a numeric string such as ZIP\ncode or credit card number. String must have length 1. If not supplied, we\nwill default to \"*\" for strings, 0 for digits." + }, + "reverseOrder": { + "description": "Mask characters in reverse order. For example, if `masking_character` is\n'0', number_to_mask is 14, and `reverse_order` is false, then\n1234-5678-9012-3456 -\u003e 00000000000000-3456\nIf `masking_character` is '*', `number_to_mask` is 3, and `reverse_order`\nis true, then 12345 -\u003e 12***", + "type": "boolean" } }, - "id": "GooglePrivacyDlpV2beta2CharacterMaskConfig", - "description": "Partially mask a string by replacing a given number of characters with a\nfixed character. Masking can start from the beginning or end of the string.\nThis can be used on data of any type (numbers, longs, and so on) and when\nde-identifying structured data we'll attempt to preserve the original data's\ntype. (This allows you to take a long like 123 and modify it to a string like\n**3.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2CharacterMaskConfig" }, "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues": { + "description": "A tuple of values for the quasi-identifier columns.", + "type": "object", "properties": { "estimatedAnonymity": { "description": "The estimated anonymity for these quasi-identifier values.", @@ -180,11 +1901,10 @@ } } }, - "id": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues", - "description": "A tuple of values for the quasi-identifier columns.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues" }, "GooglePrivacyDlpV2beta2InspectJobConfig": { + "type": "object", "properties": { "inspectConfig": { "description": "How and what to scan for.", @@ -195,18 +1915,19 @@ "type": "string" }, "storageConfig": { - "description": "The data to scan.", - "$ref": "GooglePrivacyDlpV2beta2StorageConfig" + "$ref": "GooglePrivacyDlpV2beta2StorageConfig", + "description": "The data to scan." }, "outputConfig": { "$ref": "GooglePrivacyDlpV2beta2OutputStorageConfig", "description": "Where to put the findings." } }, - "id": "GooglePrivacyDlpV2beta2InspectJobConfig", - "type": "object" + "id": "GooglePrivacyDlpV2beta2InspectJobConfig" }, "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse": { + "description": "Response message for ListDeidentifyTemplates.", + "type": "object", "properties": { "deidentifyTemplates": { "description": "List of deidentify templates, up to page_size in\nListDeidentifyTemplatesRequest.", @@ -220,17 +1941,14 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse", - "description": "Response message for ListDeidentifyTemplates.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse" }, "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest": { - "description": "Request message for UpdateDeidentifyTemplate.", "type": "object", "properties": { "deidentifyTemplate": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate", - "description": "New DeidentifyTemplate value." + "description": "New DeidentifyTemplate value.", + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" }, "updateMask": { "description": "Mask to control which fields get updated.", @@ -238,53 +1956,53 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest" + "id": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest", + "description": "Request message for UpdateDeidentifyTemplate." }, "GooglePrivacyDlpV2beta2SurrogateType": { + "type": "object", "properties": {}, "id": "GooglePrivacyDlpV2beta2SurrogateType", - "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.", - "type": "object" + "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`." }, "GooglePrivacyDlpV2beta2CryptoKey": { + "description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.", + "type": "object", "properties": { + "transient": { + "$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey" + }, "kmsWrapped": { "$ref": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey" }, "unwrapped": { "$ref": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey" - }, - "transient": { - "$ref": "GooglePrivacyDlpV2beta2TransientCryptoKey" } }, - "id": "GooglePrivacyDlpV2beta2CryptoKey", - "description": "This is a data encryption key (DEK) (as opposed to\na key encryption key (KEK) stored by KMS).\nWhen using KMS to wrap/unwrap DEKs, be sure to set an appropriate\nIAM policy on the KMS CryptoKey (KEK) to ensure an attacker cannot\nunwrap the data crypto key.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2CryptoKey" }, "GooglePrivacyDlpV2beta1InfoTypeStatistics": { + "description": "Statistics regarding a specific InfoType.", + "type": "object", "properties": { + "infoType": { + "$ref": "GooglePrivacyDlpV2beta1InfoType", + "description": "The type of finding this stat is for." + }, "count": { "description": "Number of findings for this info type.", "format": "int64", "type": "string" - }, - "infoType": { - "description": "The type of finding this stat is for.", - "$ref": "GooglePrivacyDlpV2beta1InfoType" } }, - "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics", - "description": "Statistics regarding a specific InfoType.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1InfoTypeStatistics" }, "GooglePrivacyDlpV2beta2CloudStorageKey": { - "description": "Record key for a finding in a Cloud Storage file.", "type": "object", "properties": { "filePath": { - "description": "Path to the file.", - "type": "string" + "type": "string", + "description": "Path to the file." }, "startOffset": { "description": "Byte offset of the referenced data in the file.", @@ -292,7 +2010,8 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2CloudStorageKey" + "id": "GooglePrivacyDlpV2beta2CloudStorageKey", + "description": "Record key for a finding in a Cloud Storage file." }, "GooglePrivacyDlpV2beta2KAnonymityConfig": { "description": "k-anonymity metric, used for analysis of reidentification risk.", @@ -313,19 +2032,17 @@ "id": "GooglePrivacyDlpV2beta2KAnonymityConfig" }, "GooglePrivacyDlpV2beta1PropertyReference": { + "description": "A reference to a property relative to the Datastore kind expressions.", + "type": "object", "properties": { "name": { "description": "The name of the property.\nIf name includes \".\"s, it may be interpreted as a property name path.", "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1PropertyReference", - "description": "A reference to a property relative to the Datastore kind expressions.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1PropertyReference" }, "GooglePrivacyDlpV2beta2InfoTypeDescription": { - "description": "InfoType description.", - "type": "object", "properties": { "name": { "description": "Internal name of the infoType.", @@ -353,10 +2070,22 @@ } } }, - "id": "GooglePrivacyDlpV2beta2InfoTypeDescription" + "id": "GooglePrivacyDlpV2beta2InfoTypeDescription", + "description": "InfoType description.", + "type": "object" }, "GooglePrivacyDlpV2beta2ReidentifyContentRequest": { + "description": "Request to re-identify an item.", + "type": "object", "properties": { + "reidentifyConfig": { + "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`", + "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig" + }, + "item": { + "$ref": "GooglePrivacyDlpV2beta2ContentItem", + "description": "The item to re-identify. Will be treated as text." + }, "reidentifyTemplateName": { "description": "Optional template to use. References an instance of `DeidentifyTemplate`.\nAny configuration directly specified in `reidentify_config` or\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", "type": "string" @@ -368,36 +2097,27 @@ "inspectTemplateName": { "description": "Optional template to use. Any configuration directly specified in\n`inspect_config` will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", "type": "string" - }, - "reidentifyConfig": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig", - "description": "Configuration for the re-identification of the content item.\nThis field shares the same proto message type that is used for\nde-identification, however its usage here is for the reversal of the\nprevious de-identification. Re-identification is performed by examining\nthe transformations used to de-identify the items and executing the\nreverse. This requires that only reversible transformations\nbe provided here. The reversible transformations are:\n\n - `CryptoReplaceFfxFpeConfig`" - }, - "item": { - "$ref": "GooglePrivacyDlpV2beta2ContentItem", - "description": "The item to re-identify. Will be treated as text." } }, - "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest", - "description": "Request to re-identify an item.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2ReidentifyContentRequest" }, "GooglePrivacyDlpV2beta2InspectDataSourceDetails": { "description": "The results of an inspect DataSource job.", "type": "object", "properties": { - "requestedOptions": { - "description": "The configuration used for this job.", - "$ref": "GooglePrivacyDlpV2beta2RequestedOptions" - }, "result": { "$ref": "GooglePrivacyDlpV2beta2Result", "description": "A summary of the outcome of this inspect job." + }, + "requestedOptions": { + "description": "The configuration used for this job.", + "$ref": "GooglePrivacyDlpV2beta2RequestedOptions" } }, "id": "GooglePrivacyDlpV2beta2InspectDataSourceDetails" }, "GooglePrivacyDlpV2beta2LDiversityResult": { + "type": "object", "properties": { "sensitiveValueFrequencyHistogramBuckets": { "description": "Histogram of l-diversity equivalence class sensitive value frequencies.", @@ -408,27 +2128,23 @@ } }, "id": "GooglePrivacyDlpV2beta2LDiversityResult", - "description": "Result of the l-diversity computation.", - "type": "object" + "description": "Result of the l-diversity computation." }, "GooglePrivacyDlpV2beta2InspectContentResponse": { + "description": "Results of inspecting an item.", + "type": "object", "properties": { "result": { "description": "The findings.", "$ref": "GooglePrivacyDlpV2beta2InspectResult" } }, - "id": "GooglePrivacyDlpV2beta2InspectContentResponse", - "description": "Results of inspecting an item.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2InspectContentResponse" }, "GooglePrivacyDlpV2beta2Color": { + "description": "Represents a color in the RGB color space.", + "type": "object", "properties": { - "red": { - "description": "The amount of red in the color as a value in the interval [0, 1].", - "format": "float", - "type": "number" - }, "green": { "description": "The amount of green in the color as a value in the interval [0, 1].", "format": "float", @@ -438,13 +2154,18 @@ "description": "The amount of blue in the color as a value in the interval [0, 1].", "format": "float", "type": "number" + }, + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" } }, - "id": "GooglePrivacyDlpV2beta2Color", - "description": "Represents a color in the RGB color space.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2Color" }, "GooglePrivacyDlpV2beta1OutputStorageConfig": { + "description": "Cloud repository for storing output.", + "type": "object", "properties": { "table": { "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", @@ -455,30 +2176,30 @@ "description": "The path to a Google Cloud Storage location to store output.\nThe bucket must already exist and\nthe Google APIs service account for DLP must have write permission to\nwrite to the given bucket.\nResults are split over multiple csv files with each file name matching\nthe pattern \"[operation_id]_[count].csv\", for example\n`3094877188788974909_1.csv`. The `operation_id` matches the\nidentifier for the Operation, and the `count` is a counter used for\ntracking the number of files written.\n\nThe CSV file(s) contain the following columns regardless of storage type\nscanned:\n- id\n- info_type\n- likelihood\n- byte size of finding\n- quote\n- timestamp\n\nFor Cloud Storage the next columns are:\n\n- file_path\n- start_offset\n\nFor Cloud Datastore the next columns are:\n\n- project_id\n- namespace_id\n- path\n- column_name\n- offset\n\nFor BigQuery the next columns are:\n\n- row_number\n- project_id\n- dataset_id\n- table_id" } }, - "id": "GooglePrivacyDlpV2beta1OutputStorageConfig", - "description": "Cloud repository for storing output.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1OutputStorageConfig" }, "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass": { + "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass", + "description": "The set of columns' values that share the same k-anonymity value.", + "type": "object", "properties": { + "equivalenceClassSize": { + "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.", + "format": "int64", + "type": "string" + }, "quasiIdsValues": { "description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1Value" } - }, - "equivalenceClassSize": { - "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.", - "format": "int64", - "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta1KAnonymityEquivalenceClass", - "description": "The set of columns' values that share the same k-anonymity value.", - "type": "object" + } }, "GooglePrivacyDlpV2beta2BigQueryTable": { + "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.", + "type": "object", "properties": { "tableId": { "description": "Name of the table.", @@ -493,20 +2214,18 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2BigQueryTable", - "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2BigQueryTable" }, "GooglePrivacyDlpV2beta2DatastoreKey": { + "description": "Record key for a finding in Cloud Datastore.", + "type": "object", "properties": { "entityKey": { - "description": "Datastore entity key.", - "$ref": "GooglePrivacyDlpV2beta2Key" + "$ref": "GooglePrivacyDlpV2beta2Key", + "description": "Datastore entity key." } }, - "id": "GooglePrivacyDlpV2beta2DatastoreKey", - "description": "Record key for a finding in Cloud Datastore.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2DatastoreKey" }, "GooglePrivacyDlpV2beta2RedactImageResponse": { "description": "Results of redacting an image.", @@ -525,26 +2244,28 @@ "id": "GooglePrivacyDlpV2beta2RedactImageResponse" }, "GooglePrivacyDlpV2beta1InspectOperationMetadata": { - "description": "Metadata returned within GetOperation for an inspect request.", - "type": "object", "properties": { + "requestInspectConfig": { + "$ref": "GooglePrivacyDlpV2beta1InspectConfig", + "description": "The inspect config used to create the Operation." + }, "requestOutputConfig": { "$ref": "GooglePrivacyDlpV2beta1OutputStorageConfig", "description": "Optional location to store findings." }, "createTime": { + "type": "string", "description": "The time which this request was started.", - "format": "google-datetime", - "type": "string" + "format": "google-datetime" }, "requestStorageConfig": { "$ref": "GooglePrivacyDlpV2beta1StorageConfig", "description": "The storage config used to create the Operation." }, "processedBytes": { + "type": "string", "description": "Total size in bytes that were processed.", - "format": "int64", - "type": "string" + "format": "int64" }, "infoTypeStats": { "type": "array", @@ -556,37 +2277,35 @@ "description": "Estimate of the number of bytes to process.", "format": "int64", "type": "string" - }, - "requestInspectConfig": { - "$ref": "GooglePrivacyDlpV2beta1InspectConfig", - "description": "The inspect config used to create the Operation." } }, - "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata" - }, - "GooglePrivacyDlpV2beta2RecordKey": { - "properties": { - "datastoreKey": { - "$ref": "GooglePrivacyDlpV2beta2DatastoreKey" - }, - "cloudStorageKey": { - "$ref": "GooglePrivacyDlpV2beta2CloudStorageKey" - } - }, - "id": "GooglePrivacyDlpV2beta2RecordKey", - "description": "Message for a unique key indicating a record that contains a finding.", + "id": "GooglePrivacyDlpV2beta1InspectOperationMetadata", + "description": "Metadata returned within GetOperation for an inspect request.", "type": "object" }, + "GooglePrivacyDlpV2beta2RecordKey": { + "description": "Message for a unique key indicating a record that contains a finding.", + "type": "object", + "properties": { + "cloudStorageKey": { + "$ref": "GooglePrivacyDlpV2beta2CloudStorageKey" + }, + "datastoreKey": { + "$ref": "GooglePrivacyDlpV2beta2DatastoreKey" + } + }, + "id": "GooglePrivacyDlpV2beta2RecordKey" + }, "GooglePrivacyDlpV2beta1InfoType": { + "description": "Type of information detected by the API.", + "type": "object", "properties": { "name": { "description": "Name of the information type.", "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1InfoType", - "description": "Type of information detected by the API.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1InfoType" }, "GooglePrivacyDlpV2beta2EntityId": { "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.", @@ -606,8 +2325,8 @@ "description": "Lower bound of the range, inclusive. Type should be the same as max if\nused." }, "max": { - "$ref": "GooglePrivacyDlpV2beta2Value", - "description": "Upper bound of the range, exclusive; type must match min." + "description": "Upper bound of the range, exclusive; type must match min.", + "$ref": "GooglePrivacyDlpV2beta2Value" }, "replacementValue": { "$ref": "GooglePrivacyDlpV2beta2Value", @@ -619,7 +2338,6 @@ "type": "object" }, "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest": { - "description": "Request message for CreateInspectTemplate.", "type": "object", "properties": { "templateId": { @@ -631,12 +2349,19 @@ "description": "The InspectTemplate to create." } }, - "id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest" + "id": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest", + "description": "Request message for CreateInspectTemplate." }, "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult": { "description": "Result of a risk analysis\n[`Operation`](/dlp/docs/reference/rest/v2beta1/inspect.operations)\nrequest.", "type": "object", "properties": { + "kAnonymityResult": { + "$ref": "GooglePrivacyDlpV2beta1KAnonymityResult" + }, + "lDiversityResult": { + "$ref": "GooglePrivacyDlpV2beta1LDiversityResult" + }, "categoricalStatsResult": { "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsResult" }, @@ -645,12 +2370,6 @@ }, "kMapEstimationResult": { "$ref": "GooglePrivacyDlpV2beta1KMapEstimationResult" - }, - "kAnonymityResult": { - "$ref": "GooglePrivacyDlpV2beta1KAnonymityResult" - }, - "lDiversityResult": { - "$ref": "GooglePrivacyDlpV2beta1LDiversityResult" } }, "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationResult" @@ -658,8 +2377,8 @@ "GooglePrivacyDlpV2beta1CategoricalStatsConfig": { "properties": { "field": { - "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.", - "$ref": "GooglePrivacyDlpV2beta1FieldId" + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data." } }, "id": "GooglePrivacyDlpV2beta1CategoricalStatsConfig", @@ -667,12 +2386,8 @@ "type": "object" }, "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket": { + "type": "object", "properties": { - "valueFrequencyUpperBound": { - "description": "Upper bound on the value frequency of the values in this bucket.", - "format": "int64", - "type": "string" - }, "valueFrequencyLowerBound": { "description": "Lower bound on the value frequency of the values in this bucket.", "format": "int64", @@ -689,19 +2404,25 @@ "description": "Total number of values in this bucket.", "format": "int64", "type": "string" + }, + "valueFrequencyUpperBound": { + "description": "Upper bound on the value frequency of the values in this bucket.", + "format": "int64", + "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket", - "type": "object" + "id": "GooglePrivacyDlpV2beta2CategoricalStatsHistogramBucket" }, "GooglePrivacyDlpV2beta1KMapEstimationConfig": { + "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.", + "type": "object", "properties": { "auxiliaryTables": { - "description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1AuxiliaryTable" - } + }, + "description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table." }, "quasiIds": { "description": "Fields considered to be quasi-identifiers. No two columns can have the\nsame tag. [required]", @@ -715,33 +2436,33 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1KMapEstimationConfig", - "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1KMapEstimationConfig" }, "GooglePrivacyDlpV2beta2NumericalStatsResult": { + "description": "Result of the numerical stats computation.", + "type": "object", "properties": { "minValue": { "$ref": "GooglePrivacyDlpV2beta2Value", "description": "Minimum value appearing in the column." }, "maxValue": { - "description": "Maximum value appearing in the column.", - "$ref": "GooglePrivacyDlpV2beta2Value" + "$ref": "GooglePrivacyDlpV2beta2Value", + "description": "Maximum value appearing in the column." }, "quantileValues": { - "description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2Value" - } + }, + "description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets." } }, - "id": "GooglePrivacyDlpV2beta2NumericalStatsResult", - "description": "Result of the numerical stats computation.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2NumericalStatsResult" }, "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata": { + "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.", + "type": "object", "properties": { "createTime": { "description": "The time which this request was started.", @@ -753,15 +2474,15 @@ "description": "Input dataset to compute metrics over." }, "requestedPrivacyMetric": { - "description": "Privacy metric to compute.", - "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric" + "$ref": "GooglePrivacyDlpV2beta1PrivacyMetric", + "description": "Privacy metric to compute." } }, - "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata", - "description": "Metadata returned within the\n[`riskAnalysis.operations.get`](/dlp/docs/reference/rest/v2beta1/riskAnalysis.operations/get)\nfor risk analysis.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1RiskAnalysisOperationMetadata" }, "GooglePrivacyDlpV2beta2TaggedField": { + "description": "A column with a semantic tag attached.", + "type": "object", "properties": { "customTag": { "description": "A column can be tagged with a custom tag. In this case, the user must\nindicate an auxiliary table that contains statistical information on\nthe possible values of this column (below).", @@ -772,17 +2493,15 @@ "description": "A column can be tagged with a InfoType to use the relevant public\ndataset as a statistical model of population, if available. We\ncurrently support US ZIP codes, region codes, ages and genders." }, "inferred": { - "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data", - "$ref": "GoogleProtobufEmpty" + "$ref": "GoogleProtobufEmpty", + "description": "If no semantic tag is indicated, we infer the statistical model from\nthe distribution of values in the input data" }, "field": { "$ref": "GooglePrivacyDlpV2beta2FieldId", "description": "Identifies the column. [required]" } }, - "id": "GooglePrivacyDlpV2beta2TaggedField", - "description": "A column with a semantic tag attached.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2TaggedField" }, "GooglePrivacyDlpV2beta2InspectContentRequest": { "properties": { @@ -807,6 +2526,15 @@ "description": "The DeidentifyTemplates contains instructions on how to deidentify content.", "type": "object", "properties": { + "updateTime": { + "description": "The last update timestamp of a inspectTemplate, output only field.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`", + "type": "string" + }, "displayName": { "description": "Display name (max 256 chars).", "type": "string" @@ -816,50 +2544,34 @@ "type": "string" }, "deidentifyConfig": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig", - "description": "///////////// // The core content of the template // ///////////////" + "description": "///////////// // The core content of the template // ///////////////", + "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig" }, "createTime": { "description": "The creation timestamp of a inspectTemplate, output only field.", "format": "google-datetime", "type": "string" - }, - "updateTime": { - "description": "The last update timestamp of a inspectTemplate, output only field.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "The template name. Output only.\n\nThe template will have one of the following formats:\n`projects/PROJECT_ID/deidentifyTemplates/TEMPLATE_ID` OR\n`organizations/ORGANIZATION_ID/deidentifyTemplates/TEMPLATE_ID`", - "type": "string" } }, "id": "GooglePrivacyDlpV2beta2DeidentifyTemplate" }, "GooglePrivacyDlpV2beta2DatastoreOptions": { + "description": "Options defining a data set within Google Cloud Datastore.", + "type": "object", "properties": { "partitionId": { - "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.", - "$ref": "GooglePrivacyDlpV2beta2PartitionId" + "$ref": "GooglePrivacyDlpV2beta2PartitionId", + "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty." }, "kind": { "$ref": "GooglePrivacyDlpV2beta2KindExpression", "description": "The kind to process." } }, - "id": "GooglePrivacyDlpV2beta2DatastoreOptions", - "description": "Options defining a data set within Google Cloud Datastore.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2DatastoreOptions" }, "GooglePrivacyDlpV2beta2InspectTemplate": { - "description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.", - "type": "object", "properties": { - "createTime": { - "description": "The creation timestamp of a inspectTemplate, output only field.", - "format": "google-datetime", - "type": "string" - }, "updateTime": { "description": "The last update timestamp of a inspectTemplate, output only field.", "format": "google-datetime", @@ -870,8 +2582,8 @@ "type": "string" }, "inspectConfig": { - "description": "The core content of the template. Configuration of the scanning process.", - "$ref": "GooglePrivacyDlpV2beta2InspectConfig" + "$ref": "GooglePrivacyDlpV2beta2InspectConfig", + "description": "The core content of the template. Configuration of the scanning process." }, "displayName": { "description": "Display name (max 256 chars).", @@ -880,15 +2592,31 @@ "description": { "description": "Short description (max 256 chars).", "type": "string" + }, + "createTime": { + "type": "string", + "description": "The creation timestamp of a inspectTemplate, output only field.", + "format": "google-datetime" } }, - "id": "GooglePrivacyDlpV2beta2InspectTemplate" + "id": "GooglePrivacyDlpV2beta2InspectTemplate", + "description": "The inspectTemplate contains a configuration (set of types of sensitive data\nto be detected) to be used anywhere you otherwise would normally specify\nInspectConfig.", + "type": "object" }, "GooglePrivacyDlpV2beta2CharsToIgnore": { + "id": "GooglePrivacyDlpV2beta2CharsToIgnore", "description": "Characters to skip when doing deidentification of a value. These will be left\nalone and skipped.", "type": "object", "properties": { "commonCharactersToIgnore": { + "enumDescriptions": [ + "", + "0-9", + "A-Z", + "a-z", + "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~", + "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]" + ], "enum": [ "COMMON_CHARS_TO_IGNORE_UNSPECIFIED", "NUMERIC", @@ -897,21 +2625,12 @@ "PUNCTUATION", "WHITESPACE" ], - "type": "string", - "enumDescriptions": [ - "", - "0-9", - "A-Z", - "a-z", - "US Punctuation, one of !\"#$%&'()*+,-./:;\u003c=\u003e?@[\\]^_`{|}~", - "Whitespace character, one of [ \\t\\n\\x0B\\f\\r]" - ] + "type": "string" }, "charactersToSkip": { "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta2CharsToIgnore" + } }, "GoogleProtobufEmpty": { "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 `{}`.", @@ -926,7 +2645,6 @@ "id": "GooglePrivacyDlpV2beta2RedactConfig" }, "GooglePrivacyDlpV2beta2FieldId": { - "description": "General identifier of a data field in a storage service.", "type": "object", "properties": { "name": { @@ -934,90 +2652,80 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2FieldId" + "id": "GooglePrivacyDlpV2beta2FieldId", + "description": "General identifier of a data field in a storage service." }, "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest": { + "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest", + "description": "Request for creating a risk analysis DlpJob.", + "type": "object", "properties": { "jobConfig": { "$ref": "GooglePrivacyDlpV2beta2RiskAnalysisJobConfig", "description": "Configuration for this risk analysis job." } - }, - "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest", - "description": "Request for creating a risk analysis DlpJob.", - "type": "object" + } }, "GooglePrivacyDlpV2beta2DeidentifyContentRequest": { + "description": "Request to de-identify a list of items.", + "type": "object", "properties": { "item": { - "description": "The item to de-identify. Will be treated as text.", - "$ref": "GooglePrivacyDlpV2beta2ContentItem" + "$ref": "GooglePrivacyDlpV2beta2ContentItem", + "description": "The item to de-identify. Will be treated as text." }, "deidentifyTemplateName": { - "description": "Optional template to use. Any configuration directly specified in\ndeidentify_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", - "type": "string" + "type": "string", + "description": "Optional template to use. Any configuration directly specified in\ndeidentify_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged." }, "deidentifyConfig": { "$ref": "GooglePrivacyDlpV2beta2DeidentifyConfig", "description": "Configuration for the de-identification of the content item.\nItems specified here will override the template referenced by the\ndeidentify_template_name argument." }, "inspectConfig": { - "description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument.", - "$ref": "GooglePrivacyDlpV2beta2InspectConfig" + "$ref": "GooglePrivacyDlpV2beta2InspectConfig", + "description": "Configuration for the inspector.\nItems specified here will override the template referenced by the\ninspect_template_name argument." }, "inspectTemplateName": { "description": "Optional template to use. Any configuration directly specified in\ninspect_config will override those set in the template. Singular fields\nthat are set in this request will replace their corresponding fields in the\ntemplate. Repeated fields are appended. Singular sub-messages and groups\nare recursively merged.", "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2DeidentifyContentRequest", - "description": "Request to de-identify a list of items.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2DeidentifyContentRequest" }, "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket": { + "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.", + "type": "object", "properties": { - "bucketValues": { - "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues" - } - }, "minAnonymity": { "description": "Always positive.", "format": "int64", "type": "string" }, "maxAnonymity": { + "type": "string", "description": "Always greater than or equal to min_anonymity.", - "format": "int64", - "type": "string" + "format": "int64" }, "bucketSize": { "description": "Number of records within these anonymity bounds.", "format": "int64", "type": "string" + }, + "bucketValues": { + "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues" + } } }, - "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket", - "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1KMapEstimationHistogramBucket" }, "GooglePrivacyDlpV2beta2InspectConfig": { "description": "Configuration description of the scanning process.\nWhen used with redactContent only info_types and min_likelihood are currently\nused.", "type": "object", "properties": { - "infoTypes": { - "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2InfoType" - } - }, - "includeQuote": { - "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.", - "type": "boolean" - }, "customInfoTypes": { "description": "Custom infoTypes provided by the user.", "type": "array", @@ -1051,19 +2759,30 @@ ], "description": "Only returns findings equal or above this threshold. The default is\nPOSSIBLE.", "type": "string" + }, + "infoTypes": { + "description": "Restricts what info_types to look for. The values must correspond to\nInfoType values returned by ListInfoTypes or found in documentation.\nEmpty info_types runs all enabled detectors.", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2InfoType" + } + }, + "includeQuote": { + "description": "When true, a contextual quote from the data that triggered a finding is\nincluded in the response; see Finding.quote.", + "type": "boolean" } }, "id": "GooglePrivacyDlpV2beta2InspectConfig" }, "GooglePrivacyDlpV2beta1CloudStorageOptions": { - "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.", - "type": "object", "properties": { "fileSet": { "$ref": "GooglePrivacyDlpV2beta1FileSet" } }, - "id": "GooglePrivacyDlpV2beta1CloudStorageOptions" + "id": "GooglePrivacyDlpV2beta1CloudStorageOptions", + "description": "Options defining a file or a set of files (path ending with *) within\na Google Cloud Storage bucket.", + "type": "object" }, "GooglePrivacyDlpV2beta2QuasiIdField": { "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.", @@ -1079,12 +2798,10 @@ "id": "GooglePrivacyDlpV2beta2QuasiIdField" }, "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails": { + "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails", "description": "Result of a risk analysis operation request.", "type": "object", "properties": { - "kAnonymityResult": { - "$ref": "GooglePrivacyDlpV2beta2KAnonymityResult" - }, "kMapEstimationResult": { "$ref": "GooglePrivacyDlpV2beta2KMapEstimationResult" }, @@ -1104,29 +2821,32 @@ }, "numericalStatsResult": { "$ref": "GooglePrivacyDlpV2beta2NumericalStatsResult" + }, + "kAnonymityResult": { + "$ref": "GooglePrivacyDlpV2beta2KAnonymityResult" } - }, - "id": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails" + } }, "GooglePrivacyDlpV2beta2BigQueryOptions": { + "description": "Options defining BigQuery table and row identifiers.", + "type": "object", "properties": { "tableReference": { - "description": "Complete BigQuery table reference.", - "$ref": "GooglePrivacyDlpV2beta2BigQueryTable" + "$ref": "GooglePrivacyDlpV2beta2BigQueryTable", + "description": "Complete BigQuery table reference." }, "identifyingFields": { - "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2FieldId" - } + }, + "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed." } }, - "id": "GooglePrivacyDlpV2beta2BigQueryOptions", - "description": "Options defining BigQuery table and row identifiers.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2BigQueryOptions" }, "GooglePrivacyDlpV2beta1CloudStoragePath": { + "id": "GooglePrivacyDlpV2beta1CloudStoragePath", "description": "A location in Cloud Storage.", "type": "object", "properties": { @@ -1134,8 +2854,7 @@ "description": "The url, in the format of `gs://bucket/\u003cpath\u003e`.", "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta1CloudStoragePath" + } }, "GooglePrivacyDlpV2beta2TransformationOverview": { "description": "Overview of the modifications that occurred.", @@ -1147,27 +2866,29 @@ "type": "string" }, "transformationSummaries": { - "description": "Transformations applied to the dataset.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2TransformationSummary" - } + }, + "description": "Transformations applied to the dataset." } }, "id": "GooglePrivacyDlpV2beta2TransformationOverview" }, "GooglePrivacyDlpV2beta1InspectOperationResult": { + "description": "The operational data.", + "type": "object", "properties": { "name": { "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `inspect/results/{id}`.", "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1InspectOperationResult", - "description": "The operational data.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1InspectOperationResult" }, "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket": { + "description": "Histogram bucket of equivalence class sizes in the table.", + "type": "object", "properties": { "equivalenceClassSizeLowerBound": { "description": "Lower bound on the size of the equivalence classes in this bucket.", @@ -1180,9 +2901,9 @@ "type": "string" }, "bucketSize": { + "type": "string", "description": "Total number of records in this bucket.", - "format": "int64", - "type": "string" + "format": "int64" }, "bucketValues": { "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", @@ -1192,15 +2913,14 @@ } } }, - "id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket", - "description": "Histogram bucket of equivalence class sizes in the table.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1KAnonymityHistogramBucket" }, "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse": { + "type": "object", "properties": { "nextPageToken": { - "description": "If the next page is available then the next page token to be used\nin following ListInspectTemplates request.", - "type": "string" + "type": "string", + "description": "If the next page is available then the next page token to be used\nin following ListInspectTemplates request." }, "inspectTemplates": { "description": "List of inspectTemplates, up to page_size in ListInspectTemplatesRequest.", @@ -1211,10 +2931,10 @@ } }, "id": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse", - "description": "Response message for ListInspectTemplates.", - "type": "object" + "description": "Response message for ListInspectTemplates." }, "GooglePrivacyDlpV2beta1CategoricalStatsResult": { + "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult", "description": "Result of the categorical stats computation.", "type": "object", "properties": { @@ -1225,8 +2945,7 @@ "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket" } } - }, - "id": "GooglePrivacyDlpV2beta1CategoricalStatsResult" + } }, "GooglePrivacyDlpV2beta1LDiversityResult": { "description": "Result of the l-diversity computation.", @@ -1243,6 +2962,7 @@ "id": "GooglePrivacyDlpV2beta1LDiversityResult" }, "GoogleTypeTimeOfDay": { + "type": "object", "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.", @@ -1266,11 +2986,9 @@ } }, "id": "GoogleTypeTimeOfDay", - "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`.", - "type": "object" + "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`." }, "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass": { - "description": "The set of columns' values that share the same ldiversity value.", "type": "object", "properties": { "equivalenceClassSize": { @@ -1298,52 +3016,53 @@ } } }, - "id": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass" + "id": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass", + "description": "The set of columns' values that share the same ldiversity value." }, "GooglePrivacyDlpV2beta2CategoricalStatsConfig": { + "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.", + "type": "object", "properties": { "field": { - "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data.", - "$ref": "GooglePrivacyDlpV2beta2FieldId" + "$ref": "GooglePrivacyDlpV2beta2FieldId", + "description": "Field to compute categorical stats on. All column types are\nsupported except for arrays and structs. However, it may be more\ninformative to use NumericalStats when the field type is supported,\ndepending on the data." } }, - "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig", - "description": "Compute numerical stats over an individual column, including\nnumber of distinct values and value count distribution.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2CategoricalStatsConfig" }, "GooglePrivacyDlpV2beta1LDiversityConfig": { + "description": "l-diversity metric, used for analysis of reidentification risk.", + "type": "object", "properties": { "sensitiveAttribute": { - "description": "Sensitive field for computing the l-value.", - "$ref": "GooglePrivacyDlpV2beta1FieldId" + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "Sensitive field for computing the l-value." }, "quasiIds": { - "description": "Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1FieldId" - } + }, + "description": "Set of quasi-identifiers indicating how equivalence classes are\ndefined for the l-diversity computation. When multiple fields are\nspecified, they are considered a single composite key." } }, - "id": "GooglePrivacyDlpV2beta1LDiversityConfig", - "description": "l-diversity metric, used for analysis of reidentification risk.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1LDiversityConfig" }, "GooglePrivacyDlpV2beta2ValueFrequency": { + "id": "GooglePrivacyDlpV2beta2ValueFrequency", + "description": "A value of a field, including its frequency.", + "type": "object", "properties": { "value": { "$ref": "GooglePrivacyDlpV2beta2Value", "description": "A value contained in the field in question." }, "count": { + "type": "string", "description": "How many times the value is contained in the field.", - "format": "int64", - "type": "string" + "format": "int64" } - }, - "id": "GooglePrivacyDlpV2beta2ValueFrequency", - "description": "A value of a field, including its frequency.", - "type": "object" + } }, "GooglePrivacyDlpV2beta2ReplaceValueConfig": { "description": "Replace each input value with a given `Value`.", @@ -1360,6 +3079,13 @@ "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).", "type": "object", "properties": { + "quasiIds": { + "description": "Quasi-identifier columns. [required]", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2QuasiIdField" + } + }, "relativeFrequency": { "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]", "$ref": "GooglePrivacyDlpV2beta2FieldId" @@ -1367,39 +3093,30 @@ "table": { "$ref": "GooglePrivacyDlpV2beta2BigQueryTable", "description": "Auxiliary table location. [required]" - }, - "quasiIds": { - "description": "Quasi-identifier columns. [required]", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2QuasiIdField" - } } }, "id": "GooglePrivacyDlpV2beta2AuxiliaryTable" }, "GooglePrivacyDlpV2beta1StorageConfig": { + "description": "Shared message indicating Cloud storage type.", + "type": "object", "properties": { + "cloudStorageOptions": { + "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions", + "description": "Google Cloud Storage options specification." + }, "datastoreOptions": { - "description": "Google Cloud Datastore options specification.", - "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions" + "$ref": "GooglePrivacyDlpV2beta1DatastoreOptions", + "description": "Google Cloud Datastore options specification." }, "bigQueryOptions": { "$ref": "GooglePrivacyDlpV2beta1BigQueryOptions", "description": "BigQuery options specification." - }, - "cloudStorageOptions": { - "$ref": "GooglePrivacyDlpV2beta1CloudStorageOptions", - "description": "Google Cloud Storage options specification." } }, - "id": "GooglePrivacyDlpV2beta1StorageConfig", - "description": "Shared message indicating Cloud storage type.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1StorageConfig" }, "GooglePrivacyDlpV2beta1BigQueryOptions": { - "description": "Options defining BigQuery table and row identifiers.", - "type": "object", "properties": { "identifyingFields": { "description": "References to fields uniquely identifying rows within the table.\nNested fields in the format, like `person.birthdate.year`, are allowed.", @@ -1409,22 +3126,16 @@ } }, "tableReference": { - "description": "Complete BigQuery table reference.", - "$ref": "GooglePrivacyDlpV2beta1BigQueryTable" + "$ref": "GooglePrivacyDlpV2beta1BigQueryTable", + "description": "Complete BigQuery table reference." } }, - "id": "GooglePrivacyDlpV2beta1BigQueryOptions" + "id": "GooglePrivacyDlpV2beta1BigQueryOptions", + "description": "Options defining BigQuery table and row identifiers.", + "type": "object" }, "GooglePrivacyDlpV2beta1PrivacyMetric": { - "description": "Privacy metric to compute for reidentification risk analysis.", - "type": "object", "properties": { - "numericalStatsConfig": { - "$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig" - }, - "kAnonymityConfig": { - "$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig" - }, "categoricalStatsConfig": { "$ref": "GooglePrivacyDlpV2beta1CategoricalStatsConfig" }, @@ -1433,23 +3144,37 @@ }, "lDiversityConfig": { "$ref": "GooglePrivacyDlpV2beta1LDiversityConfig" + }, + "numericalStatsConfig": { + "$ref": "GooglePrivacyDlpV2beta1NumericalStatsConfig" + }, + "kAnonymityConfig": { + "$ref": "GooglePrivacyDlpV2beta1KAnonymityConfig" } }, - "id": "GooglePrivacyDlpV2beta1PrivacyMetric" + "id": "GooglePrivacyDlpV2beta1PrivacyMetric", + "description": "Privacy metric to compute for reidentification risk analysis.", + "type": "object" }, "GooglePrivacyDlpV2beta2Location": { + "description": "Specifies the location of the finding.", + "type": "object", "properties": { + "recordKey": { + "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object.", + "$ref": "GooglePrivacyDlpV2beta2RecordKey" + }, "tableLocation": { "description": "The pointer to the row of the table that contained the finding.\nProvided when the finding's containing element is a cell of a table.", "$ref": "GooglePrivacyDlpV2beta2TableLocation" }, "codepointRange": { - "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text.", - "$ref": "GooglePrivacyDlpV2beta2Range" + "$ref": "GooglePrivacyDlpV2beta2Range", + "description": "Unicode character offsets delimiting the finding.\nThese are relative to the finding's containing element.\nProvided when the content is text." }, "fieldId": { - "description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object.", - "$ref": "GooglePrivacyDlpV2beta2FieldId" + "$ref": "GooglePrivacyDlpV2beta2FieldId", + "description": "The pointer to the property or cell that contained the finding.\nProvided when the finding's containing element is a cell in a table\nor a property of storage object." }, "imageBoxes": { "description": "The area within the image that contained the finding.\nProvided when the content is an image.", @@ -1461,17 +3186,13 @@ "byteRange": { "description": "Zero-based byte offsets delimiting the finding.\nThese are relative to the finding's containing element.\nNote that when the content is not textual, this references\nthe UTF-8 encoded textual representation of the content.\nOmitted if content is an image.", "$ref": "GooglePrivacyDlpV2beta2Range" - }, - "recordKey": { - "description": "The pointer to the record in storage that contained the field the\nfinding was found in.\nProvided when the finding's containing element is a property\nof a storage object.", - "$ref": "GooglePrivacyDlpV2beta2RecordKey" } }, - "id": "GooglePrivacyDlpV2beta2Location", - "description": "Specifies the location of the finding.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2Location" }, "GooglePrivacyDlpV2beta2ReidentifyContentResponse": { + "description": "Results of re-identifying a item.", + "type": "object", "properties": { "overview": { "description": "An overview of the changes that were made to the `item`.", @@ -1482,11 +3203,10 @@ "$ref": "GooglePrivacyDlpV2beta2ContentItem" } }, - "id": "GooglePrivacyDlpV2beta2ReidentifyContentResponse", - "description": "Results of re-identifying a item.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2ReidentifyContentResponse" }, "GooglePrivacyDlpV2beta2TransientCryptoKey": { + "type": "object", "properties": { "name": { "description": "Name of the key. [required]\nThis is an arbitrary string used to differentiate different keys.\nA unique key is generated per name: two separate `TransientCryptoKey`\nprotos share the same generated key if their names are the same.\nWhen the data crypto key is generated, this name is not used in any way\n(repeating the api call will result in a different key being generated).", @@ -1494,10 +3214,11 @@ } }, "id": "GooglePrivacyDlpV2beta2TransientCryptoKey", - "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes.", - "type": "object" + "description": "Use this to have a random data crypto key generated.\nIt will be discarded after the request finishes." }, "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass": { + "description": "The set of columns' values that share the same l-diversity value.", + "type": "object", "properties": { "quasiIdsValues": { "description": "Quasi-identifier values defining the k-anonymity equivalence\nclass. The order is always the same as the original request.", @@ -1524,9 +3245,7 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass", - "description": "The set of columns' values that share the same l-diversity value.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass" }, "GooglePrivacyDlpV2beta1NumericalStatsConfig": { "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.", @@ -1540,22 +3259,22 @@ "id": "GooglePrivacyDlpV2beta1NumericalStatsConfig" }, "GooglePrivacyDlpV2beta2InfoTypeTransformation": { - "description": "A transformation to apply to text that is identified as a specific\ninfo_type.", "type": "object", "properties": { "primitiveTransformation": { - "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation", - "description": "Primitive transformation to apply to the infoType. [required]" + "description": "Primitive transformation to apply to the infoType. [required]", + "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation" }, "infoTypes": { - "description": "InfoTypes to apply the transformation to. Empty list will match all\navailable infoTypes for this transformation.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2InfoType" - } + }, + "description": "InfoTypes to apply the transformation to. Empty list will match all\navailable infoTypes for this transformation." } }, - "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation" + "id": "GooglePrivacyDlpV2beta2InfoTypeTransformation", + "description": "A transformation to apply to text that is identified as a specific\ninfo_type." }, "GooglePrivacyDlpV2beta2CloudStorageOptions": { "properties": { @@ -1568,9 +3287,12 @@ "type": "object" }, "GooglePrivacyDlpV2beta2Condition": { - "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false.", "type": "object", "properties": { + "value": { + "$ref": "GooglePrivacyDlpV2beta2Value", + "description": "Value to compare against. [Required, except for `EXISTS` tests.]" + }, "field": { "$ref": "GooglePrivacyDlpV2beta2FieldId", "description": "Field within the record this condition is evaluated against. [required]" @@ -1598,13 +3320,10 @@ ], "description": "Operator used to compare the field or infoType to the value. [required]", "type": "string" - }, - "value": { - "$ref": "GooglePrivacyDlpV2beta2Value", - "description": "Value to compare against. [Required, except for `EXISTS` tests.]" } }, - "id": "GooglePrivacyDlpV2beta2Condition" + "id": "GooglePrivacyDlpV2beta2Condition", + "description": "The field type of `value` and `field` do not need to match to be\nconsidered equal, but not all comparisons are possible.\n\nA `value` of type:\n\n- `string` can be compared against all other types\n- `boolean` can only be compared against other booleans\n- `integer` can be compared against doubles or a string if the string value\ncan be parsed as an integer.\n- `double` can be compared against integers or a string if the string can\nbe parsed as a double.\n- `Timestamp` can be compared against strings in RFC 3339 date string\nformat.\n- `TimeOfDay` can be compared against timestamps and strings in the format\nof 'HH:mm:ss'.\n\nIf we fail to compare do to type mismatch, a warning will be given and\nthe condition will evaluate to false." }, "GooglePrivacyDlpV2beta2TableLocation": { "description": "Location of a finding within a table.", @@ -1619,6 +3338,8 @@ "id": "GooglePrivacyDlpV2beta2TableLocation" }, "GooglePrivacyDlpV2beta2KMapEstimationResult": { + "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", + "type": "object", "properties": { "kMapEstimationHistogram": { "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.", @@ -1628,42 +3349,32 @@ } } }, - "id": "GooglePrivacyDlpV2beta2KMapEstimationResult", - "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2KMapEstimationResult" }, "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass": { + "type": "object", "properties": { + "equivalenceClassSize": { + "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.", + "format": "int64", + "type": "string" + }, "quasiIdsValues": { "description": "Set of values defining the equivalence class. One value per\nquasi-identifier column in the original KAnonymity metric message.\nThe order is always the same as the original request.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2Value" } - }, - "equivalenceClassSize": { - "description": "Size of the equivalence class, for example number of rows with the\nabove set of values.", - "format": "int64", - "type": "string" } }, "id": "GooglePrivacyDlpV2beta2KAnonymityEquivalenceClass", - "description": "The set of columns' values that share the same ldiversity value", - "type": "object" + "description": "The set of columns' values that share the same ldiversity value" }, "GooglePrivacyDlpV2beta2PrimitiveTransformation": { + "id": "GooglePrivacyDlpV2beta2PrimitiveTransformation", "description": "A rule for transforming a value.", "type": "object", "properties": { - "characterMaskConfig": { - "$ref": "GooglePrivacyDlpV2beta2CharacterMaskConfig" - }, - "redactConfig": { - "$ref": "GooglePrivacyDlpV2beta2RedactConfig" - }, - "bucketingConfig": { - "$ref": "GooglePrivacyDlpV2beta2BucketingConfig" - }, "replaceWithInfoTypeConfig": { "$ref": "GooglePrivacyDlpV2beta2ReplaceWithInfoTypeConfig" }, @@ -1681,31 +3392,39 @@ }, "fixedSizeBucketingConfig": { "$ref": "GooglePrivacyDlpV2beta2FixedSizeBucketingConfig" + }, + "characterMaskConfig": { + "$ref": "GooglePrivacyDlpV2beta2CharacterMaskConfig" + }, + "redactConfig": { + "$ref": "GooglePrivacyDlpV2beta2RedactConfig" + }, + "bucketingConfig": { + "$ref": "GooglePrivacyDlpV2beta2BucketingConfig" } - }, - "id": "GooglePrivacyDlpV2beta2PrimitiveTransformation" + } }, "GooglePrivacyDlpV2beta1NumericalStatsResult": { - "description": "Result of the numerical stats computation.", - "type": "object", "properties": { - "minValue": { - "$ref": "GooglePrivacyDlpV2beta1Value", - "description": "Minimum value appearing in the column." - }, - "maxValue": { - "description": "Maximum value appearing in the column.", - "$ref": "GooglePrivacyDlpV2beta1Value" - }, "quantileValues": { "description": "List of 99 values that partition the set of field values into 100 equal\nsized buckets.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1Value" } + }, + "minValue": { + "description": "Minimum value appearing in the column.", + "$ref": "GooglePrivacyDlpV2beta1Value" + }, + "maxValue": { + "$ref": "GooglePrivacyDlpV2beta1Value", + "description": "Maximum value appearing in the column." } }, - "id": "GooglePrivacyDlpV2beta1NumericalStatsResult" + "id": "GooglePrivacyDlpV2beta1NumericalStatsResult", + "description": "Result of the numerical stats computation.", + "type": "object" }, "GooglePrivacyDlpV2beta1Dictionary": { "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.", @@ -1719,6 +3438,8 @@ "id": "GooglePrivacyDlpV2beta1Dictionary" }, "GooglePrivacyDlpV2beta2ListDlpJobsResponse": { + "description": "The response message for listing DLP jobs.", + "type": "object", "properties": { "jobs": { "description": "A list of DlpJobs that matches the specified filter in the request.", @@ -1732,12 +3453,9 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse", - "description": "The response message for listing DLP jobs.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2ListDlpJobsResponse" }, "GooglePrivacyDlpV2beta2InfoType": { - "description": "Type of information detected by the API.", "type": "object", "properties": { "name": { @@ -1745,17 +3463,18 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta2InfoType" + "id": "GooglePrivacyDlpV2beta2InfoType", + "description": "Type of information detected by the API." }, "GooglePrivacyDlpV2beta1DatastoreOptions": { "properties": { "partitionId": { - "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.", - "$ref": "GooglePrivacyDlpV2beta1PartitionId" + "$ref": "GooglePrivacyDlpV2beta1PartitionId", + "description": "A partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty." }, "kind": { - "description": "The kind to process.", - "$ref": "GooglePrivacyDlpV2beta1KindExpression" + "$ref": "GooglePrivacyDlpV2beta1KindExpression", + "description": "The kind to process." }, "projection": { "description": "Properties to scan. If none are specified, all properties will be scanned\nby default.", @@ -1797,25 +3516,27 @@ "id": "GooglePrivacyDlpV2beta2UnwrappedCryptoKey" }, "GooglePrivacyDlpV2beta2StorageConfig": { + "description": "Shared message indicating Cloud storage type.", + "type": "object", "properties": { - "cloudStorageOptions": { - "description": "Google Cloud Storage options specification.", - "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions" - }, "datastoreOptions": { - "description": "Google Cloud Datastore options specification.", - "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions" + "$ref": "GooglePrivacyDlpV2beta2DatastoreOptions", + "description": "Google Cloud Datastore options specification." }, "bigQueryOptions": { "$ref": "GooglePrivacyDlpV2beta2BigQueryOptions", "description": "BigQuery options specification." + }, + "cloudStorageOptions": { + "$ref": "GooglePrivacyDlpV2beta2CloudStorageOptions", + "description": "Google Cloud Storage options specification." } }, - "id": "GooglePrivacyDlpV2beta2StorageConfig", - "description": "Shared message indicating Cloud storage type.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2StorageConfig" }, "GooglePrivacyDlpV2beta2InfoTypeTransformations": { + "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.", + "type": "object", "properties": { "transformations": { "description": "Transformation for each infoType. Cannot specify more than one\nfor a given infoType. [required]", @@ -1825,9 +3546,7 @@ } } }, - "id": "GooglePrivacyDlpV2beta2InfoTypeTransformations", - "description": "A type of transformation that will scan unstructured text and\napply various `PrimitiveTransformation`s to each finding, where the\ntransformation is applied to only values that were identified as a specific\ninfo_type.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2InfoTypeTransformations" }, "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket": { "type": "object", @@ -1838,9 +3557,9 @@ "type": "string" }, "equivalenceClassSizeUpperBound": { + "type": "string", "description": "Upper bound on the size of the equivalence classes in this bucket.", - "format": "int64", - "type": "string" + "format": "int64" }, "bucketSize": { "description": "Total number of equivalence classes in this bucket.", @@ -1860,14 +3579,6 @@ "GooglePrivacyDlpV2beta1InspectConfig": { "properties": { "minLikelihood": { - "enumDescriptions": [ - "Default value; information with all likelihoods is included.", - "Few matching elements.", - "", - "Some matching elements.", - "", - "Many matching elements." - ], "enum": [ "LIKELIHOOD_UNSPECIFIED", "VERY_UNLIKELY", @@ -1877,7 +3588,15 @@ "VERY_LIKELY" ], "description": "Only returns findings equal or above this threshold.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Default value; information with all likelihoods is included.", + "Few matching elements.", + "", + "Some matching elements.", + "", + "Many matching elements." + ] }, "infoTypeLimits": { "description": "Configuration of findings limit given for specified info types.", @@ -1910,8 +3629,8 @@ } }, "excludeTypes": { - "description": "When true, excludes type information of the findings.", - "type": "boolean" + "type": "boolean", + "description": "When true, excludes type information of the findings." } }, "id": "GooglePrivacyDlpV2beta1InspectConfig", @@ -1922,16 +3641,6 @@ "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.", "type": "object", "properties": { - "timeValue": { - "$ref": "GoogleTypeTimeOfDay" - }, - "integerValue": { - "format": "int64", - "type": "string" - }, - "stringValue": { - "type": "string" - }, "dateValue": { "$ref": "GoogleTypeDate" }, @@ -1945,6 +3654,16 @@ "floatValue": { "format": "double", "type": "number" + }, + "timeValue": { + "$ref": "GoogleTypeTimeOfDay" + }, + "integerValue": { + "format": "int64", + "type": "string" + }, + "stringValue": { + "type": "string" } }, "id": "GooglePrivacyDlpV2beta2Value" @@ -1961,36 +3680,36 @@ "id": "GooglePrivacyDlpV2beta1Projection" }, "GooglePrivacyDlpV2beta2ImageRedactionConfig": { - "description": "Configuration for determining how redaction of images should occur.", "type": "object", "properties": { - "redactionColor": { - "description": "The color to use when redacting content from an image. If not specified,\nthe default is black.", - "$ref": "GooglePrivacyDlpV2beta2Color" - }, "redactAllText": { - "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted.", - "type": "boolean" + "type": "boolean", + "description": "If true, all text found in the image, regardless whether it matches an\ninfo_type, is redacted." }, "infoType": { - "$ref": "GooglePrivacyDlpV2beta2InfoType", - "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig." + "description": "Only one per info_type should be provided per request. If not\nspecified, and redact_all_text is false, the DLP API will redact all\ntext that it matches against all info_types that are found, but not\nspecified in another ImageRedactionConfig.", + "$ref": "GooglePrivacyDlpV2beta2InfoType" + }, + "redactionColor": { + "$ref": "GooglePrivacyDlpV2beta2Color", + "description": "The color to use when redacting content from an image. If not specified,\nthe default is black." } }, - "id": "GooglePrivacyDlpV2beta2ImageRedactionConfig" + "id": "GooglePrivacyDlpV2beta2ImageRedactionConfig", + "description": "Configuration for determining how redaction of images should occur." }, "GooglePrivacyDlpV2beta2RequestedOptions": { + "type": "object", "properties": { "snapshotInspectTemplate": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate", - "description": "If run with an inspect template, a snapshot of it's state at the time of\nthis run." + "description": "If run with an inspect template, a snapshot of it's state at the time of\nthis run.", + "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" }, "jobConfig": { "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig" } }, - "id": "GooglePrivacyDlpV2beta2RequestedOptions", - "type": "object" + "id": "GooglePrivacyDlpV2beta2RequestedOptions" }, "GoogleTypeDate": { "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`.", @@ -2040,26 +3759,25 @@ "type": "object" }, "GooglePrivacyDlpV2beta1CustomInfoType": { + "type": "object", "properties": { + "surrogateType": { + "description": "Surrogate info type.", + "$ref": "GooglePrivacyDlpV2beta1SurrogateType" + }, "infoType": { - "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.", - "$ref": "GooglePrivacyDlpV2beta1InfoType" + "$ref": "GooglePrivacyDlpV2beta1InfoType", + "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types." }, "dictionary": { "$ref": "GooglePrivacyDlpV2beta1Dictionary", "description": "Dictionary-based custom info type." - }, - "surrogateType": { - "description": "Surrogate info type.", - "$ref": "GooglePrivacyDlpV2beta1SurrogateType" } }, "id": "GooglePrivacyDlpV2beta1CustomInfoType", - "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.", - "type": "object" + "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question." }, "GooglePrivacyDlpV2beta1EntityId": { - "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity.", "type": "object", "properties": { "field": { @@ -2067,14 +3785,13 @@ "description": "Composite key indicating which field contains the entity identifier." } }, - "id": "GooglePrivacyDlpV2beta1EntityId" + "id": "GooglePrivacyDlpV2beta1EntityId", + "description": "An entity in a dataset is a field or set of fields that correspond to a\nsingle person. For example, in medical records the `EntityId` might be\na patient identifier, or for financial records it might be an account\nidentifier. This message is used when generalizations or analysis must be\nconsistent across multiple rows pertaining to the same entity." }, "GooglePrivacyDlpV2beta1AuxiliaryTable": { + "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).", + "type": "object", "properties": { - "relativeFrequency": { - "$ref": "GooglePrivacyDlpV2beta1FieldId", - "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]" - }, "table": { "description": "Auxiliary table location. [required]", "$ref": "GooglePrivacyDlpV2beta1BigQueryTable" @@ -2085,27 +3802,18 @@ "items": { "$ref": "GooglePrivacyDlpV2beta1QuasiIdField" } + }, + "relativeFrequency": { + "$ref": "GooglePrivacyDlpV2beta1FieldId", + "description": "The relative frequency column must contain a floating-point number\nbetween 0 and 1 (inclusive). Null values are assumed to be zero.\n[required]" } }, - "id": "GooglePrivacyDlpV2beta1AuxiliaryTable", - "description": "An auxiliary table contains statistical information on the relative\nfrequency of different quasi-identifiers values. It has one or several\nquasi-identifiers columns, and one column that indicates the relative\nfrequency of each quasi-identifier tuple.\nIf a tuple is present in the data but not in the auxiliary table, the\ncorresponding relative frequency is assumed to be zero (and thus, the\ntuple is highly reidentifiable).", - "type": "object" + "id": "GooglePrivacyDlpV2beta1AuxiliaryTable" }, "GoogleRpcStatus": { "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.", "type": "object", "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, "code": { "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32", @@ -2114,11 +3822,24 @@ "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 is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } } }, "id": "GoogleRpcStatus" }, "GooglePrivacyDlpV2beta1KMapEstimationResult": { + "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", + "type": "object", "properties": { "kMapEstimationHistogram": { "description": "The intervals [min_anonymity, max_anonymity] do not overlap. If a value\ndoesn't correspond to any such interval, the associated frequency is\nzero. For example, the following records:\n {min_anonymity: 1, max_anonymity: 1, frequency: 17}\n {min_anonymity: 2, max_anonymity: 3, frequency: 42}\n {min_anonymity: 5, max_anonymity: 10, frequency: 99}\nmean that there are no record with an estimated anonymity of 4, 5, or\nlarger than 10.", @@ -2128,27 +3849,37 @@ } } }, - "id": "GooglePrivacyDlpV2beta1KMapEstimationResult", - "description": "Result of the reidentifiability analysis. Note that these results are an\nestimation, not exact values.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1KMapEstimationResult" }, "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest": { "description": "Request message for CreateDeidentifyTemplate.", "type": "object", "properties": { - "deidentifyTemplate": { - "description": "The DeidentifyTemplate to create.", - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, "templateId": { "description": "The template id can contain uppercase and lowercase letters,\nnumbers, and hyphens; that is, it must match the regular\nexpression: `[a-zA-Z\\\\d-]+`. The maximum length is 100\ncharacters. Can be empty to allow the system to generate one.", "type": "string" + }, + "deidentifyTemplate": { + "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate", + "description": "The DeidentifyTemplate to create." } }, "id": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest" }, "GooglePrivacyDlpV2beta2RedactImageRequest": { + "id": "GooglePrivacyDlpV2beta2RedactImageRequest", + "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.", + "type": "object", "properties": { + "inspectConfig": { + "description": "Configuration for the inspector.", + "$ref": "GooglePrivacyDlpV2beta2InspectConfig" + }, + "imageData": { + "type": "string", + "description": "The bytes of the image to redact.", + "format": "byte" + }, "imageType": { "description": "Type of the content, as defined in Content-Type HTTP header.\nSupported types are: PNG, JPEG, SVG, & BMP.", "type": "string" @@ -2159,23 +3890,10 @@ "items": { "$ref": "GooglePrivacyDlpV2beta2ImageRedactionConfig" } - }, - "inspectConfig": { - "$ref": "GooglePrivacyDlpV2beta2InspectConfig", - "description": "Configuration for the inspector." - }, - "imageData": { - "description": "The bytes of the image to redact.", - "format": "byte", - "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta2RedactImageRequest", - "description": "Request to search for potentially sensitive info in a list of items\nand replace it with a default or provided content.", - "type": "object" + } }, "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues": { - "description": "A tuple of values for the quasi-identifier columns.", "type": "object", "properties": { "quasiIdsValues": { @@ -2191,9 +3909,12 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues" + "id": "GooglePrivacyDlpV2beta1KMapEstimationQuasiIdValues", + "description": "A tuple of values for the quasi-identifier columns." }, "GooglePrivacyDlpV2beta2WordList": { + "description": "Message defining a list of words or phrases to search for in the data.", + "type": "object", "properties": { "words": { "description": "Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]", @@ -2203,14 +3924,15 @@ } } }, - "id": "GooglePrivacyDlpV2beta2WordList", - "description": "Message defining a list of words or phrases to search for in the data.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2WordList" }, "GooglePrivacyDlpV2beta2ContentItem": { - "description": "Container structure for the content to inspect.", "type": "object", "properties": { + "table": { + "$ref": "GooglePrivacyDlpV2beta2Table", + "description": "Structured content for inspection." + }, "data": { "description": "Content data to inspect or redact.", "format": "byte", @@ -2223,13 +3945,10 @@ "value": { "description": "String data to inspect or redact.", "type": "string" - }, - "table": { - "$ref": "GooglePrivacyDlpV2beta2Table", - "description": "Structured content for inspection." } }, - "id": "GooglePrivacyDlpV2beta2ContentItem" + "id": "GooglePrivacyDlpV2beta2ContentItem", + "description": "Container structure for the content to inspect." }, "GooglePrivacyDlpV2beta2CategoricalStatsResult": { "description": "Result of the categorical stats computation.", @@ -2255,21 +3974,23 @@ "description": "A unique identifier for a Datastore entity.\nIf a key's partition ID or any of its path kinds or names are\nreserved/read-only, the key is reserved/read-only.\nA reserved/read-only key is forbidden in certain documented contexts.", "type": "object", "properties": { + "partitionId": { + "$ref": "GooglePrivacyDlpV2beta2PartitionId", + "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition." + }, "path": { "description": "The entity path.\nAn entity path consists of one or more elements composed of a kind and a\nstring or numerical identifier, which identify entities. The first\nelement identifies a _root entity_, the second element identifies\na _child_ of the root entity, the third element identifies a child of the\nsecond entity, and so forth. The entities identified by all prefixes of\nthe path are called the element's _ancestors_.\n\nA path can never be empty, and a path can have at most 100 elements.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2PathElement" } - }, - "partitionId": { - "description": "Entities are partitioned into subsets, currently identified by a project\nID and namespace ID.\nQueries are scoped to a single partition.", - "$ref": "GooglePrivacyDlpV2beta2PartitionId" } }, "id": "GooglePrivacyDlpV2beta2Key" }, "GooglePrivacyDlpV2beta1BigQueryTable": { + "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.", + "type": "object", "properties": { "datasetId": { "description": "Dataset ID of the table.", @@ -2284,14 +4005,19 @@ "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1BigQueryTable", - "description": "Message defining the location of a BigQuery table. A table is uniquely\nidentified by its project_id, dataset_id, and table_name. Within a query\na table is often referenced with a string in the format of:\n`\u003cproject_id\u003e:\u003cdataset_id\u003e.\u003ctable_id\u003e` or\n`\u003cproject_id\u003e.\u003cdataset_id\u003e.\u003ctable_id\u003e`.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1BigQueryTable" }, "GooglePrivacyDlpV2beta2FieldTransformation": { - "description": "The transformation to apply to the field.", "type": "object", "properties": { + "condition": { + "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85.", + "$ref": "GooglePrivacyDlpV2beta2RecordCondition" + }, + "infoTypeTransformations": { + "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations", + "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`." + }, "fields": { "description": "Input field(s) to apply the transformation to. [required]", "type": "array", @@ -2302,37 +4028,30 @@ "primitiveTransformation": { "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation", "description": "Apply the transformation to the entire field." - }, - "condition": { - "$ref": "GooglePrivacyDlpV2beta2RecordCondition", - "description": "Only apply the transformation if the condition evaluates to true for the\ngiven `RecordCondition`. The conditions are allowed to reference fields\nthat are not used in the actual transformation. [optional]\n\nExample Use Cases:\n\n- Apply a different bucket transformation to an age column if the zip code\ncolumn for the same record is within a specific range.\n- Redact a field if the date of birth field is greater than 85." - }, - "infoTypeTransformations": { - "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations", - "description": "Treat the contents of the field as free text, and selectively\ntransform content that matches an `InfoType`." } }, - "id": "GooglePrivacyDlpV2beta2FieldTransformation" + "id": "GooglePrivacyDlpV2beta2FieldTransformation", + "description": "The transformation to apply to the field." }, "GooglePrivacyDlpV2beta2PathElement": { + "id": "GooglePrivacyDlpV2beta2PathElement", + "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", + "type": "object", "properties": { - "id": { - "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", - "format": "int64", + "kind": { + "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", "type": "string" }, + "id": { + "type": "string", + "description": "The auto-allocated ID of the entity.\nNever equal to zero. Values less than zero are discouraged and may not\nbe supported in the future.", + "format": "int64" + }, "name": { "description": "The name of the entity.\nA name matching regex `__.*__` is reserved/read-only.\nA name must not be more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", "type": "string" - }, - "kind": { - "description": "The kind of the entity.\nA kind matching regex `__.*__` is reserved/read-only.\nA kind must not contain more than 1500 bytes when UTF-8 encoded.\nCannot be `\"\"`.", - "type": "string" } - }, - "id": "GooglePrivacyDlpV2beta2PathElement", - "description": "A (kind, ID/name) pair used to construct a key path.\n\nIf either name or ID is set, the element is complete.\nIf neither is set, the element is incomplete.", - "type": "object" + } }, "GooglePrivacyDlpV2beta1KindExpression": { "description": "A representation of a Datastore kind.", @@ -2346,80 +4065,80 @@ "id": "GooglePrivacyDlpV2beta1KindExpression" }, "GooglePrivacyDlpV2beta2RecordSuppression": { - "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue.", "type": "object", "properties": { "condition": { - "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content.", - "$ref": "GooglePrivacyDlpV2beta2RecordCondition" + "$ref": "GooglePrivacyDlpV2beta2RecordCondition", + "description": "A condition that when it evaluates to true will result in the record being\nevaluated to be suppressed from the transformed content." } }, - "id": "GooglePrivacyDlpV2beta2RecordSuppression" + "id": "GooglePrivacyDlpV2beta2RecordSuppression", + "description": "Configuration to suppress records whose suppression conditions evaluate to\ntrue." }, "GooglePrivacyDlpV2beta2NumericalStatsConfig": { "description": "Compute numerical stats over an individual column, including\nmin, max, and quantiles.", "type": "object", "properties": { "field": { - "$ref": "GooglePrivacyDlpV2beta2FieldId", - "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time." + "description": "Field to compute numerical stats on. Supported types are\ninteger, float, date, datetime, timestamp, time.", + "$ref": "GooglePrivacyDlpV2beta2FieldId" } }, "id": "GooglePrivacyDlpV2beta2NumericalStatsConfig" }, "GooglePrivacyDlpV2beta2OutputStorageConfig": { + "description": "Cloud repository for storing output.", + "type": "object", "properties": { "table": { - "description": "Store findings in a new table in an existing dataset.", - "$ref": "GooglePrivacyDlpV2beta2BigQueryTable" + "$ref": "GooglePrivacyDlpV2beta2BigQueryTable", + "description": "Store findings in a new table in an existing dataset." } }, - "id": "GooglePrivacyDlpV2beta2OutputStorageConfig", - "description": "Cloud repository for storing output.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2OutputStorageConfig" }, "GooglePrivacyDlpV2beta1FileSet": { + "description": "Set of files to scan.", + "type": "object", "properties": { "url": { "description": "The url, in the format `gs://\u003cbucket\u003e/\u003cpath\u003e`. Trailing wildcard in the\npath is allowed.", "type": "string" } }, - "id": "GooglePrivacyDlpV2beta1FileSet", - "description": "Set of files to scan.", - "type": "object" + "id": "GooglePrivacyDlpV2beta1FileSet" }, "GooglePrivacyDlpV2beta2InfoTypeLimit": { "description": "Max findings configuration per infoType, per content item or long\nrunning DlpJob.", "type": "object", "properties": { + "infoType": { + "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit.", + "$ref": "GooglePrivacyDlpV2beta2InfoType" + }, "maxFindings": { "description": "Max findings limit for the given infoType.", "format": "int32", "type": "integer" - }, - "infoType": { - "$ref": "GooglePrivacyDlpV2beta2InfoType", - "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that\nare found but not specified in another InfoTypeLimit." } }, "id": "GooglePrivacyDlpV2beta2InfoTypeLimit" }, "GooglePrivacyDlpV2beta2InfoTypeStatistics": { + "description": "Statistics regarding a specific InfoType.", + "type": "object", "properties": { + "infoType": { + "$ref": "GooglePrivacyDlpV2beta2InfoType", + "description": "The type of finding this stat is for." + }, "count": { "description": "Number of findings for this infoType.", "format": "int64", "type": "string" - }, - "infoType": { - "$ref": "GooglePrivacyDlpV2beta2InfoType", - "description": "The type of finding this stat is for." } }, - "id": "GooglePrivacyDlpV2beta2InfoTypeStatistics", - "description": "Statistics regarding a specific InfoType.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2InfoTypeStatistics" }, "GooglePrivacyDlpV2beta2LDiversityConfig": { "description": "l-diversity metric, used for analysis of reidentification risk.", @@ -2454,47 +4173,46 @@ "id": "GooglePrivacyDlpV2beta1KAnonymityResult" }, "GooglePrivacyDlpV2beta2Table": { + "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.", + "type": "object", "properties": { - "headers": { - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2FieldId" - } - }, "rows": { "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2Row" } - } - }, - "id": "GooglePrivacyDlpV2beta2Table", - "description": "Structured content to inspect. Up to 50,000 `Value`s per request allowed.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2RecordTransformations": { - "properties": { - "recordSuppressions": { - "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional].", + }, + "headers": { "type": "array", "items": { - "$ref": "GooglePrivacyDlpV2beta2RecordSuppression" + "$ref": "GooglePrivacyDlpV2beta2FieldId" } - }, + } + }, + "id": "GooglePrivacyDlpV2beta2Table" + }, + "GooglePrivacyDlpV2beta2RecordTransformations": { + "type": "object", + "properties": { "fieldTransformations": { "description": "Transform the record by applying various field transformations.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta2FieldTransformation" } + }, + "recordSuppressions": { + "description": "Configuration defining which records get suppressed entirely. Records that\nmatch any suppression rule are omitted from the output [optional].", + "type": "array", + "items": { + "$ref": "GooglePrivacyDlpV2beta2RecordSuppression" + } } }, "id": "GooglePrivacyDlpV2beta2RecordTransformations", - "description": "A type of transformation that is applied over structured data such as a\ntable.", - "type": "object" + "description": "A type of transformation that is applied over structured data such as a\ntable." }, "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket": { - "description": "Histogram bucket of value frequencies in the column.", "type": "object", "properties": { "bucketSize": { @@ -2508,9 +4226,9 @@ "type": "string" }, "valueFrequencyLowerBound": { + "type": "string", "description": "Lower bound on the value frequency of the values in this bucket.", - "format": "int64", - "type": "string" + "format": "int64" }, "bucketValues": { "description": "Sample of value frequencies in this bucket. The total number of\nvalues returned per bucket is capped at 20.", @@ -2520,7 +4238,8 @@ } } }, - "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket" + "id": "GooglePrivacyDlpV2beta1CategoricalStatsHistogramBucket", + "description": "Histogram bucket of value frequencies in the column." }, "GooglePrivacyDlpV2beta2SummaryResult": { "description": "A collection that informs the user the number of times a particular\n`TransformationResultCode` and error details occurred.", @@ -2554,16 +4273,16 @@ "description": "k-anonymity metric, used for analysis of reidentification risk.", "type": "object", "properties": { - "entityId": { - "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\".", - "$ref": "GooglePrivacyDlpV2beta1EntityId" - }, "quasiIds": { "description": "Set of fields to compute k-anonymity over. When multiple fields are\nspecified, they are considered a single composite key. Structs and\nrepeated data types are not supported; however, nested fields are\nsupported so long as they are not structs themselves or nested within\na repeated field.", "type": "array", "items": { "$ref": "GooglePrivacyDlpV2beta1FieldId" } + }, + "entityId": { + "description": "Optional message indicating that each distinct entity_id should not\ncontribute to the k-anonymity count more than once per equivalence class.\nIf an entity_id appears on several rows with different quasi-identifier\ntuples, it will contribute to each count exactly once.\n\nThis can lead to unexpected results. Consider a table where ID 1 is\nassociated to quasi-identifier \"foo\", ID 2 to \"bar\", and ID 3 to *both*\nquasi-identifiers \"foo\" and \"bar\" (on separate rows), and where this ID\nis used as entity_id. Then, the anonymity value associated to ID 3 will\nbe 2, even if it is the only ID to be associated to both values \"foo\" and\n\"bar\".", + "$ref": "GooglePrivacyDlpV2beta1EntityId" } }, "id": "GooglePrivacyDlpV2beta1KAnonymityConfig" @@ -2586,22 +4305,26 @@ "id": "GooglePrivacyDlpV2beta2Range" }, "GooglePrivacyDlpV2beta2DeidentifyConfig": { + "description": "The configuration that controls how the data will change.", + "type": "object", "properties": { - "recordTransformations": { - "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table.", - "$ref": "GooglePrivacyDlpV2beta2RecordTransformations" - }, "infoTypeTransformations": { - "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere.", - "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations" + "$ref": "GooglePrivacyDlpV2beta2InfoTypeTransformations", + "description": "Treat the dataset as free-form text and apply the same free text\ntransformation everywhere." + }, + "recordTransformations": { + "$ref": "GooglePrivacyDlpV2beta2RecordTransformations", + "description": "Treat the dataset as structured. Transformations can be applied to\nspecific locations within structured datasets, such as transforming\na column within a table." } }, - "id": "GooglePrivacyDlpV2beta2DeidentifyConfig", - "description": "The configuration that controls how the data will change.", - "type": "object" + "id": "GooglePrivacyDlpV2beta2DeidentifyConfig" }, "GooglePrivacyDlpV2beta2KMapEstimationConfig": { "properties": { + "regionCode": { + "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.", + "type": "string" + }, "auxiliaryTables": { "description": "Several auxiliary tables can be used in the analysis. Each custom_tag\nused to tag a quasi-identifiers column must appear in exactly one column\nof one auxiliary table.", "type": "array", @@ -2615,702 +4338,17 @@ "items": { "$ref": "GooglePrivacyDlpV2beta2TaggedField" } - }, - "regionCode": { - "description": "ISO 3166-1 alpha-2 region code to use in the statistical modeling.\nRequired if no column is tagged with a region-specific InfoType (like\nUS_ZIP_5) or a region code.", - "type": "string" } }, "id": "GooglePrivacyDlpV2beta2KMapEstimationConfig", "description": "Reidentifiability metric. This corresponds to a risk model similar to what\nis called \"journalist risk\" in the literature, except the attack dataset is\nstatistically modeled instead of being perfectly known. This can be done\nusing publicly available data (like the US Census), or using a custom\nstatistical model (indicated as one or several BigQuery tables), or by\nextrapolating from the distribution of values in the input dataset.", "type": "object" - }, - "GooglePrivacyDlpV2beta2BucketingConfig": { - "properties": { - "buckets": { - "description": "Set of buckets. Ranges must be non-overlapping.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2Bucket" - } - } - }, - "id": "GooglePrivacyDlpV2beta2BucketingConfig", - "description": "Generalization function that buckets values based on ranges. The ranges and\nreplacement values are dynamically provided by the user for custom behavior,\nsuch as 1-30 -\u003e LOW 31-65 -\u003e MEDIUM 66-100 -\u003e HIGH\nThis can be used on\ndata of type: number, long, string, timestamp.\nIf the bound `Value` type differs from the type of data being transformed, we\nwill first attempt converting the type of the data to be transformed to match\nthe type of the bound before comparing.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket": { - "description": "A KMapEstimationHistogramBucket message with the following values:\n min_anonymity: 3\n max_anonymity: 5\n frequency: 42\nmeans that there are 42 records whose quasi-identifier values correspond\nto 3, 4 or 5 people in the overlying population. An important particular\ncase is when min_anonymity = max_anonymity = 1: the frequency field then\ncorresponds to the number of uniquely identifiable records.", - "type": "object", - "properties": { - "bucketValues": { - "description": "Sample of quasi-identifier tuple values in this bucket. The total\nnumber of classes returned per bucket is capped at 20.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2KMapEstimationQuasiIdValues" - } - }, - "minAnonymity": { - "description": "Always positive.", - "format": "int64", - "type": "string" - }, - "maxAnonymity": { - "description": "Always greater than or equal to min_anonymity.", - "format": "int64", - "type": "string" - }, - "bucketSize": { - "description": "Number of records within these anonymity bounds.", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2KMapEstimationHistogramBucket" - }, - "GooglePrivacyDlpV2beta2PrivacyMetric": { - "description": "Privacy metric to compute for reidentification risk analysis.", - "type": "object", - "properties": { - "numericalStatsConfig": { - "$ref": "GooglePrivacyDlpV2beta2NumericalStatsConfig" - }, - "kAnonymityConfig": { - "$ref": "GooglePrivacyDlpV2beta2KAnonymityConfig" - }, - "categoricalStatsConfig": { - "$ref": "GooglePrivacyDlpV2beta2CategoricalStatsConfig" - }, - "kMapEstimationConfig": { - "$ref": "GooglePrivacyDlpV2beta2KMapEstimationConfig" - }, - "lDiversityConfig": { - "$ref": "GooglePrivacyDlpV2beta2LDiversityConfig" - } - }, - "id": "GooglePrivacyDlpV2beta2PrivacyMetric" - }, - "GooglePrivacyDlpV2beta1QuasiIdField": { - "description": "A quasi-identifier column has a custom_tag, used to know which column\nin the data corresponds to which column in the statistical model.", - "type": "object", - "properties": { - "field": { - "$ref": "GooglePrivacyDlpV2beta1FieldId" - }, - "customTag": { - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1QuasiIdField" - }, - "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey": { - "properties": { - "wrappedKey": { - "description": "The wrapped data crypto key. [required]", - "format": "byte", - "type": "string" - }, - "cryptoKeyName": { - "description": "The resource name of the KMS CryptoKey to use for unwrapping. [required]", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2KmsWrappedCryptoKey", - "description": "Include to use an existing data crypto key wrapped by KMS.\nAuthorization requires the following IAM permissions when sending a request\nto perform a crypto transformation using a kms-wrapped crypto key:\ndlp.kms.encrypt", - "type": "object" - }, - "GooglePrivacyDlpV2beta2KAnonymityResult": { - "properties": { - "equivalenceClassHistogramBuckets": { - "description": "Histogram of k-anonymity equivalence classes.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2KAnonymityHistogramBucket" - } - } - }, - "id": "GooglePrivacyDlpV2beta2KAnonymityResult", - "description": "Result of the k-anonymity computation.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2Result": { - "properties": { - "totalEstimatedBytes": { - "description": "Estimate of the number of bytes to process.", - "format": "int64", - "type": "string" - }, - "infoTypeStats": { - "description": "Statistics of how many instances of each info type were found during\ninspect job.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2InfoTypeStatistics" - } - }, - "processedBytes": { - "description": "Total size in bytes that were processed.", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2Result", - "type": "object" - }, - "GooglePrivacyDlpV2beta2CustomInfoType": { - "properties": { - "surrogateType": { - "$ref": "GooglePrivacyDlpV2beta2SurrogateType", - "description": "Surrogate info type." - }, - "infoType": { - "description": "Info type configuration. All custom info types must have configurations\nthat do not conflict with built-in info types or other custom info types.", - "$ref": "GooglePrivacyDlpV2beta2InfoType" - }, - "dictionary": { - "description": "Dictionary-based custom info type.", - "$ref": "GooglePrivacyDlpV2beta2Dictionary" - } - }, - "id": "GooglePrivacyDlpV2beta2CustomInfoType", - "description": "Custom information type provided by the user. Used to find domain-specific\nsensitive information configurable to the data in question.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2DeidentifyContentResponse": { - "description": "Results of de-identifying a ContentItem.", - "type": "object", - "properties": { - "overview": { - "description": "An overview of the changes that were made on the `item`.", - "$ref": "GooglePrivacyDlpV2beta2TransformationOverview" - }, - "item": { - "description": "The de-identified item.", - "$ref": "GooglePrivacyDlpV2beta2ContentItem" - } - }, - "id": "GooglePrivacyDlpV2beta2DeidentifyContentResponse" - }, - "GooglePrivacyDlpV2beta1ValueFrequency": { - "properties": { - "value": { - "$ref": "GooglePrivacyDlpV2beta1Value", - "description": "A value contained in the field in question." - }, - "count": { - "description": "How many times the value is contained in the field.", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1ValueFrequency", - "description": "A value of a field, including its frequency.", - "type": "object" - }, - "GooglePrivacyDlpV2beta1SurrogateType": { - "description": "Message for detecting output from deidentification transformations\nsuch as\n[`CryptoReplaceFfxFpeConfig`](/dlp/docs/reference/rest/v2beta1/content/deidentify#CryptoReplaceFfxFpeConfig).\nThese types of transformations are\nthose that perform pseudonymization, thereby producing a \"surrogate\" as\noutput. This should be used in conjunction with a field on the\ntransformation such as `surrogate_info_type`. This custom info type does\nnot support the use of `detection_rules`.", - "type": "object", - "properties": {}, - "id": "GooglePrivacyDlpV2beta1SurrogateType" - }, - "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig": { - "description": "Replaces an identifier with a surrogate using FPE with the FFX\nmode of operation; however when used in the `ReidentifyContent` API method,\nit serves the opposite function by reversing the surrogate back into\nthe original identifier.\nThe identifier must be encoded as ASCII.\nFor a given crypto key and context, the same identifier will be\nreplaced with the same surrogate.\nIdentifiers must be at least two characters long.\nIn the case that the identifier is the empty string, it will be skipped.", - "type": "object", - "properties": { - "customAlphabet": { - "description": "This is supported by mapping these to the alphanumeric characters\nthat the FFX mode natively supports. This happens before/after\nencryption/decryption.\nEach character listed must appear only once.\nNumber of characters must be in the range [2, 62].\nThis must be encoded as ASCII.\nThe order of characters does not matter.", - "type": "string" - }, - "cryptoKey": { - "description": "The key used by the encryption algorithm. [required]", - "$ref": "GooglePrivacyDlpV2beta2CryptoKey" - }, - "context": { - "$ref": "GooglePrivacyDlpV2beta2FieldId", - "description": "The 'tweak', a context may be used for higher security since the same\nidentifier in two different contexts won't be given the same surrogate. If\nthe context is not set, a default tweak will be used.\n\nIf the context is set but:\n\n1. there is no record present when transforming a given value or\n1. the field is not present when transforming a given value,\n\na default tweak will be used.\n\nNote that case (1) is expected when an `InfoTypeTransformation` is\napplied to both structured and non-structured `ContentItem`s.\nCurrently, the referenced field may be of value type integer or string.\n\nThe tweak is constructed as a sequence of bytes in big endian byte order\nsuch that:\n\n- a 64 bit integer is encoded followed by a single byte of value 1\n- a string is encoded in UTF-8 format followed by a single byte of value\n å 2" - }, - "surrogateInfoType": { - "$ref": "GooglePrivacyDlpV2beta2InfoType", - "description": "The custom infoType to annotate the surrogate with.\nThis annotation will be applied to the surrogate by prefixing it with\nthe name of the custom infoType followed by the number of\ncharacters comprising the surrogate. The following scheme defines the\nformat: info_type_name(surrogate_character_count):surrogate\n\nFor example, if the name of custom infoType is 'MY_TOKEN_INFO_TYPE' and\nthe surrogate is 'abc', the full replacement value\nwill be: 'MY_TOKEN_INFO_TYPE(3):abc'\n\nThis annotation identifies the surrogate when inspecting content using the\ncustom infoType\n[`SurrogateType`](/dlp/docs/reference/rest/v2beta2/InspectConfig#surrogatetype).\nThis facilitates reversal of the surrogate when it occurs in free text.\n\nIn order for inspection to work properly, the name of this infoType must\nnot occur naturally anywhere in your data; otherwise, inspection may\nfind a surrogate that does not correspond to an actual identifier.\nTherefore, choose your custom infoType name carefully after considering\nwhat your data looks like. One way to select a name that has a high chance\nof yielding reliable detection is to include one or more unicode characters\nthat are highly improbable to exist in your data.\nFor example, assuming your data is entered from a regular ASCII keyboard,\nthe symbol with the hex code point 29DD might be used like so:\n⧝MY_TOKEN_TYPE" - }, - "commonAlphabet": { - "enum": [ - "FFX_COMMON_NATIVE_ALPHABET_UNSPECIFIED", - "NUMERIC", - "HEXADECIMAL", - "UPPER_CASE_ALPHA_NUMERIC", - "ALPHA_NUMERIC" - ], - "type": "string", - "enumDescriptions": [ - "", - "[0-9] (radix of 10)", - "[0-9A-F] (radix of 16)", - "[0-9A-Z] (radix of 36)", - "[0-9A-Za-z] (radix of 62)" - ] - }, - "radix": { - "description": "The native way to select the alphabet. Must be in the range [2, 62].", - "format": "int32", - "type": "integer" - } - }, - "id": "GooglePrivacyDlpV2beta2CryptoReplaceFfxFpeConfig" - }, - "GooglePrivacyDlpV2beta1InfoTypeLimit": { - "description": "Max findings configuration per info type, per content item or long running\noperation.", - "type": "object", - "properties": { - "maxFindings": { - "description": "Max findings limit for the given infoType.", - "format": "int32", - "type": "integer" - }, - "infoType": { - "$ref": "GooglePrivacyDlpV2beta1InfoType", - "description": "Type of information the findings limit applies to. Only one limit per\ninfo_type should be provided. If InfoTypeLimit does not have an\ninfo_type, the DLP API applies the limit against all info_types that are\nfound but not specified in another InfoTypeLimit." - } - }, - "id": "GooglePrivacyDlpV2beta1InfoTypeLimit" - }, - "GooglePrivacyDlpV2beta2FindingLimits": { - "type": "object", - "properties": { - "maxFindingsPerInfoType": { - "description": "Configuration of findings limit given for specified infoTypes.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2InfoTypeLimit" - } - }, - "maxFindingsPerItem": { - "description": "Max number of findings that will be returned for each item scanned.", - "format": "int32", - "type": "integer" - }, - "maxFindingsPerRequest": { - "description": "Max total number of findings that will be returned per request/job.", - "format": "int32", - "type": "integer" - } - }, - "id": "GooglePrivacyDlpV2beta2FindingLimits" - }, - "GooglePrivacyDlpV2beta2DlpJob": { - "properties": { - "endTime": { - "description": "Time when the job finished.", - "format": "google-datetime", - "type": "string" - }, - "startTime": { - "description": "Time when the job started.", - "format": "google-datetime", - "type": "string" - }, - "inspectDetails": { - "description": "Results from inspecting a data source.", - "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceDetails" - }, - "errorResults": { - "description": "A stream of errors encountered running the job.", - "type": "array", - "items": { - "$ref": "GoogleRpcStatus" - } - }, - "createTime": { - "description": "Time when the job was created.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "enum": [ - "JOB_STATE_UNSPECIFIED", - "PENDING", - "RUNNING", - "DONE", - "CANCELED", - "FAILED" - ], - "description": "State of a job.", - "type": "string", - "enumDescriptions": [ - "", - "The job has not yet started.", - "The job is currently running.", - "The job is no longer running.", - "The job was canceled before it could complete.", - "The job had an error and did not complete." - ] - }, - "riskDetails": { - "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskDetails", - "description": "Results from analyzing risk of a data source." - }, - "name": { - "description": "The server-assigned name.", - "type": "string" - }, - "type": { - "enumDescriptions": [ - "", - "The job inspected Google Cloud for sensitive data.", - "The job executed a Risk Analysis computation." - ], - "enum": [ - "DLP_JOB_TYPE_UNSPECIFIED", - "INSPECT_JOB", - "RISK_ANALYSIS_JOB" - ], - "description": "The type of job.", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2DlpJob", - "description": "Combines all of the information about a DLP job.", - "type": "object" - }, - "GooglePrivacyDlpV2beta1LDiversityHistogramBucket": { - "properties": { - "sensitiveValueFrequencyUpperBound": { - "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", - "format": "int64", - "type": "string" - }, - "sensitiveValueFrequencyLowerBound": { - "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", - "format": "int64", - "type": "string" - }, - "bucketValues": { - "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta1LDiversityEquivalenceClass" - } - }, - "bucketSize": { - "description": "Total number of records in this bucket.", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1LDiversityHistogramBucket", - "description": "Histogram bucket of sensitive value frequencies in the table.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2Dictionary": { - "description": "Custom information type based on a dictionary of words or phrases. This can\nbe used to match sensitive information specific to the data, such as a list\nof employee IDs or job titles.\n\nDictionary words are case-insensitive and all characters other than letters\nand digits in the unicode [Basic Multilingual\nPlane](https://en.wikipedia.org/wiki/Plane_%28Unicode%29#Basic_Multilingual_Plane)\nwill be replaced with whitespace when scanning for matches, so the\ndictionary phrase \"Sam Johnson\" will match all three phrases \"sam johnson\",\n\"Sam, Johnson\", and \"Sam (Johnson)\". Additionally, the characters\nsurrounding any match must be of a different type than the adjacent\ncharacters within the word, so letters must be next to non-letters and\ndigits next to non-digits. For example, the dictionary word \"jen\" will\nmatch the first three letters of the text \"jen123\" but will return no\nmatches for \"jennifer\".\n\nDictionary words containing a large number of characters that are not\nletters or digits may result in unexpected findings because such characters\nare treated as whitespace.", - "type": "object", - "properties": { - "wordList": { - "$ref": "GooglePrivacyDlpV2beta2WordList", - "description": "List of words or phrases to search for." - } - }, - "id": "GooglePrivacyDlpV2beta2Dictionary" - }, - "GooglePrivacyDlpV2beta1Value": { - "properties": { - "dateValue": { - "$ref": "GoogleTypeDate" - }, - "timestampValue": { - "format": "google-datetime", - "type": "string" - }, - "booleanValue": { - "type": "boolean" - }, - "floatValue": { - "format": "double", - "type": "number" - }, - "timeValue": { - "$ref": "GoogleTypeTimeOfDay" - }, - "integerValue": { - "format": "int64", - "type": "string" - }, - "stringValue": { - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1Value", - "description": "Set of primitive values supported by the system.\nNote that for the purposes of inspection or transformation, the number\nof bytes considered to comprise a 'Value' is based on its representation\nas a UTF-8 encoded string. For example, if 'integer_value' is set to\n123456789, the number of bytes would be counted as 9, even though an\nint64 only holds up to 8 bytes of data.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2RecordCondition": { - "description": "A condition for determining whether a transformation should be applied to\na field.", - "type": "object", - "properties": { - "expressions": { - "description": "An expression.", - "$ref": "GooglePrivacyDlpV2beta2Expressions" - } - }, - "id": "GooglePrivacyDlpV2beta2RecordCondition" - }, - "GooglePrivacyDlpV2beta2LDiversityHistogramBucket": { - "properties": { - "sensitiveValueFrequencyUpperBound": { - "description": "Upper bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", - "format": "int64", - "type": "string" - }, - "sensitiveValueFrequencyLowerBound": { - "description": "Lower bound on the sensitive value frequencies of the equivalence\nclasses in this bucket.", - "format": "int64", - "type": "string" - }, - "bucketValues": { - "description": "Sample of equivalence classes in this bucket. The total number of\nclasses returned per bucket is capped at 20.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2LDiversityEquivalenceClass" - } - }, - "bucketSize": { - "description": "Total number of equivalence classes in this bucket.", - "format": "int64", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2LDiversityHistogramBucket", - "type": "object" - }, - "GooglePrivacyDlpV2beta2KindExpression": { - "description": "A representation of a Datastore kind.", - "type": "object", - "properties": { - "name": { - "description": "The name of the kind.", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2KindExpression" - }, - "GooglePrivacyDlpV2beta1PartitionId": { - "description": "Datastore partition ID.\nA partition ID identifies a grouping of entities. The grouping is always\nby project and namespace, however the namespace ID may be empty.\n\nA partition ID contains several dimensions:\nproject ID and namespace ID.", - "type": "object", - "properties": { - "namespaceId": { - "description": "If not empty, the ID of the namespace to which the entities belong.", - "type": "string" - }, - "projectId": { - "description": "The ID of the project to which the entities belong.", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1PartitionId" - }, - "GooglePrivacyDlpV2beta2InspectResult": { - "description": "All the findings for a single scanned item.", - "type": "object", - "properties": { - "findingsTruncated": { - "description": "If true, then this item might have more findings than were returned,\nand the findings returned are an arbitrary subset of all findings.\nThe findings list might be truncated because the input items were too\nlarge, or because the server reached the maximum amount of resources\nallowed for a single API call. For best results, divide the input into\nsmaller batches.", - "type": "boolean" - }, - "findings": { - "description": "List of findings for an item.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2Finding" - } - } - }, - "id": "GooglePrivacyDlpV2beta2InspectResult" - }, - "GooglePrivacyDlpV2beta2CryptoHashConfig": { - "properties": { - "cryptoKey": { - "$ref": "GooglePrivacyDlpV2beta2CryptoKey", - "description": "The key used by the hash function." - } - }, - "id": "GooglePrivacyDlpV2beta2CryptoHashConfig", - "description": "Pseudonymization method that generates surrogates via cryptographic hashing.\nUses SHA-256.\nThe key size must be either 32 or 64 bytes.\nOutputs a 32 byte digest as an uppercase hex string\n(for example, 41D1567F7F99F1DC2A5FAB886DEE5BEE).\nCurrently, only string and integer values can be hashed.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2TimePartConfig": { - "description": "For use with `Date`, `Timestamp`, and `TimeOfDay`, extract or preserve a\nportion of the value.", - "type": "object", - "properties": { - "partToExtract": { - "enumDescriptions": [ - "", - "[0-9999]", - "[1-12]", - "[1-31]", - "[1-7]", - "[1-52]", - "[0-23]" - ], - "enum": [ - "TIME_PART_UNSPECIFIED", - "YEAR", - "MONTH", - "DAY_OF_MONTH", - "DAY_OF_WEEK", - "WEEK_OF_YEAR", - "HOUR_OF_DAY" - ], - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta2TimePartConfig" - }, - "GooglePrivacyDlpV2beta1WordList": { - "properties": { - "words": { - "description": "Words or phrases defining the dictionary. The dictionary must contain\nat least one phrase and every phrase must contain at least 2 characters\nthat are letters or digits. [required]", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "GooglePrivacyDlpV2beta1WordList", - "description": "Message defining a list of words or phrases to search for in the data.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2ImageLocation": { - "properties": { - "height": { - "description": "Height of the bounding box in pixels.", - "format": "int32", - "type": "integer" - }, - "top": { - "description": "Top coordinate of the bounding box. (0,0) is upper left.", - "format": "int32", - "type": "integer" - }, - "left": { - "description": "Left coordinate of the bounding box. (0,0) is upper left.", - "format": "int32", - "type": "integer" - }, - "width": { - "description": "Width of the bounding box in pixels.", - "format": "int32", - "type": "integer" - } - }, - "id": "GooglePrivacyDlpV2beta2ImageLocation", - "description": "Bounding box encompassing detected text within an image.", - "type": "object" - }, - "GooglePrivacyDlpV2beta1FieldId": { - "properties": { - "columnName": { - "description": "Name describing the field.", - "type": "string" - } - }, - "id": "GooglePrivacyDlpV2beta1FieldId", - "description": "General identifier of a data field in a storage service.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest": { - "description": "Request message for UpdateInspectTemplate.", - "type": "object", - "properties": { - "updateMask": { - "description": "Mask to control which fields get updated.", - "format": "google-fieldmask", - "type": "string" - }, - "inspectTemplate": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate", - "description": "New InspectTemplate value." - } - }, - "id": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest" - }, - "GooglePrivacyDlpV2beta2InspectDataSourceRequest": { - "properties": { - "jobConfig": { - "description": "A configuration for the job.", - "$ref": "GooglePrivacyDlpV2beta2InspectJobConfig" - } - }, - "id": "GooglePrivacyDlpV2beta2InspectDataSourceRequest", - "description": "Request for scheduling a scan of a data subset from a Google Platform data\nrepository.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2Expressions": { - "properties": { - "logicalOperator": { - "enumDescriptions": [ - "", - "" - ], - "enum": [ - "LOGICAL_OPERATOR_UNSPECIFIED", - "AND" - ], - "description": "The operator to apply to the result of conditions. Default and currently\nonly supported value is `AND`.", - "type": "string" - }, - "conditions": { - "$ref": "GooglePrivacyDlpV2beta2Conditions" - } - }, - "id": "GooglePrivacyDlpV2beta2Expressions", - "description": "An expression, consisting or an operator and conditions.", - "type": "object" - }, - "GooglePrivacyDlpV2beta2TransformationSummary": { - "properties": { - "transformedBytes": { - "description": "Total size in bytes that were transformed in some way.", - "format": "int64", - "type": "string" - }, - "recordSuppress": { - "description": "The specific suppression option these stats apply to.", - "$ref": "GooglePrivacyDlpV2beta2RecordSuppression" - }, - "infoType": { - "$ref": "GooglePrivacyDlpV2beta2InfoType", - "description": "Set if the transformation was limited to a specific info_type." - }, - "transformation": { - "$ref": "GooglePrivacyDlpV2beta2PrimitiveTransformation", - "description": "The specific transformation these stats apply to." - }, - "results": { - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2SummaryResult" - } - }, - "field": { - "$ref": "GooglePrivacyDlpV2beta2FieldId", - "description": "Set if the transformation was limited to a specific FieldId." - }, - "fieldTransformations": { - "description": "The field transformation that was applied.\nIf multiple field transformations are requested for a single field,\nthis list will contain all of them; otherwise, only one is supplied.", - "type": "array", - "items": { - "$ref": "GooglePrivacyDlpV2beta2FieldTransformation" - } - } - }, - "id": "GooglePrivacyDlpV2beta2TransformationSummary", - "description": "Summary of a single tranformation.\nOnly one of 'transformation', 'field_transformation', or 'record_suppress'\nwill be set.", - "type": "object" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "DLP", "auth": { @@ -3321,1043 +4359,5 @@ } } } - }, - "rootUrl": "https://dlp.googleapis.com/", - "ownerDomain": "google.com", - "name": "dlp", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "DLP API", - "ownerName": "Google", - "resources": { - "infoTypes": { - "methods": { - "list": { - "response": { - "$ref": "GooglePrivacyDlpV2beta2ListInfoTypesResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "languageCode": { - "description": "Optional BCP-47 language code for localized infoType friendly\nnames. If omitted, or if localized strings are not available,\nen-US strings will be returned.", - "type": "string", - "location": "query" - }, - "filter": { - "description": "Optional filter to only return infoTypes supported by certain parts of the\nAPI. Defaults to supported_by=INSPECT.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2beta2/infoTypes", - "path": "v2beta2/infoTypes", - "id": "dlp.infoTypes.list", - "description": "Returns sensitive information types DLP supports." - } - } - }, - "organizations": { - "resources": { - "deidentifyTemplates": { - "methods": { - "delete": { - "description": "Deletes inspect templates.", - "httpMethod": "DELETE", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", - "id": "dlp.organizations.deidentifyTemplates.delete", - "path": "v2beta2/{+name}" - }, - "patch": { - "description": "Updates the inspect template.", - "request": { - "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.organizations.deidentifyTemplates.patch" - }, - "get": { - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "pattern": "^organizations/[^/]+/deidentifyTemplates/[^/]+$", - "location": "path", - "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates/{deidentifyTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.organizations.deidentifyTemplates.get", - "description": "Gets an inspect template." - }, - "list": { - "description": "Lists inspect templates.", - "response": { - "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^organizations/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates", - "path": "v2beta2/{+parent}/deidentifyTemplates", - "id": "dlp.organizations.deidentifyTemplates.list" - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, - "parameters": { - "parent": { - "pattern": "^organizations/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/deidentifyTemplates", - "id": "dlp.organizations.deidentifyTemplates.create", - "path": "v2beta2/{+parent}/deidentifyTemplates", - "request": { - "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest" - }, - "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage." - } - } - }, - "inspectTemplates": { - "methods": { - "delete": { - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.organizations.inspectTemplates.delete", - "description": "Deletes inspect templates." - }, - "patch": { - "request": { - "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest" - }, - "description": "Updates the inspect template.", - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "name": { - "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", - "location": "path", - "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.organizations.inspectTemplates.patch" - }, - "get": { - "description": "Gets an inspect template.", - "httpMethod": "GET", - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "pattern": "^organizations/[^/]+/inspectTemplates/[^/]+$", - "location": "path", - "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates/{inspectTemplatesId}", - "id": "dlp.organizations.inspectTemplates.get", - "path": "v2beta2/{+name}" - }, - "list": { - "id": "dlp.organizations.inspectTemplates.list", - "path": "v2beta2/{+parent}/inspectTemplates", - "description": "Lists inspect templates.", - "httpMethod": "GET", - "response": { - "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse" - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", - "type": "string" - }, - "pageSize": { - "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "pattern": "^organizations/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates" - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "pattern": "^organizations/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta2/organizations/{organizationsId}/inspectTemplates", - "id": "dlp.organizations.inspectTemplates.create", - "path": "v2beta2/{+parent}/inspectTemplates", - "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.", - "request": { - "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest" - } - } - } - } - } - }, - "projects": { - "resources": { - "deidentifyTemplates": { - "methods": { - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, - "parameters": { - "parent": { - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates", - "id": "dlp.projects.deidentifyTemplates.create", - "path": "v2beta2/{+parent}/deidentifyTemplates", - "request": { - "$ref": "GooglePrivacyDlpV2beta2CreateDeidentifyTemplateRequest" - }, - "description": "Creates an Deidentify template for re-using frequently used configuration\nfor Deidentifying content, images, and storage." - }, - "delete": { - "description": "Deletes inspect templates.", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Resource name of the organization and deidentify template to be deleted,\nfor example `organizations/433245324/deidentifyTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.projects.deidentifyTemplates.delete" - }, - "patch": { - "description": "Updates the inspect template.", - "request": { - "$ref": "GooglePrivacyDlpV2beta2UpdateDeidentifyTemplateRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Resource name of organization and deidentify template to be updated, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.projects.deidentifyTemplates.patch" - }, - "get": { - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/deidentifyTemplates/[^/]+$", - "location": "path", - "description": "Resource name of the organization and deidentify template to be read, for\nexample `organizations/433245324/deidentifyTemplates/432452342`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates/{deidentifyTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.projects.deidentifyTemplates.get", - "description": "Gets an inspect template." - }, - "list": { - "description": "Lists inspect templates.", - "httpMethod": "GET", - "response": { - "$ref": "GooglePrivacyDlpV2beta2ListDeidentifyTemplatesResponse" - }, - "parameterOrder": [ - "parent" - ], - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListDeidentifyTemplates`.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/deidentifyTemplates", - "id": "dlp.projects.deidentifyTemplates.list", - "path": "v2beta2/{+parent}/deidentifyTemplates" - } - } - }, - "image": { - "methods": { - "redact": { - "response": { - "$ref": "GooglePrivacyDlpV2beta2RedactImageResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "The parent resource name, for example projects/my-project-id.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/image:redact", - "path": "v2beta2/{+parent}/image:redact", - "id": "dlp.projects.image.redact", - "description": "Redacts potentially sensitive info from an image.\nThis method has limits on input size, processing time, and output size.\n[How-to guide](/dlp/docs/redacting-sensitive-data-images)", - "request": { - "$ref": "GooglePrivacyDlpV2beta2RedactImageRequest" - } - } - } - }, - "dlpJobs": { - "methods": { - "cancel": { - "path": "v2beta2/{+name}:cancel", - "id": "dlp.projects.dlpJobs.cancel", - "request": { - "$ref": "GooglePrivacyDlpV2beta2CancelDlpJobRequest" - }, - "description": "Starts asynchronous cancellation on a long-running DlpJob. The server\nmakes a best effort to cancel the DlpJob, but success is not\nguaranteed.", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the DlpJob resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/dlpJobs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}:cancel" - }, - "delete": { - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the DlpJob resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/dlpJobs/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}", - "path": "v2beta2/{+name}", - "id": "dlp.projects.dlpJobs.delete", - "description": "Deletes a long-running DlpJob. This method indicates that the client is\nno longer interested in the DlpJob result. The job will be cancelled if\npossible." - }, - "list": { - "response": { - "$ref": "GooglePrivacyDlpV2beta2ListDlpJobsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - }, - "type": { - "enum": [ - "DLP_JOB_TYPE_UNSPECIFIED", - "INSPECT_JOB", - "RISK_ANALYSIS_JOB" - ], - "description": "The type of job. Defaults to `DlpJobType.INSPECT`", - "type": "string", - "location": "query" - }, - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id.", - "required": true, - "type": "string" - }, - "filter": { - "location": "query", - "description": "Optional. Allows filtering.\n\nSupported syntax:\n\n* Filter expressions are made up of one or more restrictions.\n* Restrictions can be combined by `AND` or `OR` logical operators. A\nsequence of restrictions implicitly uses `AND`.\n* A restriction has the form of `\u003cfield\u003e \u003coperator\u003e \u003cvalue\u003e`.\n* Supported fields/values for inspect jobs:\n - `state` - PENDING|RUNNING|CANCELED|FINISHED|FAILED\n - `inspected_storage` - DATASTORE|CLOUD_STORAGE|BIGQUERY\n* Supported fields for risk analysis jobs:\n - `state` - RUNNING|CANCELED|FINISHED|FAILED\n* The operator must be `=` or `!=`.\n\nExamples:\n\n* inspected_storage = cloud_storage AND state = done\n* inspected_storage = cloud_storage OR inspected_storage = bigquery\n* inspected_storage = cloud_storage AND (state = done OR state = canceled)\n\nThe length of this field should be no more than 500 characters.", - "type": "string" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/dlpJobs", - "path": "v2beta2/{+parent}/dlpJobs", - "id": "dlp.projects.dlpJobs.list", - "description": "Lists DlpJobs that match the specified filter in the request." - }, - "get": { - "description": "Gets the latest state of a long-running DlpJob.", - "httpMethod": "GET", - "response": { - "$ref": "GooglePrivacyDlpV2beta2DlpJob" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the DlpJob resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/dlpJobs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/dlpJobs/{dlpJobsId}", - "id": "dlp.projects.dlpJobs.get", - "path": "v2beta2/{+name}" - } - } - }, - "inspectTemplates": { - "methods": { - "delete": { - "description": "Deletes inspect templates.", - "response": { - "$ref": "GoogleProtobufEmpty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", - "location": "path", - "description": "Resource name of the organization and inspectTemplate to be deleted, for\nexample `organizations/433245324/inspectTemplates/432452342`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.projects.inspectTemplates.delete" - }, - "patch": { - "description": "Updates the inspect template.", - "request": { - "$ref": "GooglePrivacyDlpV2beta2UpdateInspectTemplateRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Resource name of organization and inspectTemplate to be updated, for\nexample `organizations/433245324/inspectTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}", - "path": "v2beta2/{+name}", - "id": "dlp.projects.inspectTemplates.patch" - }, - "get": { - "path": "v2beta2/{+name}", - "id": "dlp.projects.inspectTemplates.get", - "description": "Gets an inspect template.", - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Resource name of the organization and inspectTemplate to be read, for\nexample `organizations/433245324/inspectTemplates/432452342`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/inspectTemplates/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates/{inspectTemplatesId}" - }, - "list": { - "path": "v2beta2/{+parent}/inspectTemplates", - "id": "dlp.projects.inspectTemplates.list", - "description": "Lists inspect templates.", - "response": { - "$ref": "GooglePrivacyDlpV2beta2ListInspectTemplatesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Optional page token to continue retrieval. Comes from previous call\nto `ListInspectTemplates`.", - "type": "string" - }, - "pageSize": { - "description": "Optional size of the page, can be limited by server. If zero server returns\na page of max size 100.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates" - }, - "create": { - "path": "v2beta2/{+parent}/inspectTemplates", - "id": "dlp.projects.inspectTemplates.create", - "description": "Creates an inspect template for re-using frequently used configuration\nfor inspecting content, images, and storage.", - "request": { - "$ref": "GooglePrivacyDlpV2beta2CreateInspectTemplateRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectTemplate" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id or\norganizations/my-org-id.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/inspectTemplates" - } - } - }, - "content": { - "methods": { - "deidentify": { - "description": "De-identifies potentially sensitive info from a ContentItem.\nThis method has limits on input size and output size.\n[How-to guide](/dlp/docs/deidentify-sensitive-data)", - "request": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentRequest" - }, - "response": { - "$ref": "GooglePrivacyDlpV2beta2DeidentifyContentResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/content:deidentify", - "path": "v2beta2/{+parent}/content:deidentify", - "id": "dlp.projects.content.deidentify" - }, - "inspect": { - "response": { - "$ref": "GooglePrivacyDlpV2beta2InspectContentResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "The parent resource name, for example projects/my-project-id.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta2/projects/{projectsId}/content:inspect", - "path": "v2beta2/{+parent}/content:inspect", - "id": "dlp.projects.content.inspect", - "description": "Finds potentially sensitive info in content.\nThis method has limits on input size, processing time, and output size.\n[How-to guide for text](/dlp/docs/inspecting-text), [How-to guide for\nimages](/dlp/docs/inspecting-images)", - "request": { - "$ref": "GooglePrivacyDlpV2beta2InspectContentRequest" - } - }, - "reidentify": { - "path": "v2beta2/{+parent}/content:reidentify", - "id": "dlp.projects.content.reidentify", - "request": { - "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentRequest" - }, - "description": "Re-identify content that has been de-identified.", - "response": { - "$ref": "GooglePrivacyDlpV2beta2ReidentifyContentResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/content:reidentify" - } - } - }, - "dataSource": { - "methods": { - "inspect": { - "path": "v2beta2/{+parent}/dataSource:inspect", - "id": "dlp.projects.dataSource.inspect", - "request": { - "$ref": "GooglePrivacyDlpV2beta2InspectDataSourceRequest" - }, - "description": "Schedules a job scanning content in a Google Cloud Platform data\nrepository. [How-to guide](/dlp/docs/inspecting-storage)", - "response": { - "$ref": "GooglePrivacyDlpV2beta2DlpJob" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/dataSource:inspect" - }, - "analyze": { - "request": { - "$ref": "GooglePrivacyDlpV2beta2AnalyzeDataSourceRiskRequest" - }, - "description": "Schedules a job to compute risk analysis metrics over content in a Google\nCloud Platform repository. [How-to guide}(/dlp/docs/compute-risk-analysis)", - "response": { - "$ref": "GooglePrivacyDlpV2beta2DlpJob" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The parent resource name, for example projects/my-project-id.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v2beta2/projects/{projectsId}/dataSource:analyze", - "path": "v2beta2/{+parent}/dataSource:analyze", - "id": "dlp.projects.dataSource.analyze" - } - } - } - } - } - }, - "parameters": { - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - } - }, - "version": "v2beta2", - "baseUrl": "https://dlp.googleapis.com/", - "kind": "discovery#restDescription", - "description": "The Google Data Loss Prevention API provides methods for detection of privacy-sensitive fragments in text, images, and Google Cloud Platform storage repositories.", - "servicePath": "", - "basePath": "" + } }
diff --git a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json index daa939e..a171f3d 100644 --- a/firebasedynamiclinks/v1/firebasedynamiclinks-api.json +++ b/firebasedynamiclinks/v1/firebasedynamiclinks-api.json
@@ -1,168 +1,25 @@ { + "servicePath": "", + "description": "Programmatically creates and manages Firebase Dynamic Links.", + "kind": "discovery#restDescription", "basePath": "", - "revision": "20180102", - "documentationLink": "https://firebase.google.com/docs/dynamic-links/", "id": "firebasedynamiclinks:v1", + "documentationLink": "https://firebase.google.com/docs/dynamic-links/", + "revision": "20180108", "discoveryVersion": "v1", "version_module": true, "schemas": { - "AnalyticsInfo": { - "properties": { - "itunesConnectAnalytics": { - "$ref": "ITunesConnectAnalytics", - "description": "iTunes Connect App Analytics." - }, - "googlePlayAnalytics": { - "description": "Google Play Campaign Measurements.", - "$ref": "GooglePlayAnalytics" - } - }, - "id": "AnalyticsInfo", - "description": "Tracking parameters supported by Dynamic Link.", - "type": "object" - }, - "CreateShortDynamicLinkRequest": { - "description": "Request to create a short Dynamic Link.", - "type": "object", - "properties": { - "dynamicLinkInfo": { - "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).", - "$ref": "DynamicLinkInfo" - }, - "longDynamicLink": { - "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).", - "type": "string" - }, - "suffix": { - "description": "Short Dynamic Link suffix. Optional.", - "$ref": "Suffix" - } - }, - "id": "CreateShortDynamicLinkRequest" - }, - "DesktopInfo": { - "description": "Desktop related attributes to the Dynamic Link.", - "type": "object", - "properties": { - "desktopFallbackLink": { - "description": "Link to open on desktop.", - "type": "string" - } - }, - "id": "DesktopInfo" - }, - "DynamicLinkEventStat": { - "description": "Dynamic Link event stat.", - "type": "object", - "properties": { - "event": { - "enumDescriptions": [ - "Unspecified type.", - "Indicates that an FDL is clicked by users.", - "Indicates that an FDL redirects users to fallback link.", - "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.", - "Indicates that the app is opened for the first time after an install\ntriggered by FDLs", - "Indicates that the app is opened via an FDL for non-first time." - ], - "enum": [ - "DYNAMIC_LINK_EVENT_UNSPECIFIED", - "CLICK", - "REDIRECT", - "APP_INSTALL", - "APP_FIRST_OPEN", - "APP_RE_OPEN" - ], - "description": "Link event.", - "type": "string" - }, - "platform": { - "enum": [ - "DYNAMIC_LINK_PLATFORM_UNSPECIFIED", - "ANDROID", - "IOS", - "DESKTOP" - ], - "description": "Requested platform.", - "type": "string", - "enumDescriptions": [ - "Unspecified platform.", - "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.", - "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.", - "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory." - ] - }, - "count": { - "description": "The number of times this event occurred.", - "format": "int64", - "type": "string" - } - }, - "id": "DynamicLinkEventStat" - }, - "GetIosPostInstallAttributionRequest": { - "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.", - "type": "object", - "properties": { - "device": { - "description": "Device information.", - "$ref": "DeviceInfo" - }, - "uniqueMatchLinkToCheck": { - "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.", - "type": "string" - }, - "appInstallationTime": { - "description": "App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.", - "format": "int64", - "type": "string" - }, - "iosVersion": { - "description": "iOS version, ie: 9.3.5.\nConsider adding \"build\".", - "type": "string" - }, - "retrievalMethod": { - "enum": [ - "UNKNOWN_PAYLOAD_RETRIEVAL_METHOD", - "IMPLICIT_WEAK_MATCH", - "EXPLICIT_WEAK_MATCH", - "EXPLICIT_STRONG_AFTER_WEAK_MATCH" - ], - "description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.", - "type": "string", - "enumDescriptions": [ - "Unknown method.", - "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.", - "iSDK performs a server lookup by device fingerprint upon a dev API call.", - "iSDK performs a strong match only if weak match is found upon a dev\nAPI call." - ] - }, - "visualStyle": { - "enumDescriptions": [ - "Unknown style.", - "Default style.", - "Custom style." - ], - "enum": [ - "UNKNOWN_VISUAL_STYLE", - "DEFAULT_STYLE", - "CUSTOM_STYLE" - ], - "description": "Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.", - "type": "string" - }, - "sdkVersion": { - "description": "Google SDK version.", - "type": "string" - }, - "bundleId": { - "description": "APP bundle ID.", - "type": "string" - } - }, - "id": "GetIosPostInstallAttributionRequest" - }, "CreateShortDynamicLinkResponse": { + "description": "Response to create a short Dynamic Link.", + "type": "object", "properties": { + "warning": { + "description": "Information about potential warnings on link creation.", + "type": "array", + "items": { + "$ref": "DynamicLinkWarning" + } + }, "shortLink": { "description": "Short Dynamic Link value. e.g. https://abcd.app.goo.gl/wxyz", "type": "string" @@ -170,18 +27,9 @@ "previewLink": { "description": "Preivew link to show the link flow chart.", "type": "string" - }, - "warning": { - "description": "Information about potential warnings on link creation.", - "type": "array", - "items": { - "$ref": "DynamicLinkWarning" - } } }, - "id": "CreateShortDynamicLinkResponse", - "description": "Response to create a short Dynamic Link.", - "type": "object" + "id": "CreateShortDynamicLinkResponse" }, "Suffix": { "description": "Short Dynamic Link suffix.", @@ -208,10 +56,6 @@ "description": "Parameters for Google Play Campaign Measurements.\n[Learn more](https://developers.google.com/analytics/devguides/collection/android/v4/campaigns#campaign-params)", "type": "object", "properties": { - "utmContent": { - "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.", - "type": "string" - }, "utmMedium": { "description": "Campaign medium; used to identify a medium such as email or cost-per-click.", "type": "string" @@ -224,12 +68,16 @@ "description": "Campaign source; used to identify a search engine, newsletter, or other\nsource.", "type": "string" }, + "utmCampaign": { + "description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.", + "type": "string" + }, "gclid": { "description": "[AdWords autotagging parameter](https://support.google.com/analytics/answer/1033981?hl=en);\nused to measure Google AdWords ads. This value is generated dynamically\nand should never be modified.", "type": "string" }, - "utmCampaign": { - "description": "Campaign name; used for keyword analysis to identify a specific product\npromotion or strategic campaign.", + "utmContent": { + "description": "Campaign content; used for A/B testing and content-targeted ads to\ndifferentiate ads or links that point to the same URL.", "type": "string" } }, @@ -239,37 +87,37 @@ "description": "Information about a Dynamic Link.", "type": "object", "properties": { - "iosInfo": { - "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).", - "$ref": "IosInfo" - }, - "socialMetaTagInfo": { - "$ref": "SocialMetaTagInfo", - "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites." - }, - "androidInfo": { - "$ref": "AndroidInfo", - "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)." - }, "navigationInfo": { "$ref": "NavigationInfo", "description": "Information of navigation behavior of a Firebase Dynamic Links." }, "analyticsInfo": { - "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).", - "$ref": "AnalyticsInfo" + "$ref": "AnalyticsInfo", + "description": "Parameters used for tracking. See all tracking parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)." }, "dynamicLinkDomain": { "description": "Dynamic Links domain that the project owns, e.g. abcd.app.goo.gl\n[Learn more](https://firebase.google.com/docs/dynamic-links/android/receive)\non how to set up Dynamic Link domain associated with your Firebase project.\n\nRequired.", "type": "string" }, "desktopInfo": { - "$ref": "DesktopInfo", - "description": "Desktop related information. See desktop related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)." + "description": "Desktop related information. See desktop related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).", + "$ref": "DesktopInfo" }, "link": { "description": "The link your app will open, You can specify any URL your app can handle.\nThis link must be a well-formatted URL, be properly URL-encoded, and use\nthe HTTP or HTTPS scheme. See 'link' parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).\n\nRequired.", "type": "string" + }, + "iosInfo": { + "$ref": "IosInfo", + "description": "iOS related information. See iOS related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually)." + }, + "socialMetaTagInfo": { + "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.", + "$ref": "SocialMetaTagInfo" + }, + "androidInfo": { + "description": "Android related information. See Android related parameters in the\n[documentation](https://firebase.google.com/docs/dynamic-links/create-manually).", + "$ref": "AndroidInfo" } }, "id": "DynamicLinkInfo" @@ -278,10 +126,6 @@ "description": "Parameters for iTunes Connect App Analytics.", "type": "object", "properties": { - "at": { - "description": "Affiliate token used to create affiliate-coded links.", - "type": "string" - }, "ct": { "description": "Campaign text that developers can optionally add to any link in order to\ntrack sales from a specific marketing campaign.", "type": "string" @@ -293,12 +137,26 @@ "pt": { "description": "Provider token that enables analytics for Dynamic Links from within iTunes\nConnect.", "type": "string" + }, + "at": { + "description": "Affiliate token used to create affiliate-coded links.", + "type": "string" } }, "id": "ITunesConnectAnalytics" }, "DeviceInfo": { + "description": "Signals associated with the device making the request.", + "type": "object", "properties": { + "deviceModelName": { + "description": "Device model name.", + "type": "string" + }, + "languageCodeFromWebview": { + "description": "Device language code setting obtained by executing JavaScript code in\nWebView.", + "type": "string" + }, "languageCodeRaw": { "description": "Device language code raw setting.\niOS does returns language code in different format than iOS WebView.\nFor example WebView returns en_US, but iOS returns en-US.\nField below will return raw value returned by iOS.", "type": "string" @@ -320,23 +178,11 @@ "description": "Device display resolution height.", "format": "int64", "type": "string" - }, - "deviceModelName": { - "description": "Device model name.", - "type": "string" - }, - "languageCodeFromWebview": { - "description": "Device language code setting obtained by executing JavaScript code in\nWebView.", - "type": "string" } }, - "id": "DeviceInfo", - "description": "Signals associated with the device making the request.", - "type": "object" + "id": "DeviceInfo" }, "GetIosPostInstallAttributionResponse": { - "description": "Response for iSDK to execute strong match flow for post-install attribution.", - "type": "object", "properties": { "utmSource": { "description": "Scion source value to be propagated by iSDK to Scion at post-install.", @@ -359,6 +205,12 @@ "type": "string" }, "attributionConfidence": { + "enum": [ + "UNKNOWN_ATTRIBUTION_CONFIDENCE", + "WEAK", + "DEFAULT", + "UNIQUE" + ], "description": "The confidence of the returned attribution.", "type": "string", "enumDescriptions": [ @@ -366,12 +218,6 @@ "Weak confidence, more than one matching link found or link suspected to\nbe false positive", "Default confidence, match based on fingerprint", "Unique confidence, match based on \"unique match link to check\" or other\nmeans" - ], - "enum": [ - "UNKNOWN_ATTRIBUTION_CONFIDENCE", - "WEAK", - "DEFAULT", - "UNIQUE" ] }, "externalBrowserDestinationLink": { @@ -403,9 +249,13 @@ "type": "string" } }, - "id": "GetIosPostInstallAttributionResponse" + "id": "GetIosPostInstallAttributionResponse", + "description": "Response for iSDK to execute strong match flow for post-install attribution.", + "type": "object" }, "SocialMetaTagInfo": { + "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.", + "type": "object", "properties": { "socialDescription": { "description": "A short description of the link. Optional.", @@ -420,36 +270,60 @@ "type": "string" } }, - "id": "SocialMetaTagInfo", - "description": "Parameters for social meta tag params.\nUsed to set meta tag data for link previews on social sites.", - "type": "object" + "id": "SocialMetaTagInfo" }, - "AndroidInfo": { - "description": "Android related attributes to the Dynamic Link.", + "DynamicLinkStats": { + "description": "Analytics stats of a Dynamic Link for a given timeframe.", "type": "object", "properties": { - "androidPackageName": { - "description": "Android package name of the app.", - "type": "string" - }, - "androidMinPackageVersionCode": { - "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.", - "type": "string" - }, - "androidLink": { - "description": "If specified, this overrides the ‘link’ parameter on Android.", - "type": "string" - }, - "androidFallbackLink": { - "description": "Link to open on Android if the app is not installed.", - "type": "string" + "linkEventStats": { + "description": "Dynamic Link event stats.", + "type": "array", + "items": { + "$ref": "DynamicLinkEventStat" + } } }, - "id": "AndroidInfo" + "id": "DynamicLinkStats" }, "DynamicLinkWarning": { "properties": { + "warningDocumentLink": { + "description": "The document describing the warning, and helps resolve.", + "type": "string" + }, "warningCode": { + "enum": [ + "CODE_UNSPECIFIED", + "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME", + "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION", + "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION", + "NOT_URI_ANDROID_LINK", + "UNNECESSARY_ANDROID_LINK", + "NOT_URI_ANDROID_FALLBACK_LINK", + "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK", + "NOT_IN_PROJECT_IOS_BUNDLE_ID", + "NOT_IN_PROJECT_IPAD_BUNDLE_ID", + "UNNECESSARY_IOS_URL_SCHEME", + "NOT_NUMERIC_IOS_APP_STORE_ID", + "UNNECESSARY_IOS_APP_STORE_ID", + "NOT_URI_IOS_FALLBACK_LINK", + "BAD_URI_SCHEME_IOS_FALLBACK_LINK", + "NOT_URI_IPAD_FALLBACK_LINK", + "BAD_URI_SCHEME_IPAD_FALLBACK_LINK", + "BAD_DEBUG_PARAM", + "BAD_AD_PARAM", + "DEPRECATED_PARAM", + "UNRECOGNIZED_PARAM", + "TOO_LONG_PARAM", + "NOT_URI_SOCIAL_IMAGE_LINK", + "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK", + "NOT_URI_SOCIAL_URL", + "BAD_URI_SCHEME_SOCIAL_URL", + "LINK_LENGTH_TOO_LONG", + "LINK_WITH_FRAGMENTS", + "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID" + ], "description": "The warning code.", "type": "string", "enumDescriptions": [ @@ -482,65 +356,39 @@ "Dynamic Link URL length is too long.", "Dynamic Link URL contains fragments.", "The iOS bundle ID does not match with the given iOS store ID." - ], - "enum": [ - "CODE_UNSPECIFIED", - "NOT_IN_PROJECT_ANDROID_PACKAGE_NAME", - "NOT_INTEGER_ANDROID_PACKAGE_MIN_VERSION", - "UNNECESSARY_ANDROID_PACKAGE_MIN_VERSION", - "NOT_URI_ANDROID_LINK", - "UNNECESSARY_ANDROID_LINK", - "NOT_URI_ANDROID_FALLBACK_LINK", - "BAD_URI_SCHEME_ANDROID_FALLBACK_LINK", - "NOT_IN_PROJECT_IOS_BUNDLE_ID", - "NOT_IN_PROJECT_IPAD_BUNDLE_ID", - "UNNECESSARY_IOS_URL_SCHEME", - "NOT_NUMERIC_IOS_APP_STORE_ID", - "UNNECESSARY_IOS_APP_STORE_ID", - "NOT_URI_IOS_FALLBACK_LINK", - "BAD_URI_SCHEME_IOS_FALLBACK_LINK", - "NOT_URI_IPAD_FALLBACK_LINK", - "BAD_URI_SCHEME_IPAD_FALLBACK_LINK", - "BAD_DEBUG_PARAM", - "BAD_AD_PARAM", - "DEPRECATED_PARAM", - "UNRECOGNIZED_PARAM", - "TOO_LONG_PARAM", - "NOT_URI_SOCIAL_IMAGE_LINK", - "BAD_URI_SCHEME_SOCIAL_IMAGE_LINK", - "NOT_URI_SOCIAL_URL", - "BAD_URI_SCHEME_SOCIAL_URL", - "LINK_LENGTH_TOO_LONG", - "LINK_WITH_FRAGMENTS", - "NOT_MATCHING_IOS_BUNDLE_ID_AND_STORE_ID" ] }, "warningMessage": { "description": "The warning message to help developers improve their requests.", "type": "string" - }, - "warningDocumentLink": { - "description": "The document describing the warning, and helps resolve.", - "type": "string" } }, "id": "DynamicLinkWarning", "description": "Dynamic Links warning messages.", "type": "object" }, - "DynamicLinkStats": { - "description": "Analytics stats of a Dynamic Link for a given timeframe.", + "AndroidInfo": { + "description": "Android related attributes to the Dynamic Link.", "type": "object", "properties": { - "linkEventStats": { - "description": "Dynamic Link event stats.", - "type": "array", - "items": { - "$ref": "DynamicLinkEventStat" - } + "androidFallbackLink": { + "description": "Link to open on Android if the app is not installed.", + "type": "string" + }, + "androidPackageName": { + "description": "Android package name of the app.", + "type": "string" + }, + "androidMinPackageVersionCode": { + "description": "Minimum version code for the Android app. If the installed app’s version\ncode is lower, then the user is taken to the Play Store.", + "type": "string" + }, + "androidLink": { + "description": "If specified, this overrides the ‘link’ parameter on Android.", + "type": "string" } }, - "id": "DynamicLinkStats" + "id": "AndroidInfo" }, "NavigationInfo": { "description": "Information of navigation behavior.", @@ -557,10 +405,6 @@ "description": "iOS related attributes to the Dynamic Link..", "type": "object", "properties": { - "iosIpadFallbackLink": { - "description": "If specified, this overrides the ios_fallback_link value on iPads.", - "type": "string" - }, "iosIpadBundleId": { "description": "iPad bundle ID of the app.", "type": "string" @@ -580,16 +424,175 @@ "iosAppStoreId": { "description": "iOS App Store ID.", "type": "string" + }, + "iosIpadFallbackLink": { + "description": "If specified, this overrides the ios_fallback_link value on iPads.", + "type": "string" } }, "id": "IosInfo" + }, + "AnalyticsInfo": { + "description": "Tracking parameters supported by Dynamic Link.", + "type": "object", + "properties": { + "itunesConnectAnalytics": { + "$ref": "ITunesConnectAnalytics", + "description": "iTunes Connect App Analytics." + }, + "googlePlayAnalytics": { + "description": "Google Play Campaign Measurements.", + "$ref": "GooglePlayAnalytics" + } + }, + "id": "AnalyticsInfo" + }, + "CreateShortDynamicLinkRequest": { + "description": "Request to create a short Dynamic Link.", + "type": "object", + "properties": { + "longDynamicLink": { + "description": "Full long Dynamic Link URL with desired query parameters specified.\nFor example,\n\"https://sample.app.goo.gl/?link=http://www.google.com&apn=com.sample\",\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).", + "type": "string" + }, + "suffix": { + "$ref": "Suffix", + "description": "Short Dynamic Link suffix. Optional." + }, + "dynamicLinkInfo": { + "description": "Information about the Dynamic Link to be shortened.\n[Learn more](https://firebase.google.com/docs/dynamic-links/android#create-a-dynamic-link-programmatically).", + "$ref": "DynamicLinkInfo" + } + }, + "id": "CreateShortDynamicLinkRequest" + }, + "DesktopInfo": { + "description": "Desktop related attributes to the Dynamic Link.", + "type": "object", + "properties": { + "desktopFallbackLink": { + "description": "Link to open on desktop.", + "type": "string" + } + }, + "id": "DesktopInfo" + }, + "DynamicLinkEventStat": { + "properties": { + "platform": { + "enumDescriptions": [ + "Unspecified platform.", + "Represents Android platform.\nAll apps and browsers on Android are classfied in this category.", + "Represents iOS platform.\nAll apps and browsers on iOS are classfied in this category.", + "Represents desktop.\nNote: other platforms like Windows, Blackberry, Amazon fall into this\ncategory." + ], + "enum": [ + "DYNAMIC_LINK_PLATFORM_UNSPECIFIED", + "ANDROID", + "IOS", + "DESKTOP" + ], + "description": "Requested platform.", + "type": "string" + }, + "count": { + "description": "The number of times this event occurred.", + "format": "int64", + "type": "string" + }, + "event": { + "enumDescriptions": [ + "Unspecified type.", + "Indicates that an FDL is clicked by users.", + "Indicates that an FDL redirects users to fallback link.", + "Indicates that an FDL triggers an app install from Play store, currently\nit's impossible to get stats from App store.", + "Indicates that the app is opened for the first time after an install\ntriggered by FDLs", + "Indicates that the app is opened via an FDL for non-first time." + ], + "enum": [ + "DYNAMIC_LINK_EVENT_UNSPECIFIED", + "CLICK", + "REDIRECT", + "APP_INSTALL", + "APP_FIRST_OPEN", + "APP_RE_OPEN" + ], + "description": "Link event.", + "type": "string" + } + }, + "id": "DynamicLinkEventStat", + "description": "Dynamic Link event stat.", + "type": "object" + }, + "GetIosPostInstallAttributionRequest": { + "description": "Request for iSDK to execute strong match flow for post-install attribution.\nThis is meant for iOS requests only. Requests from other platforms will\nnot be honored.", + "type": "object", + "properties": { + "appInstallationTime": { + "description": "App installation epoch time (https://en.wikipedia.org/wiki/Unix_time).\nThis is a client signal for a more accurate weak match.", + "format": "int64", + "type": "string" + }, + "iosVersion": { + "description": "iOS version, ie: 9.3.5.\nConsider adding \"build\".", + "type": "string" + }, + "visualStyle": { + "enumDescriptions": [ + "Unknown style.", + "Default style.", + "Custom style." + ], + "enum": [ + "UNKNOWN_VISUAL_STYLE", + "DEFAULT_STYLE", + "CUSTOM_STYLE" + ], + "description": "Strong match page information. Disambiguates between default UI and\ncustom page to present when strong match succeeds/fails to find cookie.", + "type": "string" + }, + "retrievalMethod": { + "enumDescriptions": [ + "Unknown method.", + "iSDK performs a server lookup by device fingerprint in the background\nwhen app is first-opened; no API called by developer.", + "iSDK performs a server lookup by device fingerprint upon a dev API call.", + "iSDK performs a strong match only if weak match is found upon a dev\nAPI call." + ], + "enum": [ + "UNKNOWN_PAYLOAD_RETRIEVAL_METHOD", + "IMPLICIT_WEAK_MATCH", + "EXPLICIT_WEAK_MATCH", + "EXPLICIT_STRONG_AFTER_WEAK_MATCH" + ], + "description": "App post install attribution retrieval information. Disambiguates\nmechanism (iSDK or developer invoked) to retrieve payload from\nclicked link.", + "type": "string" + }, + "sdkVersion": { + "description": "Google SDK version.", + "type": "string" + }, + "bundleId": { + "description": "APP bundle ID.", + "type": "string" + }, + "device": { + "$ref": "DeviceInfo", + "description": "Device information." + }, + "uniqueMatchLinkToCheck": { + "description": "Possible unique matched link that server need to check before performing\nfingerprint match. If passed link is short server need to expand the link.\nIf link is long server need to vslidate the link.", + "type": "string" + } + }, + "id": "GetIosPostInstallAttributionRequest" } }, - "protocol": "rest", "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, + "protocol": "rest", "canonicalName": "Firebase Dynamic Links", "auth": { "oauth2": { @@ -610,6 +613,8 @@ "shortLinks": { "methods": { "create": { + "path": "v1/shortLinks", + "id": "firebasedynamiclinks.shortLinks.create", "description": "Creates a short Dynamic Link given either a valid long Dynamic Link or\ndetails such as Dynamic Link domain, Android and iOS app information.\nThe created short Dynamic Link will not expire.\n\nRepeated calls with the same long Dynamic Link or Dynamic Link information\nwill produce the same short Dynamic Link.\n\nThe Dynamic Link domain in the request must be owned by requester's\nFirebase project.", "request": { "$ref": "CreateShortDynamicLinkRequest" @@ -623,47 +628,43 @@ "https://www.googleapis.com/auth/firebase" ], "parameters": {}, - "flatPath": "v1/shortLinks", - "path": "v1/shortLinks", - "id": "firebasedynamiclinks.shortLinks.create" + "flatPath": "v1/shortLinks" } } }, "v1": { "methods": { "getLinkStats": { - "response": { - "$ref": "DynamicLinkStats" - }, + "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens.", + "httpMethod": "GET", "parameterOrder": [ "dynamicLink" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/firebase" - ], + "response": { + "$ref": "DynamicLinkStats" + }, "parameters": { + "dynamicLink": { + "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz", + "required": true, + "type": "string", + "location": "path" + }, "durationDays": { "description": "The span of time requested in days.", "format": "int64", "type": "string", "location": "query" - }, - "dynamicLink": { - "location": "path", - "description": "Dynamic Link URL. e.g. https://abcd.app.goo.gl/wxyz", - "required": true, - "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/firebase" + ], "flatPath": "v1/{dynamicLink}/linkStats", - "path": "v1/{dynamicLink}/linkStats", "id": "firebasedynamiclinks.getLinkStats", - "description": "Fetches analytics stats of a short Dynamic Link for a given\nduration. Metrics include number of clicks, redirects, installs,\napp first opens, and app reopens." + "path": "v1/{dynamicLink}/linkStats" }, "installAttribution": { - "path": "v1/installAttribution", - "id": "firebasedynamiclinks.installAttribution", "request": { "$ref": "GetIosPostInstallAttributionRequest" }, @@ -677,64 +678,29 @@ "scopes": [ "https://www.googleapis.com/auth/firebase" ], - "flatPath": "v1/installAttribution" + "flatPath": "v1/installAttribution", + "path": "v1/installAttribution", + "id": "firebasedynamiclinks.installAttribution" } } } }, "parameters": { - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, "$.xgafv": { "enumDescriptions": [ "v1 error format", @@ -748,14 +714,7 @@ "description": "V1 error format.", "type": "string" }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "alt": { - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -767,12 +726,53 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], + "location": "query", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" } }, "version": "v1", - "baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/", - "servicePath": "", - "kind": "discovery#restDescription", - "description": "Programmatically creates and manages Firebase Dynamic Links." + "baseUrl": "https://firebasedynamiclinks-ipv6.googleapis.com/" }
diff --git a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json index bdc923b..504085e 100644 --- a/firebaseremoteconfig/v1/firebaseremoteconfig-api.json +++ b/firebaseremoteconfig/v1/firebaseremoteconfig-api.json
@@ -1,4 +1,5 @@ { + "canonicalName": "Firebase Remote Config", "rootUrl": "https://firebaseremoteconfig.googleapis.com/", "ownerDomain": "google.com", "name": "firebaseremoteconfig", @@ -10,9 +11,6 @@ "projects": { "methods": { "getRemoteConfig": { - "flatPath": "v1/projects/{projectsId}/remoteConfig", - "path": "v1/{+project}/remoteConfig", - "id": "firebaseremoteconfig.projects.getRemoteConfig", "description": "Get the latest version Remote Configuration for a project.\nReturns the RemoteConfig as the payload, and also the eTag as a\nresponse header.", "response": { "$ref": "RemoteConfig" @@ -23,15 +21,24 @@ "httpMethod": "GET", "parameters": { "project": { + "pattern": "^projects/[^/]+$", + "location": "path", "description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" + "type": "string" } - } + }, + "flatPath": "v1/projects/{projectsId}/remoteConfig", + "path": "v1/{+project}/remoteConfig", + "id": "firebaseremoteconfig.projects.getRemoteConfig" }, "updateRemoteConfig": { + "path": "v1/{+project}/remoteConfig", + "id": "firebaseremoteconfig.projects.updateRemoteConfig", + "request": { + "$ref": "RemoteConfig" + }, + "description": "Update a RemoteConfig. We treat this as an always-existing\nresource (when it is not found in our data store, we treat it as version\n0, a template with zero conditions and zero parameters). Hence there are\nno Create or Delete operations. Returns the updated template when\nsuccessful (and the updated eTag as a response header), or an error if\nthings go wrong.\nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if the request can not be\nauthorized (e.g. the user has no access to the specified project id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis specified but does does not match the current eTag.\n* Internal error (HTTP status 500) for Database problems or other internal\nerrors.", "response": { "$ref": "RemoteConfig" }, @@ -41,9 +48,9 @@ "httpMethod": "PUT", "parameters": { "validateOnly": { - "location": "query", "description": "Optional. Defaults to \u003ccode\u003efalse\u003c/code\u003e (UpdateRemoteConfig call should\nupdate the backend if there are no validation/interal errors). May be set\nto \u003ccode\u003etrue\u003c/code\u003e to indicate that, should no validation errors occur,\nthe call should return a \"200 OK\" instead of performing the update. Note\nthat other error messages (500 Internal Error, 412 Version Mismatch, etc)\nmay still result after flipping to \u003ccode\u003efalse\u003c/code\u003e, even if getting a\n\"200 OK\" when calling with \u003ccode\u003etrue\u003c/code\u003e.", - "type": "boolean" + "type": "boolean", + "location": "query" }, "project": { "description": "The GMP project identifier. Required.\nSee note at the beginning of this file regarding project ids.", @@ -53,41 +60,81 @@ "location": "path" } }, - "flatPath": "v1/projects/{projectsId}/remoteConfig", - "path": "v1/{+project}/remoteConfig", - "id": "firebaseremoteconfig.projects.updateRemoteConfig", - "request": { - "$ref": "RemoteConfig" - }, - "description": "Update a RemoteConfig. We treat this as an always-existing\nresource (when it is not found in our data store, we treat it as version\n0, a template with zero conditions and zero parameters). Hence there are\nno Create or Delete operations. Returns the updated template when\nsuccessful (and the updated eTag as a response header), or an error if\nthings go wrong.\nPossible error messages:\n* VALIDATION_ERROR (HTTP status 400) with additional details if the\ntemplate being passed in can not be validated.\n* AUTHENTICATION_ERROR (HTTP status 401) if the request can not be\nauthenticate (e.g. no access token, or invalid access token).\n* AUTHORIZATION_ERROR (HTTP status 403) if the request can not be\nauthorized (e.g. the user has no access to the specified project id).\n* VERSION_MISMATCH (HTTP status 412) when trying to update when the\nexpected eTag (passed in via the \"If-match\" header) is not specified, or\nis specified but does does not match the current eTag.\n* Internal error (HTTP status 500) for Database problems or other internal\nerrors." + "flatPath": "v1/projects/{projectsId}/remoteConfig" } } } }, "parameters": { + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "key": { + "location": "query", + "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.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", + "default": "true" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", "location": "query" }, "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "type": "string", "location": "query", - "description": "Selector specifying which fields to include in a partial response." + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" }, "$.xgafv": { - "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -97,57 +144,11 @@ "1", "2" ], - "description": "V1 error format." - }, - "callback": { - "location": "query", - "description": "JSONP", + "description": "V1 error format.", "type": "string" }, - "alt": { - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response." - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "type": "string", - "location": "query", - "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." - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "description": "OAuth bearer token.", + "callback": { + "description": "JSONP", "type": "string", "location": "query" } @@ -158,20 +159,14 @@ "description": "Firebase Remote Config API allows the 3P clients to manage Remote Config conditions and parameters for Firebase applications.", "servicePath": "", "basePath": "", + "id": "firebaseremoteconfig:v1", "revision": "20171129", "documentationLink": "https://firebase.google.com/docs/remote-config/", - "id": "firebaseremoteconfig:v1", "discoveryVersion": "v1", "version_module": true, "schemas": { "RemoteConfigParameter": { - "description": "While default_value and conditional_values are each optional, at least one of\nthe two is required - otherwise, the parameter is meaningless (and an\nexception will be thrown by the validation logic).", - "type": "object", "properties": { - "defaultValue": { - "$ref": "RemoteConfigParameterValue", - "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e." - }, "description": { "description": "Optional.\nA description for this Parameter. Length must be less than or equal to\n100 characters (or more precisely, unicode code points, which is defined in\njava/com/google/wireless/android/config/ConstsExporter.java).\nA description may contain any Unicode characters", "type": "string" @@ -182,41 +177,19 @@ }, "description": "Optional - a map of (condition_name, value). The condition_name of the\nhighest priority (the one listed first in the conditions array) determines\nthe value of this parameter.", "type": "object" + }, + "defaultValue": { + "$ref": "RemoteConfigParameterValue", + "description": "Optional - value to set the parameter to, when none of the named conditions\nevaluate to \u003ccode\u003etrue\u003c/code\u003e." } }, - "id": "RemoteConfigParameter" + "id": "RemoteConfigParameter", + "description": "While default_value and conditional_values are each optional, at least one of\nthe two is required - otherwise, the parameter is meaningless (and an\nexception will be thrown by the validation logic).", + "type": "object" }, "RemoteConfigCondition": { - "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.", - "type": "object", "properties": { - "name": { - "description": "Required.\nA non empty and unique name of this condition.", - "type": "string" - }, - "description": { - "description": "Optional.\nA description for this Condition. Length must be less than or equal to\n100 characters (or more precisely, unicode code points, which is defined in\njava/com/google/wireless/android/config/ConstsExporter.java).\nA description may contain any Unicode characters", - "type": "string" - }, - "expression": { - "description": "Required.", - "type": "string" - }, "tagColor": { - "enumDescriptions": [ - "", - "Blue", - "Brown", - "Cyan", - "aka \"Red Orange\"", - "Green", - "Indigo\n*", - "Lime - Approved deviation from Material color palette", - "Orange", - "Pink", - "Purple", - "Teal" - ], "enum": [ "CONDITION_DISPLAY_COLOR_UNSPECIFIED", "BLUE", @@ -232,14 +205,40 @@ "TEAL" ], "description": "Optional.\nThe display (tag) color of this condition. This serves as part of a tag\n(in the future, we may add tag text as well as tag color, but that is not\nyet implemented in the UI).\nThis value has no affect on the semantics of the delivered config and it\nis ignored by the backend, except for passing it through write/read\nrequests.\nNot having this value or having the \"CONDITION_DISPLAY_COLOR_UNSPECIFIED\"\nvalue (0) have the same meaning: Let the UI choose any valid color when\ndisplaying the condition.", + "type": "string", + "enumDescriptions": [ + "", + "Blue", + "Brown", + "Cyan", + "aka \"Red Orange\"", + "Green", + "Indigo\n*", + "Lime - Approved deviation from Material color palette", + "Orange", + "Pink", + "Purple", + "Teal" + ] + }, + "name": { + "description": "Required.\nA non empty and unique name of this condition.", + "type": "string" + }, + "description": { + "description": "Optional.\nA description for this Condition. Length must be less than or equal to\n100 characters (or more precisely, unicode code points, which is defined in\njava/com/google/wireless/android/config/ConstsExporter.java).\nA description may contain any Unicode characters", + "type": "string" + }, + "expression": { + "description": "Required.", "type": "string" } }, - "id": "RemoteConfigCondition" + "id": "RemoteConfigCondition", + "description": "A single RemoteConfig Condition. A list of these (because order matters) are\npart of a single RemoteConfig template.", + "type": "object" }, "RemoteConfigParameterValue": { - "description": "A RemoteConfigParameter's \"value\" (either the default value, or the value\nassociated with a condition name) is either a string, or the\n\"use_in_app_default\" indicator (which means to leave out the parameter from\nthe returned \u003ckey, value\u003e map that is the output of the parameter fetch).\nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\ninstead of the string) it should always be \u003ccode\u003etrue\u003c/code\u003e.", - "type": "object", "properties": { "value": { "description": "the string to set the parameter to", @@ -250,11 +249,11 @@ "type": "boolean" } }, - "id": "RemoteConfigParameterValue" + "id": "RemoteConfigParameterValue", + "description": "A RemoteConfigParameter's \"value\" (either the default value, or the value\nassociated with a condition name) is either a string, or the\n\"use_in_app_default\" indicator (which means to leave out the parameter from\nthe returned \u003ckey, value\u003e map that is the output of the parameter fetch).\nWe represent the \"use_in_app_default\" as a bool, but (when using the boolean\ninstead of the string) it should always be \u003ccode\u003etrue\u003c/code\u003e.", + "type": "object" }, "RemoteConfig": { - "description": "*\nThe RemoteConfig consists of a list of conditions (which can be\nthought of as named \"if\" statements) and a map of parameters (parameter key\nto a structure containing an optional default value, as well as a optional\nsubmap of (condition name to value when that condition is true).", - "type": "object", "properties": { "parameters": { "additionalProperties": { @@ -271,13 +270,14 @@ } } }, - "id": "RemoteConfig" + "id": "RemoteConfig", + "description": "*\nThe RemoteConfig consists of a list of conditions (which can be\nthought of as named \"if\" statements) and a map of parameters (parameter key\nto a structure containing an optional default value, as well as a optional\nsubmap of (condition name to value when that condition is true).", + "type": "object" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest", - "canonicalName": "Firebase Remote Config" + "protocol": "rest" }
diff --git a/firebaserules/v1/firebaserules-api.json b/firebaserules/v1/firebaserules-api.json index f00145b..2180dd2 100644 --- a/firebaserules/v1/firebaserules-api.json +++ b/firebaserules/v1/firebaserules-api.json
@@ -1,42 +1,517 @@ { + "canonicalName": "Firebase Rules", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/firebase": { + "description": "View and administer all your Firebase data and settings" + }, + "https://www.googleapis.com/auth/firebase.readonly": { + "description": "View all your Firebase data and settings" + } + } + } + }, + "rootUrl": "https://firebaserules.googleapis.com/", + "ownerDomain": "google.com", + "name": "firebaserules", + "batchPath": "batch", + "title": "Firebase Rules API", + "ownerName": "Google", + "resources": { + "projects": { + "methods": { + "test": { + "request": { + "$ref": "TestRulesetRequest" + }, + "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }", + "response": { + "$ref": "TestRulesetResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "Tests may either provide `source` or a `Ruleset` resource name.\n\nFor tests against `source`, the resource name must refer to the project:\nFormat: `projects/{project_id}`\n\nFor tests against a `Ruleset`, this must be the `Ruleset` resource name:\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", + "required": true, + "type": "string", + "pattern": "^projects/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ], + "flatPath": "v1/projects/{projectsId}:test", + "path": "v1/{+name}:test", + "id": "firebaserules.projects.test" + } + }, + "resources": { + "rulesets": { + "methods": { + "get": { + "description": "Get a `Ruleset` by name including the full `Source` contents.", + "response": { + "$ref": "Ruleset" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ], + "parameters": { + "name": { + "location": "path", + "description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/rulesets/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}", + "path": "v1/{+name}", + "id": "firebaserules.projects.rulesets.get" + }, + "list": { + "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.", + "response": { + "$ref": "ListRulesetsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ], + "parameters": { + "pageSize": { + "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`", + "type": "string", + "location": "query" + }, + "name": { + "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Next page token for loading the next batch of `Ruleset` instances.", + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/rulesets", + "path": "v1/{+name}/rulesets", + "id": "firebaserules.projects.rulesets.list" + }, + "create": { + "request": { + "$ref": "Ruleset" + }, + "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Ruleset" + }, + "parameters": { + "name": { + "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ], + "flatPath": "v1/projects/{projectsId}/rulesets", + "id": "firebaserules.projects.rulesets.create", + "path": "v1/{+name}/rulesets" + }, + "delete": { + "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}", + "path": "v1/{+name}", + "id": "firebaserules.projects.rulesets.delete", + "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "location": "path", + "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/rulesets/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } + }, + "releases": { + "methods": { + "get": { + "response": { + "$ref": "Release" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ], + "parameters": { + "name": { + "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/releases/.+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/releases/{releasesId}", + "path": "v1/{+name}", + "id": "firebaserules.projects.releases.get", + "description": "Get a `Release` by name." + }, + "patch": { + "request": { + "$ref": "UpdateReleaseRequest" + }, + "description": "Update a `Release` via PATCH.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.", + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Release" + }, + "parameters": { + "name": { + "location": "path", + "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/releases/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ], + "flatPath": "v1/projects/{projectsId}/releases/{releasesId}", + "id": "firebaserules.projects.releases.patch", + "path": "v1/{+name}" + }, + "update": { + "flatPath": "v1/projects/{projectsId}/releases/{releasesId}", + "path": "v1/{+name}", + "id": "firebaserules.projects.releases.update", + "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.", + "request": { + "$ref": "Release" + }, + "response": { + "$ref": "Release" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ], + "parameters": { + "name": { + "location": "path", + "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/releases/.+$" + } + } + }, + "getExecutable": { + "response": { + "$ref": "GetReleaseExecutableResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ], + "parameters": { + "executableVersion": { + "location": "query", + "enum": [ + "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED", + "FIREBASE_RULES_EXECUTABLE_V1", + "FIREBASE_RULES_EXECUTABLE_V2" + ], + "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1", + "type": "string" + }, + "name": { + "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/releases/.+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable", + "path": "v1/{+name}:getExecutable", + "id": "firebaserules.projects.releases.getExecutable", + "description": "Get the `Release` executable to use when enforcing rules." + }, + "delete": { + "description": "Delete a `Release` by resource name.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ], + "parameters": { + "name": { + "location": "path", + "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/releases/.+$" + } + }, + "flatPath": "v1/projects/{projectsId}/releases/{releasesId}", + "path": "v1/{+name}", + "id": "firebaserules.projects.releases.delete" + }, + "list": { + "httpMethod": "GET", + "response": { + "$ref": "ListReleasesResponse" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "pageSize": { + "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load fewer\nthan `page_size` results due to the size of the output. To traverse all of\nthe releases, the caller should iterate until the `page_token` on the\nresponse is empty.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "location": "query", + "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`", + "type": "string" + }, + "name": { + "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Next page token for the next batch of `Release` instances.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase", + "https://www.googleapis.com/auth/firebase.readonly" + ], + "flatPath": "v1/projects/{projectsId}/releases", + "id": "firebaserules.projects.releases.list", + "path": "v1/{+name}/releases", + "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof." + }, + "create": { + "flatPath": "v1/projects/{projectsId}/releases", + "path": "v1/{+name}/releases", + "id": "firebaserules.projects.releases.create", + "request": { + "$ref": "Release" + }, + "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method.", + "response": { + "$ref": "Release" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/firebase" + ] + } + } + } + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + } + }, + "version": "v1", + "baseUrl": "https://firebaserules.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n", + "servicePath": "", "basePath": "", - "revision": "20171108", - "documentationLink": "https://firebase.google.com/docs/storage/security", "id": "firebaserules:v1", + "documentationLink": "https://firebase.google.com/docs/storage/security", + "revision": "20171108", "discoveryVersion": "v1", "version_module": true, "schemas": { - "Arg": { - "description": "Arg matchers for the mock function.", - "type": "object", - "properties": { - "exactValue": { - "description": "Argument exactly matches value provided.", - "type": "any" - }, - "anyValue": { - "$ref": "Empty", - "description": "Argument matches any value provided." - } - }, - "id": "Arg" - }, - "UpdateReleaseRequest": { - "description": "The request for FirebaseRulesService.UpdateReleasePatch.", - "type": "object", - "properties": { - "release": { - "$ref": "Release", - "description": "`Release` to update." - }, - "updateMask": { - "description": "Specifies which fields to update.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "UpdateReleaseRequest" - }, "TestSuite": { "description": "`TestSuite` is a collection of `TestCase` instances that validate the logical\ncorrectness of a `Ruleset`. The `TestSuite` may be referenced in-line within\na `TestRuleset` invocation or as part of a `Release` object as a pre-release\ncheck.", "type": "object", @@ -51,21 +526,35 @@ }, "id": "TestSuite" }, - "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" - }, - "FunctionMock": { + "UpdateReleaseRequest": { + "description": "The request for FirebaseRulesService.UpdateReleasePatch.", + "type": "object", "properties": { - "function": { - "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.", + "updateMask": { + "description": "Specifies which fields to update.", + "format": "google-fieldmask", "type": "string" }, + "release": { + "$ref": "Release", + "description": "`Release` to update." + } + }, + "id": "UpdateReleaseRequest" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "FunctionMock": { + "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.", + "type": "object", + "properties": { "result": { - "description": "The mock result of the function call.", - "$ref": "Result" + "$ref": "Result", + "description": "The mock result of the function call." }, "args": { "description": "The list of `Arg` values to match. The order in which the arguments are\nprovided is the order in which they must appear in the function\ninvocation.", @@ -73,40 +562,49 @@ "items": { "$ref": "Arg" } + }, + "function": { + "description": "The name of the function.\n\nThe function name must match one provided by a service declaration.", + "type": "string" } }, - "id": "FunctionMock", - "description": "Mock function definition.\n\nMocks must refer to a function declared by the target service. The type of\nthe function args and result will be inferred at test time. If either the\narg or result values are not compatible with function type declaration, the\nrequest will be considered invalid.\n\nMore than one `FunctionMock` may be provided for a given function name so\nlong as the `Arg` matchers are distinct. There may be only one function\nfor a given overload where all `Arg` values are `Arg.any_value`.", - "type": "object" + "id": "FunctionMock" }, "GetReleaseExecutableResponse": { "description": "The response for FirebaseRulesService.GetReleaseExecutable", "type": "object", "properties": { + "executable": { + "description": "Executable view of the `Ruleset` referenced by the `Release`.", + "format": "byte", + "type": "string" + }, "updateTime": { "description": "Timestamp for the most recent `Release.update_time`.", "format": "google-datetime", "type": "string" }, "language": { + "enumDescriptions": [ + "Language unspecified. Defaults to FIREBASE_RULES.", + "Firebase Rules language.", + "Event Flow triggers." + ], "enum": [ "LANGUAGE_UNSPECIFIED", "FIREBASE_RULES", "EVENT_FLOW_TRIGGERS" ], "description": "`Language` used to generate the executable bytes.", - "type": "string", - "enumDescriptions": [ - "Language unspecified. Defaults to FIREBASE_RULES.", - "Firebase Rules language.", - "Event Flow triggers." - ] + "type": "string" }, "rulesetName": { "description": "`Ruleset` name associated with the `Release` executable.", "type": "string" }, "executableVersion": { + "description": "The Rules runtime version of the executable.", + "type": "string", "enumDescriptions": [ "Executable format unspecified.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1", "Firebase Rules syntax 'rules2' executable versions:\nCustom AST for use with Java clients.", @@ -116,19 +614,14 @@ "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED", "FIREBASE_RULES_EXECUTABLE_V1", "FIREBASE_RULES_EXECUTABLE_V2" - ], - "description": "The Rules runtime version of the executable.", - "type": "string" - }, - "executable": { - "description": "Executable view of the `Ruleset` referenced by the `Release`.", - "format": "byte", - "type": "string" + ] } }, "id": "GetReleaseExecutableResponse" }, "Source": { + "description": "`Source` is one or more `File` messages comprising a logical set of rules.", + "type": "object", "properties": { "files": { "description": "`File` set constituting the `Source` bundle.", @@ -138,24 +631,22 @@ } } }, - "id": "Source", - "description": "`Source` is one or more `File` messages comprising a logical set of rules.", - "type": "object" + "id": "Source" }, "Result": { + "description": "Possible result values from the function mock invocation.", + "type": "object", "properties": { "value": { "description": "The result is an actual value. The type of the value must match that\nof the type declared by the service.", "type": "any" }, "undefined": { - "description": "The result is undefined, meaning the result could not be computed.", - "$ref": "Empty" + "$ref": "Empty", + "description": "The result is undefined, meaning the result could not be computed." } }, - "id": "Result", - "description": "Possible result values from the function mock invocation.", - "type": "object" + "id": "Result" }, "SourcePosition": { "description": "Position in the `Source` content including its line, column number, and an\nindex of the `File` in the `Source` message. Used for debug purposes.", @@ -179,6 +670,8 @@ "id": "SourcePosition" }, "TestCase": { + "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.", + "type": "object", "properties": { "resource": { "description": "Optional resource value as it appears in persistent storage before the\nrequest is fulfilled.\n\nThe resource type depends on the `request.path` value.", @@ -192,17 +685,17 @@ } }, "expectation": { - "enum": [ - "EXPECTATION_UNSPECIFIED", - "ALLOW", - "DENY" - ], "description": "Test expectation.", "type": "string", "enumDescriptions": [ "Unspecified expectation.", "Expect an allowed result.", "Expect a denied result." + ], + "enum": [ + "EXPECTATION_UNSPECIFIED", + "ALLOW", + "DENY" ] }, "request": { @@ -210,28 +703,47 @@ "type": "any" } }, - "id": "TestCase", - "description": "`TestCase` messages provide the request context and an expectation as to\nwhether the given context will be allowed or denied. Test cases may specify\nthe `request`, `resource`, and `function_mocks` to mock a function call to\na service-provided function.\n\nThe `request` object represents context present at request-time.\n\nThe `resource` is the value of the target resource as it appears in\npersistent storage before the request is executed.", - "type": "object" + "id": "TestCase" + }, + "Ruleset": { + "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.", + "type": "object", + "properties": { + "source": { + "$ref": "Source", + "description": "`Source` for the `Ruleset`." + }, + "createTime": { + "description": "Time the `Ruleset` was created.\nOutput only.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only.", + "type": "string" + } + }, + "id": "Ruleset" + }, + "TestRulesetRequest": { + "description": "The request for FirebaseRulesService.TestRuleset.", + "type": "object", + "properties": { + "source": { + "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`.", + "$ref": "Source" + }, + "testSuite": { + "$ref": "TestSuite", + "description": "Inline `TestSuite` to run." + } + }, + "id": "TestRulesetRequest" }, "Issue": { + "description": "Issues include warnings, errors, and deprecation notices.", + "type": "object", "properties": { - "severity": { - "enum": [ - "SEVERITY_UNSPECIFIED", - "DEPRECATION", - "WARNING", - "ERROR" - ], - "description": "The severity of the issue.", - "type": "string", - "enumDescriptions": [ - "An unspecified severity.", - "Deprecation issue for statements and method that may no longer be\nsupported or maintained.", - "Warnings such as: unused variables.", - "Errors such as: unmatched curly braces or variable redefinition." - ] - }, "description": { "description": "Short error description.", "type": "string" @@ -239,46 +751,25 @@ "sourcePosition": { "$ref": "SourcePosition", "description": "Position of the issue in the `Source`." + }, + "severity": { + "description": "The severity of the issue.", + "type": "string", + "enumDescriptions": [ + "An unspecified severity.", + "Deprecation issue for statements and method that may no longer be\nsupported or maintained.", + "Warnings such as: unused variables.", + "Errors such as: unmatched curly braces or variable redefinition." + ], + "enum": [ + "SEVERITY_UNSPECIFIED", + "DEPRECATION", + "WARNING", + "ERROR" + ] } }, - "id": "Issue", - "description": "Issues include warnings, errors, and deprecation notices.", - "type": "object" - }, - "TestRulesetRequest": { - "description": "The request for FirebaseRulesService.TestRuleset.", - "type": "object", - "properties": { - "source": { - "$ref": "Source", - "description": "Optional `Source` to be checked for correctness.\n\nThis field must not be set when the resource name refers to a `Ruleset`." - }, - "testSuite": { - "description": "Inline `TestSuite` to run.", - "$ref": "TestSuite" - } - }, - "id": "TestRulesetRequest" - }, - "Ruleset": { - "description": "`Ruleset` is an immutable copy of `Source` with a globally unique identifier\nand a creation time.", - "type": "object", - "properties": { - "name": { - "description": "Name of the `Ruleset`. The ruleset_id is auto generated by the service.\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`\nOutput only.", - "type": "string" - }, - "source": { - "description": "`Source` for the `Ruleset`.", - "$ref": "Source" - }, - "createTime": { - "description": "Time the `Ruleset` was created.\nOutput only.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "Ruleset" + "id": "Issue" }, "File": { "description": "`File` containing source content.", @@ -319,24 +810,26 @@ "id": "FunctionCall" }, "ListReleasesResponse": { + "description": "The response for FirebaseRulesService.ListReleases.", + "type": "object", "properties": { - "nextPageToken": { - "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.", - "type": "string" - }, "releases": { "description": "List of `Release` instances.", "type": "array", "items": { "$ref": "Release" } + }, + "nextPageToken": { + "description": "The pagination token to retrieve the next page of results. If the value is\nempty, no further results remain.", + "type": "string" } }, - "id": "ListReleasesResponse", - "description": "The response for FirebaseRulesService.ListReleases.", - "type": "object" + "id": "ListReleasesResponse" }, "Release": { + "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.", + "type": "object", "properties": { "createTime": { "description": "Time the release was created.\nOutput only.", @@ -357,9 +850,7 @@ "type": "string" } }, - "id": "Release", - "description": "`Release` is a named reference to a `Ruleset`. Once a `Release` refers to a\n`Ruleset`, rules-enabled services will be able to enforce the `Ruleset`.", - "type": "object" + "id": "Release" }, "TestRulesetResponse": { "description": "The response for FirebaseRulesService.TestRuleset.", @@ -383,7 +874,20 @@ "id": "TestRulesetResponse" }, "TestResult": { + "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.", + "type": "object", "properties": { + "errorPosition": { + "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`", + "$ref": "SourcePosition" + }, + "functionCalls": { + "description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.", + "type": "array", + "items": { + "$ref": "FunctionCall" + } + }, "state": { "enumDescriptions": [ "Test state is not set.", @@ -404,22 +908,9 @@ "items": { "type": "string" } - }, - "errorPosition": { - "description": "Position in the `Source` or `Ruleset` where the principle runtime error\noccurs.\n\nEvaluation of an expression may result in an error. Rules are deny by\ndefault, so a `DENY` expectation when an error is generated is valid.\nWhen there is a `DENY` with an error, the `SourcePosition` is returned.\n\nE.g. `error_position { line: 19 column: 37 }`", - "$ref": "SourcePosition" - }, - "functionCalls": { - "description": "The set of function calls made to service-defined methods.\n\nFunction calls are included in the order in which they are encountered\nduring evaluation, are provided for both mocked and unmocked functions,\nand included on the response regardless of the test `state`.", - "type": "array", - "items": { - "$ref": "FunctionCall" - } } }, - "id": "TestResult", - "description": "Test result message containing the state of the test as well as a\ndescription and source position for test failures.", - "type": "object" + "id": "TestResult" }, "ListRulesetsResponse": { "description": "The response for FirebaseRulesService.ListRulesets.", @@ -438,517 +929,26 @@ } }, "id": "ListRulesetsResponse" + }, + "Arg": { + "description": "Arg matchers for the mock function.", + "type": "object", + "properties": { + "exactValue": { + "description": "Argument exactly matches value provided.", + "type": "any" + }, + "anyValue": { + "description": "Argument matches any value provided.", + "$ref": "Empty" + } + }, + "id": "Arg" } }, "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest", - "canonicalName": "Firebase Rules", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/firebase": { - "description": "View and administer all your Firebase data and settings" - }, - "https://www.googleapis.com/auth/firebase.readonly": { - "description": "View all your Firebase data and settings" - } - } - } - }, - "rootUrl": "https://firebaserules.googleapis.com/", - "ownerDomain": "google.com", - "name": "firebaserules", - "batchPath": "batch", - "title": "Firebase Rules API", - "ownerName": "Google", - "resources": { - "projects": { - "methods": { - "test": { - "request": { - "$ref": "TestRulesetRequest" - }, - "description": "Test `Source` for syntactic and semantic correctness. Issues present, if\nany, will be returned to the caller with a description, severity, and\nsource location.\n\nThe test method may be executed with `Source` or a `Ruleset` name.\nPassing `Source` is useful for unit testing new rules. Passing a `Ruleset`\nname is useful for regression testing an existing rule.\n\nThe following is an example of `Source` that permits users to upload images\nto a bucket bearing their user id and matching the correct metadata:\n\n_*Example*_\n\n // Users are allowed to subscribe and unsubscribe to the blog.\n service firebase.storage {\n match /users/{userId}/images/{imageName} {\n allow write: if userId == request.auth.uid\n && (imageName.matches('*.png$')\n || imageName.matches('*.jpg$'))\n && resource.mimeType.matches('^image/')\n }\n }", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "TestRulesetResponse" - }, - "parameters": { - "name": { - "description": "Tests may either provide `source` or a `Ruleset` resource name.\n\nFor tests against `source`, the resource name must refer to the project:\nFormat: `projects/{project_id}`\n\nFor tests against a `Ruleset`, this must be the `Ruleset` resource name:\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", - "required": true, - "type": "string", - "pattern": "^projects/.+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ], - "flatPath": "v1/projects/{projectsId}:test", - "id": "firebaserules.projects.test", - "path": "v1/{+name}:test" - } - }, - "resources": { - "rulesets": { - "methods": { - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Ruleset" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Resource name for Project which owns this `Ruleset`.\n\nFormat: `projects/{project_id}`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ], - "flatPath": "v1/projects/{projectsId}/rulesets", - "id": "firebaserules.projects.rulesets.create", - "path": "v1/{+name}/rulesets", - "request": { - "$ref": "Ruleset" - }, - "description": "Create a `Ruleset` from `Source`.\n\nThe `Ruleset` is given a unique generated name which is returned to the\ncaller. `Source` containing syntactic or semantics errors will result in an\nerror response indicating the first error encountered. For a detailed view\nof `Source` issues, use TestRuleset." - }, - "delete": { - "path": "v1/{+name}", - "id": "firebaserules.projects.rulesets.delete", - "description": "Delete a `Ruleset` by resource name.\n\nIf the `Ruleset` is referenced by a `Release` the operation will fail.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/rulesets/[^/]+$", - "location": "path", - "description": "Resource name for the ruleset to delete.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}" - }, - "get": { - "id": "firebaserules.projects.rulesets.get", - "path": "v1/{+name}", - "description": "Get a `Ruleset` by name including the full `Source` contents.", - "httpMethod": "GET", - "response": { - "$ref": "Ruleset" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "Resource name for the ruleset to get.\n\nFormat: `projects/{project_id}/rulesets/{ruleset_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/rulesets/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ], - "flatPath": "v1/projects/{projectsId}/rulesets/{rulesetsId}" - }, - "list": { - "path": "v1/{+name}/rulesets", - "id": "firebaserules.projects.rulesets.list", - "description": "List `Ruleset` metadata only and optionally filter the results by `Ruleset`\nname.\n\nThe full `Source` contents of a `Ruleset` may be retrieved with\nGetRuleset.", - "response": { - "$ref": "ListRulesetsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ], - "parameters": { - "filter": { - "location": "query", - "description": "`Ruleset` filter. The list method supports filters with restrictions on\n`Ruleset.name`.\n\nFilters on `Ruleset.create_time` should use the `date` function which\nparses strings that conform to the RFC 3339 date/time specifications.\n\nExample: `create_time \u003e date(\"2017-01-01\") AND name=UUID-*`", - "type": "string" - }, - "name": { - "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "Next page token for loading the next batch of `Ruleset` instances.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load less\nthan `page_size` due to the size of the output. To traverse all of the\nreleases, caller should iterate until the `page_token` is empty.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v1/projects/{projectsId}/rulesets" - } - } - }, - "releases": { - "methods": { - "update": { - "description": "Update a `Release`.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.", - "request": { - "$ref": "Release" - }, - "response": { - "$ref": "Release" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ], - "parameters": { - "name": { - "description": "Resource name for the `Release`.\n\n`Release` names may be structured `app1/prod/v2` or flat `app1_prod_v2`\nwhich affords developers a great deal of flexibility in mapping the name\nto the style that best fits their existing development practices. For\nexample, a name could refer to an environment, an app, a version, or some\ncombination of three.\n\nIn the table below, for the project name `projects/foo`, the following\nrelative release paths show how flat and structured names might be chosen\nto match a desired development / deployment strategy.\n\nUse Case | Flat Name | Structured Name\n-------------|---------------------|----------------\nEnvironments | releases/qa | releases/qa\nApps | releases/app1_qa | releases/app1/qa\nVersions | releases/app1_v2_qa | releases/app1/v2/qa\n\nThe delimiter between the release name path elements can be almost anything\nand it should work equally well with the release name list filter, but in\nmany ways the structured paths provide a clearer picture of the\nrelationship between `Release` instances.\n\nFormat: `projects/{project_id}/releases/{release_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/releases/.+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/releases/{releasesId}", - "path": "v1/{+name}", - "id": "firebaserules.projects.releases.update" - }, - "getExecutable": { - "id": "firebaserules.projects.releases.getExecutable", - "path": "v1/{+name}:getExecutable", - "description": "Get the `Release` executable to use when enforcing rules.", - "httpMethod": "GET", - "response": { - "$ref": "GetReleaseExecutableResponse" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/releases/.+$", - "location": "path", - "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`", - "required": true, - "type": "string" - }, - "executableVersion": { - "enum": [ - "RELEASE_EXECUTABLE_VERSION_UNSPECIFIED", - "FIREBASE_RULES_EXECUTABLE_V1", - "FIREBASE_RULES_EXECUTABLE_V2" - ], - "description": "The requested runtime executable version.\nDefaults to FIREBASE_RULES_EXECUTABLE_V1", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ], - "flatPath": "v1/projects/{projectsId}/releases/{releasesId}:getExecutable" - }, - "delete": { - "path": "v1/{+name}", - "id": "firebaserules.projects.releases.delete", - "description": "Delete a `Release` by resource name.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ], - "parameters": { - "name": { - "description": "Resource name for the `Release` to delete.\n\nFormat: `projects/{project_id}/releases/{release_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/releases/.+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/releases/{releasesId}" - }, - "list": { - "path": "v1/{+name}/releases", - "id": "firebaserules.projects.releases.list", - "description": "List the `Release` values for a project. This list may optionally be\nfiltered by `Release` name, `Ruleset` name, `TestSuite` name, or any\ncombination thereof.", - "response": { - "$ref": "ListReleasesResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Resource name for the project.\n\nFormat: `projects/{project_id}`", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "Next page token for the next batch of `Release` instances.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Page size to load. Maximum of 100. Defaults to 10.\nNote: `page_size` is just a hint and the service may choose to load fewer\nthan `page_size` results due to the size of the output. To traverse all of\nthe releases, the caller should iterate until the `page_token` on the\nresponse is empty.", - "format": "int32", - "type": "integer" - }, - "filter": { - "description": "`Release` filter. The list method supports filters with restrictions on the\n`Release.name`, `Release.ruleset_name`, and `Release.test_suite_name`.\n\nExample 1: A filter of 'name=prod*' might return `Release`s with names\nwithin 'projects/foo' prefixed with 'prod':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/uuid1234\nprojects/foo/releases/prod/v2 | projects/foo/rulesets/uuid8888\n\nExample 2: A filter of `name=prod* ruleset_name=uuid1234` would return only\n`Release` instances for 'projects/foo' with names prefixed with 'prod'\nreferring to the same `Ruleset` name of 'uuid1234':\n\nName | Ruleset Name\n------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/1234\nprojects/foo/releases/prod/v1 | projects/foo/rulesets/1234\n\nIn the examples, the filter parameters refer to the search filters are\nrelative to the project. Fully qualified prefixed may also be used. e.g.\n`test_suite_name=projects/foo/testsuites/uuid1`", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/projects/{projectsId}/releases" - }, - "create": { - "response": { - "$ref": "Release" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ], - "flatPath": "v1/projects/{projectsId}/releases", - "path": "v1/{+name}/releases", - "id": "firebaserules.projects.releases.create", - "request": { - "$ref": "Release" - }, - "description": "Create a `Release`.\n\nRelease names should reflect the developer's deployment practices. For\nexample, the release name may include the environment name, application\nname, application version, or any other name meaningful to the developer.\nOnce a `Release` refers to a `Ruleset`, the rules can be enforced by\nFirebase Rules-enabled services.\n\nMore than one `Release` may be 'live' concurrently. Consider the following\nthree `Release` names for `projects/foo` and the `Ruleset` to which they\nrefer.\n\nRelease Name | Ruleset Name\n--------------------------------|-------------\nprojects/foo/releases/prod | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/beta | projects/foo/rulesets/uuid123\nprojects/foo/releases/prod/v23 | projects/foo/rulesets/uuid456\n\nThe table reflects the `Ruleset` rollout in progress. The `prod` and\n`prod/beta` releases refer to the same `Ruleset`. However, `prod/v23`\nrefers to a new `Ruleset`. The `Ruleset` reference for a `Release` may be\nupdated using the UpdateRelease method." - }, - "patch": { - "id": "firebaserules.projects.releases.patch", - "path": "v1/{+name}", - "request": { - "$ref": "UpdateReleaseRequest" - }, - "description": "Update a `Release` via PATCH.\n\nOnly updates to the `ruleset_name` and `test_suite_name` fields will be\nhonored. `Release` rename is not supported. To create a `Release` use the\nCreateRelease method.", - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Release" - }, - "parameters": { - "name": { - "description": "Resource name for the project which owns this `Release`.\n\nFormat: `projects/{project_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/releases/.+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase" - ], - "flatPath": "v1/projects/{projectsId}/releases/{releasesId}" - }, - "get": { - "response": { - "$ref": "Release" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/firebase", - "https://www.googleapis.com/auth/firebase.readonly" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/releases/.+$", - "location": "path", - "description": "Resource name of the `Release`.\n\nFormat: `projects/{project_id}/releases/{release_id}`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/releases/{releasesId}", - "path": "v1/{+name}", - "id": "firebaserules.projects.releases.get", - "description": "Get a `Release` by name." - } - } - } - } - } - }, - "parameters": { - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "key": { - "location": "query", - "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.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - } - }, - "version": "v1", - "baseUrl": "https://firebaserules.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Creates and manages rules that determine when a Firebase Rules-enabled service should permit a request.\n", - "servicePath": "" + "protocol": "rest" }
diff --git a/firestore/v1beta1/firestore-api.json b/firestore/v1beta1/firestore-api.json index 32d6e04..4910049 100644 --- a/firestore/v1beta1/firestore-api.json +++ b/firestore/v1beta1/firestore-api.json
@@ -1,728 +1,9 @@ { - "rootUrl": "https://firestore.googleapis.com/", - "ownerDomain": "google.com", - "name": "firestore", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Firestore API", - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "databases": { - "resources": { - "documents": { - "methods": { - "write": { - "httpMethod": "POST", - "parameterOrder": [ - "database" - ], - "response": { - "$ref": "WriteResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "database": { - "location": "path", - "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\nThis is only required in the first message.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write", - "id": "firestore.projects.databases.documents.write", - "path": "v1beta1/{+database}/documents:write", - "description": "Streams batches of document updates and deletes, in order.", - "request": { - "$ref": "WriteRequest" - } - }, - "beginTransaction": { - "request": { - "$ref": "BeginTransactionRequest" - }, - "description": "Starts a new transaction.", - "response": { - "$ref": "BeginTransactionResponse" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "POST", - "parameters": { - "database": { - "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction", - "path": "v1beta1/{+database}/documents:beginTransaction", - "id": "firestore.projects.databases.documents.beginTransaction" - }, - "batchGet": { - "request": { - "$ref": "BatchGetDocumentsRequest" - }, - "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested.", - "response": { - "$ref": "BatchGetDocumentsResponse" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "POST", - "parameters": { - "database": { - "location": "path", - "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet", - "path": "v1beta1/{+database}/documents:batchGet", - "id": "firestore.projects.databases.documents.batchGet" - }, - "list": { - "response": { - "$ref": "ListDocumentsResponse" - }, - "parameterOrder": [ - "parent", - "collectionId" - ], - "httpMethod": "GET", - "parameters": { - "showMissing": { - "location": "query", - "description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.", - "type": "boolean" - }, - "pageToken": { - "description": "The `next_page_token` value returned from a previous List request, if any.", - "type": "string", - "location": "query" - }, - "mask.fieldPaths": { - "location": "query", - "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", - "type": "string", - "repeated": true - }, - "pageSize": { - "description": "The maximum number of documents to return.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "collectionId": { - "location": "path", - "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.", - "required": true, - "type": "string" - }, - "transaction": { - "description": "Reads documents in a transaction.", - "format": "byte", - "type": "string", - "location": "query" - }, - "parent": { - "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", - "location": "path" - }, - "readTime": { - "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.", - "format": "google-datetime", - "type": "string", - "location": "query" - }, - "orderBy": { - "description": "The order to sort results by. For example: `priority desc, name`.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}", - "path": "v1beta1/{+parent}/{collectionId}", - "id": "firestore.projects.databases.documents.list", - "description": "Lists documents." - }, - "runQuery": { - "response": { - "$ref": "RunQueryResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery", - "path": "v1beta1/{+parent}:runQuery", - "id": "firestore.projects.databases.documents.runQuery", - "request": { - "$ref": "RunQueryRequest" - }, - "description": "Runs a query." - }, - "createDocument": { - "httpMethod": "POST", - "parameterOrder": [ - "parent", - "collectionId" - ], - "response": { - "$ref": "Document" - }, - "parameters": { - "collectionId": { - "location": "path", - "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.", - "required": true, - "type": "string" - }, - "parent": { - "description": "The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$", - "location": "path" - }, - "documentId": { - "location": "query", - "description": "The client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.", - "type": "string" - }, - "mask.fieldPaths": { - "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", - "type": "string", - "repeated": true, - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}", - "id": "firestore.projects.databases.documents.createDocument", - "path": "v1beta1/{+parent}/{collectionId}", - "request": { - "$ref": "Document" - }, - "description": "Creates a new document." - }, - "listen": { - "response": { - "$ref": "ListenResponse" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "database": { - "location": "path", - "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen", - "path": "v1beta1/{+database}/documents:listen", - "id": "firestore.projects.databases.documents.listen", - "description": "Listens to changes.", - "request": { - "$ref": "ListenRequest" - } - }, - "patch": { - "request": { - "$ref": "Document" - }, - "description": "Updates or inserts a document.", - "response": { - "$ref": "Document" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "currentDocument.updateTime": { - "location": "query", - "description": "When set, the target document must exist and have been last updated at\nthat time.", - "format": "google-datetime", - "type": "string" - }, - "currentDocument.exists": { - "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.", - "type": "boolean", - "location": "query" - }, - "name": { - "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", - "location": "path" - }, - "updateMask.fieldPaths": { - "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", - "type": "string", - "repeated": true, - "location": "query" - }, - "mask.fieldPaths": { - "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", - "type": "string", - "repeated": true, - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", - "path": "v1beta1/{+name}", - "id": "firestore.projects.databases.documents.patch" - }, - "get": { - "description": "Gets a single document.", - "response": { - "$ref": "Document" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "transaction": { - "location": "query", - "description": "Reads the document in a transaction.", - "format": "byte", - "type": "string" - }, - "name": { - "description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", - "location": "path" - }, - "mask.fieldPaths": { - "location": "query", - "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", - "type": "string", - "repeated": true - }, - "readTime": { - "description": "Reads the version of the document at the given time.\nThis may not be older than 60 seconds.", - "format": "google-datetime", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", - "path": "v1beta1/{+name}", - "id": "firestore.projects.databases.documents.get" - }, - "listCollectionIds": { - "description": "Lists all the collection IDs underneath a document.", - "request": { - "$ref": "ListCollectionIdsRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ListCollectionIdsResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "parent": { - "description": "The parent document. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds", - "id": "firestore.projects.databases.documents.listCollectionIds", - "path": "v1beta1/{+parent}:listCollectionIds" - }, - "delete": { - "description": "Deletes a document.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "currentDocument.updateTime": { - "description": "When set, the target document must exist and have been last updated at\nthat time.", - "format": "google-datetime", - "type": "string", - "location": "query" - }, - "currentDocument.exists": { - "location": "query", - "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.", - "type": "boolean" - }, - "name": { - "location": "path", - "description": "The resource name of the Document to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", - "path": "v1beta1/{+name}", - "id": "firestore.projects.databases.documents.delete" - }, - "commit": { - "request": { - "$ref": "CommitRequest" - }, - "description": "Commits a transaction, while optionally updating documents.", - "httpMethod": "POST", - "parameterOrder": [ - "database" - ], - "response": { - "$ref": "CommitResponse" - }, - "parameters": { - "database": { - "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit", - "id": "firestore.projects.databases.documents.commit", - "path": "v1beta1/{+database}/documents:commit" - }, - "rollback": { - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback", - "path": "v1beta1/{+database}/documents:rollback", - "id": "firestore.projects.databases.documents.rollback", - "description": "Rolls back a transaction.", - "request": { - "$ref": "RollbackRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "database": { - "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$", - "location": "path" - } - } - } - } - }, - "indexes": { - "methods": { - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "name": { - "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}", - "id": "firestore.projects.databases.indexes.delete", - "path": "v1beta1/{+name}", - "description": "Deletes an index." - }, - "list": { - "description": "Lists the indexes that match the specified filters.", - "response": { - "$ref": "ListIndexesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "The standard List page size.", - "format": "int32", - "type": "integer" - }, - "parent": { - "location": "path", - "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$" - }, - "filter": { - "location": "query", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard List page token.", - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes", - "path": "v1beta1/{+parent}/indexes", - "id": "firestore.projects.databases.indexes.list" - }, - "get": { - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}", - "path": "v1beta1/{+name}", - "id": "firestore.projects.databases.indexes.get", - "description": "Gets an index.", - "response": { - "$ref": "Index" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ] - }, - "create": { - "description": "Creates the specified index.\nA newly created index's initial state is `CREATING`. On completion of the\nreturned google.longrunning.Operation, the state will be `READY`.\nIf the index already exists, the call will return an `ALREADY_EXISTS`\nstatus.\n\nDuring creation, the process could result in an error, in which case the\nindex will move to the `ERROR` state. The process can be recovered by\nfixing the data that caused the error, removing the index with\ndelete, then re-creating the index with\ncreate.\n\nIndexes with a single field cannot be created.", - "request": { - "$ref": "Index" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/datastore" - ], - "parameters": { - "parent": { - "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/databases/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes", - "path": "v1beta1/{+parent}/indexes", - "id": "firestore.projects.databases.indexes.create" - } - } - } - } - } - } - } - }, - "parameters": { - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - } - }, "version": "v1beta1", "baseUrl": "https://firestore.googleapis.com/", - "servicePath": "", - "description": "", "kind": "discovery#restDescription", + "description": "", + "servicePath": "", "basePath": "", "revision": "20171212", "documentationLink": "https://cloud.google.com/firestore", @@ -731,31 +12,23 @@ "version_module": true, "schemas": { "MapValue": { + "id": "MapValue", "description": "A map value.", "type": "object", "properties": { "fields": { - "description": "The map's fields.\n\nThe map keys represent field names. Field names matching the regular\nexpression `__.*__` are reserved. Reserved field names are forbidden except\nin certain documented contexts. The map keys, represented as UTF-8, must\nnot exceed 1,500 bytes and cannot be empty.", - "type": "object", "additionalProperties": { "$ref": "Value" - } + }, + "description": "The map's fields.\n\nThe map keys represent field names. Field names matching the regular\nexpression `__.*__` are reserved. Reserved field names are forbidden except\nin certain documented contexts. The map keys, represented as UTF-8, must\nnot exceed 1,500 bytes and cannot be empty.", + "type": "object" } - }, - "id": "MapValue" + } }, "DocumentDelete": { "description": "A Document has been deleted.\n\nMay be the result of multiple writes, including updates, the\nlast of which deleted the Document.\n\nMultiple DocumentDelete messages may be returned for the same logical\ndelete, if multiple targets are affected.", "type": "object", "properties": { - "removedTargetIds": { - "description": "A set of target IDs for targets that previously matched this entity.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, "document": { "description": "The resource name of the Document that was deleted.", "type": "string" @@ -764,11 +37,20 @@ "description": "The read timestamp at which the delete was observed.\n\nGreater or equal to the `commit_time` of the delete.", "format": "google-datetime", "type": "string" + }, + "removedTargetIds": { + "description": "A set of target IDs for targets that previously matched this entity.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } } }, "id": "DocumentDelete" }, "BeginTransactionResponse": { + "id": "BeginTransactionResponse", "description": "The response for Firestore.BeginTransaction.", "type": "object", "properties": { @@ -777,18 +59,16 @@ "format": "byte", "type": "string" } - }, - "id": "BeginTransactionResponse" + } }, "IndexField": { + "id": "IndexField", "description": "A field of an index.", "type": "object", "properties": { - "fieldPath": { - "description": "The path of the field. Must match the field path specification described\nby google.firestore.v1beta1.Document.fields.\nSpecial field path `__name__` may be used by itself or at the end of a\npath. `__type__` may be used only at the end of path.", - "type": "string" - }, "mode": { + "description": "The field's mode.", + "type": "string", "enumDescriptions": [ "The mode is unspecified.", "The field's values are indexed so as to support sequencing in\nascending order and also query by \u003c, \u003e, \u003c=, \u003e=, and =.", @@ -798,21 +78,19 @@ "MODE_UNSPECIFIED", "ASCENDING", "DESCENDING" - ], - "description": "The field's mode.", + ] + }, + "fieldPath": { + "description": "The path of the field. Must match the field path specification described\nby google.firestore.v1beta1.Document.fields.\nSpecial field path `__name__` may be used by itself or at the end of a\npath. `__type__` may be used only at the end of path.", "type": "string" } - }, - "id": "IndexField" + } }, "RunQueryResponse": { + "id": "RunQueryResponse", "description": "The response for Firestore.RunQuery.", "type": "object", "properties": { - "document": { - "description": "A query result.\nNot set when reporting partial progress.", - "$ref": "Document" - }, "readTime": { "description": "The time at which the document was read. This may be monotonically\nincreasing; in this case, the previous documents in the result stream are\nguaranteed not to have changed between their `read_time` and this one.\n\nIf the query returns no results, a response with `read_time` and no\n`document` will be sent, and this represents the time at which the query\nwas run.", "format": "google-datetime", @@ -827,11 +105,15 @@ "description": "The transaction that was started as part of this request.\nCan only be set in the first response, and only if\nRunQueryRequest.new_transaction was set in the request.\nIf set, no other fields will be set in this response.", "format": "byte", "type": "string" + }, + "document": { + "$ref": "Document", + "description": "A query result.\nNot set when reporting partial progress." } - }, - "id": "RunQueryResponse" + } }, "BeginTransactionRequest": { + "id": "BeginTransactionRequest", "description": "The request for Firestore.BeginTransaction.", "type": "object", "properties": { @@ -839,37 +121,32 @@ "description": "The options for the transaction.\nDefaults to a read-write transaction.", "$ref": "TransactionOptions" } - }, - "id": "BeginTransactionRequest" + } }, "CommitRequest": { "description": "The request for Firestore.Commit.", "type": "object", "properties": { - "transaction": { - "description": "If set, applies all writes in this transaction, and commits it.", - "format": "byte", - "type": "string" - }, "writes": { "description": "The writes to apply.\n\nAlways executed atomically and in order.", "type": "array", "items": { "$ref": "Write" } + }, + "transaction": { + "description": "If set, applies all writes in this transaction, and commits it.", + "format": "byte", + "type": "string" } }, "id": "CommitRequest" }, "ListenRequest": { + "id": "ListenRequest", "description": "A request for Firestore.Listen", "type": "object", "properties": { - "removeTarget": { - "description": "The ID of a target to remove from this stream.", - "format": "int32", - "type": "integer" - }, "addTarget": { "$ref": "Target", "description": "A target to add to this stream." @@ -880,21 +157,25 @@ "additionalProperties": { "type": "string" } + }, + "removeTarget": { + "description": "The ID of a target to remove from this stream.", + "format": "int32", + "type": "integer" } - }, - "id": "ListenRequest" + } }, "LatLng": { "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", "type": "object", "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "longitude": { + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "format": "double", "type": "number" }, - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "format": "double", "type": "number" } @@ -902,19 +183,19 @@ "id": "LatLng" }, "CollectionSelector": { + "id": "CollectionSelector", "description": "A selection of a collection, such as `messages as m1`.", "type": "object", "properties": { - "allDescendants": { - "description": "When false, selects only collections that are immediate children of\nthe `parent` specified in the containing `RunQueryRequest`.\nWhen true, selects all descendant collections.", - "type": "boolean" - }, "collectionId": { "description": "The collection ID.\nWhen set, selects only collections with this ID.", "type": "string" + }, + "allDescendants": { + "description": "When false, selects only collections that are immediate children of\nthe `parent` specified in the containing `RunQueryRequest`.\nWhen true, selects all descendant collections.", + "type": "boolean" } - }, - "id": "CollectionSelector" + } }, "ArrayValue": { "description": "An array value.", @@ -969,20 +250,10 @@ "id": "Index" }, "StructuredQuery": { + "id": "StructuredQuery", "description": "A Firestore query.", "type": "object", "properties": { - "orderBy": { - "description": "The order to apply to the query results.\n\nFirestore guarantees a stable ordering through the following rules:\n\n * Any field required to appear in `order_by`, that is not already\n specified in `order_by`, is appended to the order in field name order\n by default.\n * If an order on `__name__` is not specified, it is appended by default.\n\nFields are appended with the same sort direction as the last order\nspecified, or 'ASCENDING' if no order was specified. For example:\n\n * `SELECT * FROM Foo ORDER BY A` becomes\n `SELECT * FROM Foo ORDER BY A, __name__`\n * `SELECT * FROM Foo ORDER BY A DESC` becomes\n `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`\n * `SELECT * FROM Foo WHERE A \u003e 1` becomes\n `SELECT * FROM Foo WHERE A \u003e 1 ORDER BY A, __name__`", - "type": "array", - "items": { - "$ref": "Order" - } - }, - "select": { - "$ref": "Projection", - "description": "The projection to return." - }, "limit": { "description": "The maximum number of results to return.\n\nApplies after all other constraints.\nMust be \u003e= 0 if specified.", "format": "int32", @@ -1001,28 +272,34 @@ } }, "endAt": { - "$ref": "Cursor", - "description": "A end point for the query results." + "description": "A end point for the query results.", + "$ref": "Cursor" }, "startAt": { - "$ref": "Cursor", - "description": "A starting point for the query results." + "description": "A starting point for the query results.", + "$ref": "Cursor" }, "where": { - "$ref": "Filter", - "description": "The filter to apply." + "description": "The filter to apply.", + "$ref": "Filter" + }, + "orderBy": { + "description": "The order to apply to the query results.\n\nFirestore guarantees a stable ordering through the following rules:\n\n * Any field required to appear in `order_by`, that is not already\n specified in `order_by`, is appended to the order in field name order\n by default.\n * If an order on `__name__` is not specified, it is appended by default.\n\nFields are appended with the same sort direction as the last order\nspecified, or 'ASCENDING' if no order was specified. For example:\n\n * `SELECT * FROM Foo ORDER BY A` becomes\n `SELECT * FROM Foo ORDER BY A, __name__`\n * `SELECT * FROM Foo ORDER BY A DESC` becomes\n `SELECT * FROM Foo ORDER BY A DESC, __name__ DESC`\n * `SELECT * FROM Foo WHERE A \u003e 1` becomes\n `SELECT * FROM Foo WHERE A \u003e 1 ORDER BY A, __name__`", + "type": "array", + "items": { + "$ref": "Order" + } + }, + "select": { + "$ref": "Projection", + "description": "The projection to return." } - }, - "id": "StructuredQuery" + } }, "UnaryFilter": { "description": "A filter with a single operand.", "type": "object", "properties": { - "field": { - "description": "The field to which to apply the operator.", - "$ref": "FieldReference" - }, "op": { "description": "The unary operator to apply.", "type": "string", @@ -1036,6 +313,10 @@ "IS_NAN", "IS_NULL" ] + }, + "field": { + "$ref": "FieldReference", + "description": "The field to which to apply the operator." } }, "id": "UnaryFilter" @@ -1044,25 +325,60 @@ "description": "A filter.", "type": "object", "properties": { - "fieldFilter": { - "$ref": "FieldFilter", - "description": "A filter on a document field." - }, "unaryFilter": { - "description": "A filter that takes exactly one argument.", - "$ref": "UnaryFilter" + "$ref": "UnaryFilter", + "description": "A filter that takes exactly one argument." }, "compositeFilter": { "$ref": "CompositeFilter", "description": "A composite filter." + }, + "fieldFilter": { + "$ref": "FieldFilter", + "description": "A filter on a document field." } }, "id": "Filter" }, + "WriteRequest": { + "id": "WriteRequest", + "description": "The request for Firestore.Write.\n\nThe first request creates a stream, or resumes an existing one from a token.\n\nWhen creating a new stream, the server replies with a response containing\nonly an ID and a token, to use in the next request.\n\nWhen resuming a stream, the server first streams any responses later than the\ngiven token, then a response containing only an up-to-date token, to use in\nthe next request.", + "type": "object", + "properties": { + "writes": { + "description": "The writes to apply.\n\nAlways executed atomically and in order.\nThis must be empty on the first request.\nThis may be empty on the last request.\nThis must not be empty on all other requests.", + "type": "array", + "items": { + "$ref": "Write" + } + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with this write request.", + "type": "object" + }, + "streamId": { + "description": "The ID of the write stream to resume.\nThis may only be set in the first message. When left empty, a new write\nstream will be created.", + "type": "string" + }, + "streamToken": { + "description": "A stream token that was previously sent by the server.\n\nThe client should set this field to the token from the most recent\nWriteResponse it has received. This acknowledges that the client has\nreceived responses up to this token. After sending this token, earlier\ntokens may not be used anymore.\n\nThe server may close the stream if there are too many unacknowledged\nresponses.\n\nLeave this field unset when creating a new stream. To resume a stream at\na specific point, set this field and the `stream_id` field.\n\nLeave this field unset when creating a new stream.", + "format": "byte", + "type": "string" + } + } + }, "BatchGetDocumentsResponse": { "description": "The streamed response for Firestore.BatchGetDocuments.", "type": "object", "properties": { + "readTime": { + "description": "The time at which the document was read.\nThis may be monotically increasing, in this case the previous documents in\nthe result stream are guaranteed not to have changed between their\nread_time and this one.", + "format": "google-datetime", + "type": "string" + }, "found": { "description": "A document that was requested.", "$ref": "Document" @@ -1075,53 +391,14 @@ "description": "The transaction that was started as part of this request.\nWill only be set in the first response, and only if\nBatchGetDocumentsRequest.new_transaction was set in the request.", "format": "byte", "type": "string" - }, - "readTime": { - "description": "The time at which the document was read.\nThis may be monotically increasing, in this case the previous documents in\nthe result stream are guaranteed not to have changed between their\nread_time and this one.", - "format": "google-datetime", - "type": "string" } }, "id": "BatchGetDocumentsResponse" }, - "WriteRequest": { - "description": "The request for Firestore.Write.\n\nThe first request creates a stream, or resumes an existing one from a token.\n\nWhen creating a new stream, the server replies with a response containing\nonly an ID and a token, to use in the next request.\n\nWhen resuming a stream, the server first streams any responses later than the\ngiven token, then a response containing only an up-to-date token, to use in\nthe next request.", - "type": "object", - "properties": { - "streamId": { - "description": "The ID of the write stream to resume.\nThis may only be set in the first message. When left empty, a new write\nstream will be created.", - "type": "string" - }, - "streamToken": { - "description": "A stream token that was previously sent by the server.\n\nThe client should set this field to the token from the most recent\nWriteResponse it has received. This acknowledges that the client has\nreceived responses up to this token. After sending this token, earlier\ntokens may not be used anymore.\n\nThe server may close the stream if there are too many unacknowledged\nresponses.\n\nLeave this field unset when creating a new stream. To resume a stream at\na specific point, set this field and the `stream_id` field.\n\nLeave this field unset when creating a new stream.", - "format": "byte", - "type": "string" - }, - "writes": { - "description": "The writes to apply.\n\nAlways executed atomically and in order.\nThis must be empty on the first request.\nThis may be empty on the last request.\nThis must not be empty on all other requests.", - "type": "array", - "items": { - "$ref": "Write" - } - }, - "labels": { - "description": "Labels associated with this write request.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "id": "WriteRequest" - }, "Target": { "description": "A specification of a set of documents to listen to.", "type": "object", "properties": { - "documents": { - "$ref": "DocumentsTarget", - "description": "A target specified by a set of document names." - }, "query": { "description": "A target specified by a query.", "$ref": "QueryTarget" @@ -1144,32 +421,14 @@ "description": "A client provided target ID.\n\nIf not set, the server will assign an ID for the target.\n\nUsed for resuming a target without changing IDs. The IDs can either be\nclient-assigned or be server-assigned in a previous stream. All targets\nwith client provided IDs must be added before adding a target that needs\na server-assigned id.", "format": "int32", "type": "integer" + }, + "documents": { + "$ref": "DocumentsTarget", + "description": "A target specified by a set of document names." } }, "id": "Target" }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "Precondition": { - "description": "A precondition on a document, used for conditional operations.", - "type": "object", - "properties": { - "updateTime": { - "description": "When set, the target document must exist and have been last updated at\nthat time.", - "format": "google-datetime", - "type": "string" - }, - "exists": { - "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.", - "type": "boolean" - } - }, - "id": "Precondition" - }, "RunQueryRequest": { "description": "The request for Firestore.RunQuery.", "type": "object", @@ -1184,8 +443,8 @@ "type": "string" }, "newTransaction": { - "$ref": "TransactionOptions", - "description": "Starts a new transaction and reads the documents.\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream." + "description": "Starts a new transaction and reads the documents.\nDefaults to a read-only transaction.\nThe new transaction ID will be returned as the first response in the\nstream.", + "$ref": "TransactionOptions" }, "transaction": { "description": "Reads documents in a transaction.", @@ -1195,25 +454,48 @@ }, "id": "RunQueryRequest" }, + "Precondition": { + "description": "A precondition on a document, used for conditional operations.", + "type": "object", + "properties": { + "exists": { + "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.", + "type": "boolean" + }, + "updateTime": { + "description": "When set, the target document must exist and have been last updated at\nthat time.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "Precondition" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, "ListIndexesResponse": { "description": "The response for FirestoreAdmin.ListIndexes.", "type": "object", "properties": { - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - }, "indexes": { "description": "The indexes.", "type": "array", "items": { "$ref": "Index" } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" } }, "id": "ListIndexesResponse" }, "TransactionOptions": { + "id": "TransactionOptions", "description": "Options for creating a new transaction.", "type": "object", "properties": { @@ -1225,31 +507,23 @@ "description": "The transaction can be used for both read and write operations.", "$ref": "ReadWrite" } - }, - "id": "TransactionOptions" + } }, "FieldReference": { + "id": "FieldReference", "description": "A reference to a field, such as `max(messages.time) as max_time`.", "type": "object", "properties": { "fieldPath": { "type": "string" } - }, - "id": "FieldReference" + } }, "ListenResponse": { + "id": "ListenResponse", "description": "The response for Firestore.Listen.", "type": "object", "properties": { - "filter": { - "description": "A filter to apply to the set of documents previously returned for the\ngiven target.\n\nReturned when documents may have been removed from the given target, but\nthe exact documents are unknown.", - "$ref": "ExistenceFilter" - }, - "documentChange": { - "description": "A Document has changed.", - "$ref": "DocumentChange" - }, "targetChange": { "$ref": "TargetChange", "description": "Targets have changed." @@ -1261,11 +535,19 @@ "documentDelete": { "description": "A Document has been deleted.", "$ref": "DocumentDelete" + }, + "filter": { + "$ref": "ExistenceFilter", + "description": "A filter to apply to the set of documents previously returned for the\ngiven target.\n\nReturned when documents may have been removed from the given target, but\nthe exact documents are unknown." + }, + "documentChange": { + "$ref": "DocumentChange", + "description": "A Document has changed." } - }, - "id": "ListenResponse" + } }, "ListCollectionIdsRequest": { + "id": "ListCollectionIdsRequest", "description": "The request for Firestore.ListCollectionIds.", "type": "object", "properties": { @@ -1278,20 +560,19 @@ "format": "int32", "type": "integer" } - }, - "id": "ListCollectionIdsRequest" + } }, "ExistenceFilter": { "description": "A digest of all the documents that match a given target.", "type": "object", "properties": { - "targetId": { - "description": "The target ID to which this filter applies.", + "count": { + "description": "The total count of documents that match target_id.\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target.", "format": "int32", "type": "integer" }, - "count": { - "description": "The total count of documents that match target_id.\n\nIf different from the count of documents in the client that match, the\nclient must manually determine which documents no longer match the target.", + "targetId": { + "description": "The target ID to which this filter applies.", "format": "int32", "type": "integer" } @@ -1311,6 +592,7 @@ "id": "ReadOnly" }, "WriteResult": { + "id": "WriteResult", "description": "The result of applying a write.", "type": "object", "properties": { @@ -1326,26 +608,22 @@ "$ref": "Value" } } - }, - "id": "WriteResult" + } }, "Value": { + "id": "Value", "description": "A message that can hold any of the supported value types.", "type": "object", "properties": { - "mapValue": { - "description": "A map value.", - "$ref": "MapValue" + "geoPointValue": { + "$ref": "LatLng", + "description": "A geo point value representing a point on the surface of Earth." }, "bytesValue": { "description": "A bytes value.\n\nMust not exceed 1 MiB - 89 bytes.\nOnly the first 1,500 bytes are considered by queries.", "format": "byte", "type": "string" }, - "geoPointValue": { - "$ref": "LatLng", - "description": "A geo point value representing a point on the surface of Earth." - }, "integerValue": { "description": "An integer value.", "format": "int64", @@ -1360,8 +638,8 @@ "type": "string" }, "arrayValue": { - "description": "An array value.\n\nCannot contain another array value.", - "$ref": "ArrayValue" + "$ref": "ArrayValue", + "description": "An array value.\n\nCannot contain another array value." }, "doubleValue": { "description": "A double value.", @@ -1373,6 +651,10 @@ "format": "google-datetime", "type": "string" }, + "booleanValue": { + "description": "A boolean value.", + "type": "boolean" + }, "nullValue": { "enumDescriptions": [ "Null value." @@ -1383,38 +665,20 @@ "description": "A null value.", "type": "string" }, - "booleanValue": { - "description": "A boolean value.", - "type": "boolean" + "mapValue": { + "description": "A map value.", + "$ref": "MapValue" } - }, - "id": "Value" - }, - "Cursor": { - "description": "A position in a query result set.", - "type": "object", - "properties": { - "before": { - "description": "If the position is just before or just after the given values, relative\nto the sort order defined by the query.", - "type": "boolean" - }, - "values": { - "description": "The values that represent a position, in the order they appear in\nthe order by clause of a query.\n\nCan contain fewer values than specified in the order by clause.", - "type": "array", - "items": { - "$ref": "Value" - } - } - }, - "id": "Cursor" + } }, "Write": { + "id": "Write", "description": "A write on a document.", "type": "object", "properties": { "transform": { - "$ref": "DocumentTransform", - "description": "Applies a tranformation to a document.\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest." + "description": "Applies a tranformation to a document.\nAt most one `transform` per document is allowed in a given request.\nAn `update` cannot follow a `transform` on the same document in a given\nrequest.", + "$ref": "DocumentTransform" }, "delete": { "description": "A document name to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", @@ -1425,15 +689,32 @@ "$ref": "DocumentMask" }, "currentDocument": { - "$ref": "Precondition", - "description": "An optional precondition on the document.\n\nThe write will fail if this is set and not met by the target document." + "description": "An optional precondition on the document.\n\nThe write will fail if this is set and not met by the target document.", + "$ref": "Precondition" }, "update": { - "$ref": "Document", - "description": "A document to write." + "description": "A document to write.", + "$ref": "Document" } - }, - "id": "Write" + } + }, + "Cursor": { + "id": "Cursor", + "description": "A position in a query result set.", + "type": "object", + "properties": { + "values": { + "description": "The values that represent a position, in the order they appear in\nthe order by clause of a query.\n\nCan contain fewer values than specified in the order by clause.", + "type": "array", + "items": { + "$ref": "Value" + } + }, + "before": { + "description": "If the position is just before or just after the given values, relative\nto the sort order defined by the query.", + "type": "boolean" + } + } }, "ReadWrite": { "description": "Options for a transaction that can be used to read and write documents.", @@ -1479,28 +760,44 @@ }, "id": "BatchGetDocumentsRequest" }, - "QueryTarget": { - "description": "A target specified by a query.", + "DocumentChange": { + "description": "A Document has changed.\n\nMay be the result of multiple writes, including deletes, that\nultimately resulted in a new value for the Document.\n\nMultiple DocumentChange messages may be returned for the same logical\nchange, if multiple targets are affected.", "type": "object", "properties": { - "structuredQuery": { - "description": "A structured query.", - "$ref": "StructuredQuery" + "removedTargetIds": { + "description": "A set of target IDs for targets that no longer match this document.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } }, - "parent": { - "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", - "type": "string" + "document": { + "$ref": "Document", + "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added." + }, + "targetIds": { + "description": "A set of target IDs of targets that match this document.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } } }, - "id": "QueryTarget" + "id": "DocumentChange" }, "Operation": { "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "properties": { + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", @@ -1521,50 +818,30 @@ }, "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" } }, "id": "Operation" }, - "DocumentChange": { - "description": "A Document has changed.\n\nMay be the result of multiple writes, including deletes, that\nultimately resulted in a new value for the Document.\n\nMultiple DocumentChange messages may be returned for the same logical\nchange, if multiple targets are affected.", + "QueryTarget": { + "description": "A target specified by a query.", "type": "object", "properties": { - "document": { - "$ref": "Document", - "description": "The new state of the Document.\n\nIf `mask` is set, contains only fields that were updated or added." + "parent": { + "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", + "type": "string" }, - "targetIds": { - "description": "A set of target IDs of targets that match this document.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "removedTargetIds": { - "description": "A set of target IDs for targets that no longer match this document.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } + "structuredQuery": { + "$ref": "StructuredQuery", + "description": "A structured query." } }, - "id": "DocumentChange" + "id": "QueryTarget" }, "Status": { + "id": "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.", "type": "object", "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" @@ -1573,40 +850,44 @@ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "type": "object" } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" } - }, - "id": "Status" + } }, "Document": { "description": "A Firestore document.\n\nMust not exceed 1 MiB - 4 bytes.", "type": "object", "properties": { + "name": { + "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", + "type": "string" + }, "createTime": { "description": "Output only. The time at which the document was created.\n\nThis value increases monotonically when a document is deleted then\nrecreated. It can also be compared to values from other documents and\nthe `read_time` of a query.", "format": "google-datetime", "type": "string" }, "fields": { + "description": "The document's fields.\n\nThe map keys represent field names.\n\nA simple field name contains only characters `a` to `z`, `A` to `Z`,\n`0` to `9`, or `_`, and must not start with `0` to `9`. For example,\n`foo_bar_17`.\n\nField names matching the regular expression `__.*__` are reserved. Reserved\nfield names are forbidden except in certain documented contexts. The map\nkeys, represented as UTF-8, must not exceed 1,500 bytes and cannot be\nempty.\n\nField paths may be used in other contexts to refer to structured fields\ndefined here. For `map_value`, the field path is represented by the simple\nor quoted field names of the containing fields, delimited by `.`. For\nexample, the structured field\n`\"foo\" : { map_value: { \"x&y\" : { string_value: \"hello\" }}}` would be\nrepresented by the field path `foo.x&y`.\n\nWithin a field path, a quoted field name starts and ends with `` ` `` and\nmay contain any character. Some characters, including `` ` ``, must be\nescaped using a `\\`. For example, `` `x&y` `` represents `x&y` and\n`` `bak\\`tik` `` represents `` bak`tik ``.", + "type": "object", "additionalProperties": { "$ref": "Value" - }, - "description": "The document's fields.\n\nThe map keys represent field names.\n\nA simple field name contains only characters `a` to `z`, `A` to `Z`,\n`0` to `9`, or `_`, and must not start with `0` to `9`. For example,\n`foo_bar_17`.\n\nField names matching the regular expression `__.*__` are reserved. Reserved\nfield names are forbidden except in certain documented contexts. The map\nkeys, represented as UTF-8, must not exceed 1,500 bytes and cannot be\nempty.\n\nField paths may be used in other contexts to refer to structured fields\ndefined here. For `map_value`, the field path is represented by the simple\nor quoted field names of the containing fields, delimited by `.`. For\nexample, the structured field\n`\"foo\" : { map_value: { \"x&y\" : { string_value: \"hello\" }}}` would be\nrepresented by the field path `foo.x&y`.\n\nWithin a field path, a quoted field name starts and ends with `` ` `` and\nmay contain any character. Some characters, including `` ` ``, must be\nescaped using a `\\`. For example, `` `x&y` `` represents `x&y` and\n`` `bak\\`tik` `` represents `` bak`tik ``.", - "type": "object" + } }, "updateTime": { "description": "Output only. The time at which the document was last changed.\n\nThis value is initally set to the `create_time` then increases\nmonotonically with each change to the document. It can also be\ncompared to values from other documents and the `read_time` of a query.", "format": "google-datetime", "type": "string" - }, - "name": { - "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", - "type": "string" } }, "id": "Document" @@ -1629,6 +910,11 @@ "description": "A Document has been removed from the view of the targets.\n\nSent if the document is no longer relevant to a target and is out of view.\nCan be sent instead of a DocumentDelete or a DocumentChange if the server\ncan not send the new value of the document.\n\nMultiple DocumentRemove messages may be returned for the same logical\nwrite or delete, if multiple targets are affected.", "type": "object", "properties": { + "readTime": { + "description": "The read timestamp at which the remove was observed.\n\nGreater or equal to the `commit_time` of the change/delete/remove.", + "format": "google-datetime", + "type": "string" + }, "removedTargetIds": { "description": "A set of target IDs for targets that previously matched this document.", "type": "array", @@ -1640,16 +926,12 @@ "document": { "description": "The resource name of the Document that has gone out of view.", "type": "string" - }, - "readTime": { - "description": "The read timestamp at which the remove was observed.\n\nGreater or equal to the `commit_time` of the change/delete/remove.", - "format": "google-datetime", - "type": "string" } }, "id": "DocumentRemove" }, "ListDocumentsResponse": { + "id": "ListDocumentsResponse", "description": "The response for Firestore.ListDocuments.", "type": "object", "properties": { @@ -1664,8 +946,7 @@ "description": "The next page token.", "type": "string" } - }, - "id": "ListDocumentsResponse" + } }, "RollbackRequest": { "description": "The request for Firestore.Rollback.", @@ -1680,6 +961,7 @@ "id": "RollbackRequest" }, "CompositeFilter": { + "id": "CompositeFilter", "description": "A filter that merges multiple other filters using the given operator.", "type": "object", "properties": { @@ -1702,8 +984,7 @@ "description": "The operator for combining multiple filters.", "type": "string" } - }, - "id": "CompositeFilter" + } }, "DocumentsTarget": { "description": "A target specified by a set of documents names.", @@ -1752,12 +1033,11 @@ "id": "DocumentTransform" }, "FieldTransform": { + "id": "FieldTransform", "description": "A transformation of a field of the document.", "type": "object", "properties": { "setToServerValue": { - "description": "Sets the field to the given server value.", - "type": "string", "enumDescriptions": [ "Unspecified. This value must not be used.", "The time at which the server processed the request, with millisecond\nprecision." @@ -1765,14 +1045,33 @@ "enum": [ "SERVER_VALUE_UNSPECIFIED", "REQUEST_TIME" - ] + ], + "description": "Sets the field to the given server value.", + "type": "string" }, "fieldPath": { "description": "The path of the field. See Document.fields for the field path syntax\nreference.", "type": "string" } - }, - "id": "FieldTransform" + } + }, + "ListCollectionIdsResponse": { + "id": "ListCollectionIdsResponse", + "description": "The response from Firestore.ListCollectionIds.", + "type": "object", + "properties": { + "collectionIds": { + "description": "The collection ids.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextPageToken": { + "description": "A page token that may be used to continue the list.", + "type": "string" + } + } }, "CommitResponse": { "description": "The response for Firestore.Commit.", @@ -1793,28 +1092,18 @@ }, "id": "CommitResponse" }, - "ListCollectionIdsResponse": { - "description": "The response from Firestore.ListCollectionIds.", - "type": "object", - "properties": { - "collectionIds": { - "description": "The collection ids.", - "type": "array", - "items": { - "type": "string" - } - }, - "nextPageToken": { - "description": "A page token that may be used to continue the list.", - "type": "string" - } - }, - "id": "ListCollectionIdsResponse" - }, "WriteResponse": { + "id": "WriteResponse", "description": "The response for Firestore.Write.", "type": "object", "properties": { + "writeResults": { + "description": "The result of applying the writes.\n\nThis i-th write result corresponds to the i-th write in the\nrequest.", + "type": "array", + "items": { + "$ref": "WriteResult" + } + }, "streamId": { "description": "The ID of the stream.\nOnly set on the first message, when a new stream was created.", "type": "string" @@ -1828,24 +1117,15 @@ "description": "A token that represents the position of this response in the stream.\nThis can be used by a client to resume the stream at this point.\n\nThis field is always set.", "format": "byte", "type": "string" - }, - "writeResults": { - "description": "The result of applying the writes.\n\nThis i-th write result corresponds to the i-th write in the\nrequest.", - "type": "array", - "items": { - "$ref": "WriteResult" - } } - }, - "id": "WriteResponse" + } }, "Order": { + "id": "Order", "description": "An order on a field.", "type": "object", "properties": { "direction": { - "description": "The direction to order by. Defaults to `ASCENDING`.", - "type": "string", "enumDescriptions": [ "Unspecified.", "Ascending.", @@ -1855,30 +1135,25 @@ "DIRECTION_UNSPECIFIED", "ASCENDING", "DESCENDING" - ] + ], + "description": "The direction to order by. Defaults to `ASCENDING`.", + "type": "string" }, "field": { - "$ref": "FieldReference", - "description": "The field to order by." + "description": "The field to order by.", + "$ref": "FieldReference" } - }, - "id": "Order" + } }, "FieldFilter": { "description": "A filter on a specific field.", "type": "object", "properties": { - "field": { - "description": "The field to filter by.", - "$ref": "FieldReference" - }, "value": { "$ref": "Value", "description": "The value to compare to." }, "op": { - "description": "The operator to filter by.", - "type": "string", "enumDescriptions": [ "Unspecified. This value must not be used.", "Less than. Requires that the field come first in `order_by`.", @@ -1894,16 +1169,34 @@ "GREATER_THAN", "GREATER_THAN_OR_EQUAL", "EQUAL" - ] + ], + "description": "The operator to filter by.", + "type": "string" + }, + "field": { + "description": "The field to filter by.", + "$ref": "FieldReference" } }, "id": "FieldFilter" }, "TargetChange": { + "id": "TargetChange", "description": "Targets being watched have changed.", "type": "object", "properties": { + "cause": { + "description": "The error that resulted in this change, if applicable.", + "$ref": "Status" + }, + "readTime": { + "description": "The consistent `read_time` for the given `target_ids` (omitted when the\ntarget_ids are not at a consistent snapshot).\n\nThe stream is guaranteed to send a `read_time` with `target_ids` empty\nwhenever the entire stream reaches a new consistent snapshot. ADD,\nCURRENT, and RESET messages are guaranteed to (eventually) result in a\nnew consistent snapshot (while NO_CHANGE and REMOVE messages are not).\n\nFor a given stream, `read_time` is guaranteed to be monotonically\nincreasing.", + "format": "google-datetime", + "type": "string" + }, "targetChangeType": { + "description": "The type of change that occurred.", + "type": "string", "enumDescriptions": [ "No change has occurred. Used only to send an updated `resume_token`.", "The targets have been added.", @@ -1917,9 +1210,7 @@ "REMOVE", "CURRENT", "RESET" - ], - "description": "The type of change that occurred.", - "type": "string" + ] }, "resumeToken": { "description": "A token that can be used to resume the stream for the given `target_ids`,\nor all targets if `target_ids` is empty.\n\nNot set on every target change.", @@ -1933,24 +1224,14 @@ "format": "int32", "type": "integer" } - }, - "cause": { - "description": "The error that resulted in this change, if applicable.", - "$ref": "Status" - }, - "readTime": { - "description": "The consistent `read_time` for the given `target_ids` (omitted when the\ntarget_ids are not at a consistent snapshot).\n\nThe stream is guaranteed to send a `read_time` with `target_ids` empty\nwhenever the entire stream reaches a new consistent snapshot. ADD,\nCURRENT, and RESET messages are guaranteed to (eventually) result in a\nnew consistent snapshot (while NO_CHANGE and REMOVE messages are not).\n\nFor a given stream, `read_time` is guaranteed to be monotonically\nincreasing.", - "format": "google-datetime", - "type": "string" } - }, - "id": "TargetChange" + } } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Firestore", "auth": { @@ -1964,5 +1245,724 @@ } } } + }, + "rootUrl": "https://firestore.googleapis.com/", + "ownerDomain": "google.com", + "name": "firestore", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Cloud Firestore API", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "databases": { + "resources": { + "documents": { + "methods": { + "write": { + "response": { + "$ref": "WriteResponse" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "database": { + "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.\nThis is only required in the first message.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:write", + "path": "v1beta1/{+database}/documents:write", + "id": "firestore.projects.databases.documents.write", + "description": "Streams batches of document updates and deletes, in order.", + "request": { + "$ref": "WriteRequest" + } + }, + "beginTransaction": { + "description": "Starts a new transaction.", + "request": { + "$ref": "BeginTransactionRequest" + }, + "response": { + "$ref": "BeginTransactionResponse" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "database": { + "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:beginTransaction", + "path": "v1beta1/{+database}/documents:beginTransaction", + "id": "firestore.projects.databases.documents.beginTransaction" + }, + "batchGet": { + "response": { + "$ref": "BatchGetDocumentsResponse" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "parameters": { + "database": { + "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:batchGet", + "path": "v1beta1/{+database}/documents:batchGet", + "id": "firestore.projects.databases.documents.batchGet", + "request": { + "$ref": "BatchGetDocumentsRequest" + }, + "description": "Gets multiple documents.\n\nDocuments returned by this method are not guaranteed to be returned in the\nsame order that they were requested." + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "parent", + "collectionId" + ], + "response": { + "$ref": "ListDocumentsResponse" + }, + "parameters": { + "mask.fieldPaths": { + "repeated": true, + "location": "query", + "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The `next_page_token` value returned from a previous List request, if any.", + "type": "string" + }, + "collectionId": { + "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`\nor `messages`.", + "required": true, + "type": "string", + "location": "path" + }, + "pageSize": { + "description": "The maximum number of documents to return.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "transaction": { + "description": "Reads documents in a transaction.", + "format": "byte", + "type": "string", + "location": "query" + }, + "parent": { + "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", + "location": "path" + }, + "orderBy": { + "location": "query", + "description": "The order to sort results by. For example: `priority desc, name`.", + "type": "string" + }, + "readTime": { + "description": "Reads documents as they were at the given time.\nThis may not be older than 60 seconds.", + "format": "google-datetime", + "type": "string", + "location": "query" + }, + "showMissing": { + "description": "If the list should show missing documents. A missing document is a\ndocument that does not exist but has sub-documents. These documents will\nbe returned with a key but will not have fields, Document.create_time,\nor Document.update_time set.\n\nRequests with `show_missing` may not specify `where` or\n`order_by`.", + "type": "boolean", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}/{collectionId}", + "id": "firestore.projects.databases.documents.list", + "path": "v1beta1/{+parent}/{collectionId}", + "description": "Lists documents." + }, + "runQuery": { + "parameters": { + "parent": { + "description": "The parent resource name. In the format:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents` or\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:runQuery", + "id": "firestore.projects.databases.documents.runQuery", + "path": "v1beta1/{+parent}:runQuery", + "request": { + "$ref": "RunQueryRequest" + }, + "description": "Runs a query.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "RunQueryResponse" + } + }, + "createDocument": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "parent": { + "description": "The parent resource. For example:\n`projects/{project_id}/databases/{database_id}/documents` or\n`projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+/documents/.+$", + "location": "path" + }, + "documentId": { + "location": "query", + "description": "The client-assigned document ID to use for this document.\n\nOptional. If not specified, an ID will be assigned by the service.", + "type": "string" + }, + "mask.fieldPaths": { + "repeated": true, + "location": "query", + "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", + "type": "string" + }, + "collectionId": { + "location": "path", + "description": "The collection ID, relative to `parent`, to list. For example: `chatrooms`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{collectionId}", + "path": "v1beta1/{+parent}/{collectionId}", + "id": "firestore.projects.databases.documents.createDocument", + "description": "Creates a new document.", + "request": { + "$ref": "Document" + }, + "response": { + "$ref": "Document" + }, + "parameterOrder": [ + "parent", + "collectionId" + ], + "httpMethod": "POST" + }, + "listen": { + "path": "v1beta1/{+database}/documents:listen", + "id": "firestore.projects.databases.documents.listen", + "request": { + "$ref": "ListenRequest" + }, + "description": "Listens to changes.", + "response": { + "$ref": "ListenResponse" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "parameters": { + "database": { + "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:listen" + }, + "patch": { + "parameters": { + "name": { + "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", + "location": "path", + "description": "The resource name of the document, for example\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", + "required": true, + "type": "string" + }, + "updateMask.fieldPaths": { + "repeated": true, + "location": "query", + "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", + "type": "string" + }, + "mask.fieldPaths": { + "repeated": true, + "location": "query", + "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", + "type": "string" + }, + "currentDocument.updateTime": { + "description": "When set, the target document must exist and have been last updated at\nthat time.", + "format": "google-datetime", + "type": "string", + "location": "query" + }, + "currentDocument.exists": { + "location": "query", + "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.", + "type": "boolean" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", + "path": "v1beta1/{+name}", + "id": "firestore.projects.databases.documents.patch", + "request": { + "$ref": "Document" + }, + "description": "Updates or inserts a document.", + "response": { + "$ref": "Document" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH" + }, + "get": { + "path": "v1beta1/{+name}", + "id": "firestore.projects.databases.documents.get", + "description": "Gets a single document.", + "response": { + "$ref": "Document" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", + "location": "path", + "description": "The resource name of the Document to get. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", + "required": true, + "type": "string" + }, + "mask.fieldPaths": { + "repeated": true, + "location": "query", + "description": "The list of field paths in the mask. See Document.fields for a field\npath syntax reference.", + "type": "string" + }, + "readTime": { + "description": "Reads the version of the document at the given time.\nThis may not be older than 60 seconds.", + "format": "google-datetime", + "type": "string", + "location": "query" + }, + "transaction": { + "location": "query", + "description": "Reads the document in a transaction.", + "format": "byte", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}" + }, + "commit": { + "path": "v1beta1/{+database}/documents:commit", + "id": "firestore.projects.databases.documents.commit", + "request": { + "$ref": "CommitRequest" + }, + "description": "Commits a transaction, while optionally updating documents.", + "response": { + "$ref": "CommitResponse" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "parameters": { + "database": { + "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:commit" + }, + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", + "location": "path", + "description": "The resource name of the Document to delete. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.", + "required": true, + "type": "string" + }, + "currentDocument.updateTime": { + "description": "When set, the target document must exist and have been last updated at\nthat time.", + "format": "google-datetime", + "type": "string", + "location": "query" + }, + "currentDocument.exists": { + "location": "query", + "description": "When set to `true`, the target document must exist.\nWhen set to `false`, the target document must not exist.", + "type": "boolean" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}", + "id": "firestore.projects.databases.documents.delete", + "path": "v1beta1/{+name}", + "description": "Deletes a document." + }, + "listCollectionIds": { + "request": { + "$ref": "ListCollectionIdsRequest" + }, + "description": "Lists all the collection IDs underneath a document.", + "response": { + "$ref": "ListCollectionIdsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/databases/[^/]+/documents/[^/]+/.+$", + "location": "path", + "description": "The parent document. In the format:\n`projects/{project_id}/databases/{database_id}/documents/{document_path}`.\nFor example:\n`projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents/{documentsId}/{documentsId1}:listCollectionIds", + "path": "v1beta1/{+parent}:listCollectionIds", + "id": "firestore.projects.databases.documents.listCollectionIds" + }, + "rollback": { + "request": { + "$ref": "RollbackRequest" + }, + "description": "Rolls back a transaction.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "parameters": { + "database": { + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path", + "description": "The database name. In the format:\n`projects/{project_id}/databases/{database_id}`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/documents:rollback", + "path": "v1beta1/{+database}/documents:rollback", + "id": "firestore.projects.databases.documents.rollback" + } + } + }, + "indexes": { + "methods": { + "delete": { + "description": "Deletes an index.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$", + "location": "path", + "description": "The index name. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}", + "path": "v1beta1/{+name}", + "id": "firestore.projects.databases.indexes.delete" + }, + "list": { + "description": "Lists the indexes that match the specified filters.", + "response": { + "$ref": "ListIndexesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path", + "description": "The database name. For example:\n`projects/{project_id}/databases/{database_id}`", + "required": true, + "type": "string" + }, + "filter": { + "location": "query", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The standard List page token.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The standard List page size.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes", + "path": "v1beta1/{+parent}/indexes", + "id": "firestore.projects.databases.indexes.list" + }, + "get": { + "parameters": { + "name": { + "description": "The name of the index. For example:\n`projects/{project_id}/databases/{database_id}/indexes/{index_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+/indexes/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes/{indexesId}", + "id": "firestore.projects.databases.indexes.get", + "path": "v1beta1/{+name}", + "description": "Gets an index.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Index" + } + }, + "create": { + "path": "v1beta1/{+parent}/indexes", + "id": "firestore.projects.databases.indexes.create", + "request": { + "$ref": "Index" + }, + "description": "Creates the specified index.\nA newly created index's initial state is `CREATING`. On completion of the\nreturned google.longrunning.Operation, the state will be `READY`.\nIf the index already exists, the call will return an `ALREADY_EXISTS`\nstatus.\n\nDuring creation, the process could result in an error, in which case the\nindex will move to the `ERROR` state. The process can be recovered by\nfixing the data that caused the error, removing the index with\ndelete, then re-creating the index with\ncreate.\n\nIndexes with a single field cannot be created.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "The name of the database this index will apply to. For example:\n`projects/{project_id}/databases/{database_id}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/datastore" + ], + "flatPath": "v1beta1/projects/{projectsId}/databases/{databasesId}/indexes" + } + } + } + } + } + } + } + }, + "parameters": { + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + } } }
diff --git a/genomics/v1/genomics-api.json b/genomics/v1/genomics-api.json index b198a72..6eebc0b 100644 --- a/genomics/v1/genomics-api.json +++ b/genomics/v1/genomics-api.json
@@ -6,60 +6,9 @@ "ownerName": "Google", "discoveryVersion": "v1", "resources": { - "referencesets": { - "methods": { - "search": { - "response": { - "$ref": "SearchReferenceSetsResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "flatPath": "v1/referencesets/search", - "path": "v1/referencesets/search", - "id": "genomics.referencesets.search", - "request": { - "$ref": "SearchReferenceSetsRequest" - }, - "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)" - }, - "get": { - "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).", - "response": { - "$ref": "ReferenceSet" - }, - "parameterOrder": [ - "referenceSetId" - ], - "httpMethod": "GET", - "parameters": { - "referenceSetId": { - "description": "The ID of the reference set.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "flatPath": "v1/referencesets/{referenceSetId}", - "path": "v1/referencesets/{referenceSetId}", - "id": "genomics.referencesets.get" - } - } - }, "readgroupsets": { "methods": { "delete": { - "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "response": { "$ref": "Empty" }, @@ -69,10 +18,10 @@ "httpMethod": "DELETE", "parameters": { "readGroupSetId": { + "location": "path", "description": "The ID of the read group set to be deleted. The caller must have WRITE\npermissions to the dataset associated with this read group set.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ @@ -81,13 +30,10 @@ ], "flatPath": "v1/readgroupsets/{readGroupSetId}", "path": "v1/readgroupsets/{readGroupSetId}", - "id": "genomics.readgroupsets.delete" + "id": "genomics.readgroupsets.delete", + "description": "Deletes a read group set.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" }, "import": { - "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)", - "request": { - "$ref": "ImportReadGroupSetsRequest" - }, "response": { "$ref": "Operation" }, @@ -101,11 +47,13 @@ "parameters": {}, "flatPath": "v1/readgroupsets:import", "path": "v1/readgroupsets:import", - "id": "genomics.readgroupsets.import" + "id": "genomics.readgroupsets.import", + "description": "Creates read group sets by asynchronously importing the provided\ninformation.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe caller must have WRITE permissions to the dataset.\n\n## Notes on [BAM](https://samtools.github.io/hts-specs/SAMv1.pdf) import\n\n- Tags will be converted to strings - tag types are not preserved\n- Comments (`@CO`) in the input file header will not be preserved\n- Original header order of references (`@SQ`) will not be preserved\n- Any reverse stranded unmapped reads will be reverse complemented, and\ntheir qualities (also the \"BQ\" and \"OQ\" tags, if any) will be reversed\n- Unmapped reads will be stripped of positional information (reference name\nand position)", + "request": { + "$ref": "ImportReadGroupSetsRequest" + } }, "export": { - "path": "v1/readgroupsets/{readGroupSetId}:export", - "id": "genomics.readgroupsets.export", "description": "Exports a read group set to a BAM file in Google Cloud Storage.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nNote that currently there may be some differences between exported BAM\nfiles and the original BAM file at the time of import. See\nImportReadGroupSets\nfor caveats.", "request": { "$ref": "ExportReadGroupSetRequest" @@ -130,9 +78,18 @@ "location": "path" } }, - "flatPath": "v1/readgroupsets/{readGroupSetId}:export" + "flatPath": "v1/readgroupsets/{readGroupSetId}:export", + "path": "v1/readgroupsets/{readGroupSetId}:export", + "id": "genomics.readgroupsets.export" }, "search": { + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "flatPath": "v1/readgroupsets/search", "id": "genomics.readgroupsets.search", "path": "v1/readgroupsets/search", "request": { @@ -143,23 +100,9 @@ "parameterOrder": [], "response": { "$ref": "SearchReadGroupSetsResponse" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "flatPath": "v1/readgroupsets/search" + } }, "get": { - "response": { - "$ref": "ReadGroupSet" - }, - "parameterOrder": [ - "readGroupSetId" - ], - "httpMethod": "GET", "parameters": { "readGroupSetId": { "description": "The ID of the read group set.", @@ -176,28 +119,16 @@ "flatPath": "v1/readgroupsets/{readGroupSetId}", "path": "v1/readgroupsets/{readGroupSetId}", "id": "genomics.readgroupsets.get", - "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" + "description": "Gets a read group set by ID.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "response": { + "$ref": "ReadGroupSet" + }, + "parameterOrder": [ + "readGroupSetId" + ], + "httpMethod": "GET" }, "patch": { - "parameters": { - "readGroupSetId": { - "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.", - "required": true, - "type": "string", - "location": "path" - }, - "updateMask": { - "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/readgroupsets/{readGroupSetId}", "id": "genomics.readgroupsets.patch", "path": "v1/readgroupsets/{readGroupSetId}", "request": { @@ -210,34 +141,43 @@ ], "response": { "$ref": "ReadGroupSet" - } + }, + "parameters": { + "readGroupSetId": { + "location": "path", + "description": "The ID of the read group set to be updated. The caller must have WRITE\npermissions to the dataset associated with this read group set.", + "required": true, + "type": "string" + }, + "updateMask": { + "description": "An optional mask specifying which fields to update. Supported fields:\n\n* name.\n* referenceSetId.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/readgroupsets/{readGroupSetId}" } }, "resources": { "coveragebuckets": { "methods": { "list": { - "id": "genomics.readgroupsets.coveragebuckets.list", - "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets", - "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.", - "httpMethod": "GET", - "parameterOrder": [ - "readGroupSetId" - ], - "response": { - "$ref": "ListCoverageBucketsResponse" - }, "parameters": { "end": { + "location": "query", "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified. If unset or 0, defaults\nto the length of the reference.", "format": "int64", - "type": "string", - "location": "query" + "type": "string" }, "pageToken": { + "location": "query", "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { "location": "query", @@ -264,9 +204,9 @@ "location": "query" }, "referenceName": { - "location": "query", "description": "The name of the reference to query, within the reference set associated\nwith this query. Optional.", - "type": "string" + "type": "string", + "location": "query" } }, "scopes": [ @@ -274,7 +214,17 @@ "https://www.googleapis.com/auth/genomics", "https://www.googleapis.com/auth/genomics.readonly" ], - "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets" + "flatPath": "v1/readgroupsets/{readGroupSetId}/coveragebuckets", + "id": "genomics.readgroupsets.coveragebuckets.list", + "path": "v1/readgroupsets/{readGroupSetId}/coveragebuckets", + "description": "Lists fixed width coverage buckets for a read group set, each of which\ncorrespond to a range of a reference sequence. Each bucket summarizes\ncoverage information across its corresponding genomic range.\n\nFor the definitions of read group sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nCoverage is defined as the number of reads which are aligned to a given\nbase in the reference sequence. Coverage buckets are available at several\nprecomputed bucket widths, enabling retrieval of various coverage 'zoom\nlevels'. The caller must have READ permissions for the target read group\nset.", + "httpMethod": "GET", + "parameterOrder": [ + "readGroupSetId" + ], + "response": { + "$ref": "ListCoverageBucketsResponse" + } } } } @@ -283,8 +233,6 @@ "reads": { "methods": { "search": { - "id": "genomics.reads.search", - "path": "v1/reads/search", "request": { "$ref": "SearchReadsRequest" }, @@ -300,13 +248,21 @@ "https://www.googleapis.com/auth/genomics", "https://www.googleapis.com/auth/genomics.readonly" ], - "flatPath": "v1/reads/search" + "flatPath": "v1/reads/search", + "id": "genomics.reads.search", + "path": "v1/reads/search" } } }, "callsets": { "methods": { "create": { + "path": "v1/callsets", + "id": "genomics.callsets.create", + "request": { + "$ref": "CallSet" + }, + "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "response": { "$ref": "CallSet" }, @@ -317,15 +273,22 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" ], - "flatPath": "v1/callsets", - "path": "v1/callsets", - "id": "genomics.callsets.create", - "request": { - "$ref": "CallSet" - }, - "description": "Creates a new call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" + "flatPath": "v1/callsets" }, "delete": { + "parameters": { + "callSetId": { + "location": "path", + "description": "The ID of the call set to be deleted.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/callsets/{callSetId}", "id": "genomics.callsets.delete", "path": "v1/callsets/{callSetId}", "description": "Deletes a call set.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", @@ -335,24 +298,9 @@ ], "response": { "$ref": "Empty" - }, - "parameters": { - "callSetId": { - "description": "The ID of the call set to be deleted.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/callsets/{callSetId}" + } }, "search": { - "path": "v1/callsets/search", - "id": "genomics.callsets.search", "request": { "$ref": "SearchCallSetsRequest" }, @@ -368,9 +316,30 @@ "https://www.googleapis.com/auth/genomics", "https://www.googleapis.com/auth/genomics.readonly" ], - "flatPath": "v1/callsets/search" + "flatPath": "v1/callsets/search", + "path": "v1/callsets/search", + "id": "genomics.callsets.search" }, "patch": { + "parameters": { + "updateMask": { + "location": "query", + "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.", + "format": "google-fieldmask", + "type": "string" + }, + "callSetId": { + "description": "The ID of the call set to be updated.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/callsets/{callSetId}", "path": "v1/callsets/{callSetId}", "id": "genomics.callsets.patch", "request": { @@ -383,26 +352,7 @@ "parameterOrder": [ "callSetId" ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "location": "query", - "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.", - "format": "google-fieldmask", - "type": "string" - }, - "callSetId": { - "location": "path", - "description": "The ID of the call set to be updated.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/callsets/{callSetId}" + "httpMethod": "PATCH" }, "get": { "description": "Gets a call set by ID.\n\nFor the definitions of call sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", @@ -415,10 +365,10 @@ "httpMethod": "GET", "parameters": { "callSetId": { + "location": "path", "description": "The ID of the call set.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ @@ -434,93 +384,21 @@ }, "variants": { "methods": { - "search": { - "id": "genomics.variants.search", - "path": "v1/variants/search", - "request": { - "$ref": "SearchVariantsRequest" - }, - "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).", - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "SearchVariantsResponse" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "flatPath": "v1/variants/search" - }, - "get": { - "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", - "httpMethod": "GET", - "parameterOrder": [ - "variantId" - ], - "response": { - "$ref": "Variant" - }, - "parameters": { - "variantId": { - "description": "The ID of the variant.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "flatPath": "v1/variants/{variantId}", - "id": "genomics.variants.get", - "path": "v1/variants/{variantId}" - }, - "patch": { - "parameters": { - "variantId": { - "description": "The ID of the variant to be updated.", - "required": true, - "type": "string", - "location": "path" - }, - "updateMask": { - "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/variants/{variantId}", - "path": "v1/variants/{variantId}", - "id": "genomics.variants.patch", - "request": { - "$ref": "Variant" - }, - "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls.", - "response": { - "$ref": "Variant" - }, - "parameterOrder": [ - "variantId" - ], - "httpMethod": "PATCH" - }, "delete": { + "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "httpMethod": "DELETE", + "parameterOrder": [ + "variantId" + ], + "response": { + "$ref": "Empty" + }, "parameters": { "variantId": { + "location": "path", "description": "The ID of the variant to be deleted.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ @@ -529,17 +407,13 @@ ], "flatPath": "v1/variants/{variantId}", "id": "genomics.variants.delete", - "path": "v1/variants/{variantId}", - "description": "Deletes a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", - "httpMethod": "DELETE", - "parameterOrder": [ - "variantId" - ], - "response": { - "$ref": "Empty" - } + "path": "v1/variants/{variantId}" }, "merge": { + "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.", + "request": { + "$ref": "MergeVariantsRequest" + }, "response": { "$ref": "Empty" }, @@ -552,11 +426,7 @@ "parameters": {}, "flatPath": "v1/variants:merge", "path": "v1/variants:merge", - "id": "genomics.variants.merge", - "description": "Merges the given variants with existing variants.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach variant will be\nmerged with an existing variant that matches its reference sequence,\nstart, end, reference bases, and alternative bases. If no such variant\nexists, a new one will be created.\n\nWhen variants are merged, the call information from the new variant\nis added to the existing variant. Variant info fields are merged as\nspecified in the\ninfoMergeConfig\nfield of the MergeVariantsRequest.\n\nPlease exercise caution when using this method! It is easy to introduce\nmistakes in existing variants and difficult to back out of them. For\nexample,\nsuppose you were trying to merge a new variant with an existing one and\nboth\nvariants contain calls that belong to callsets with the same callset ID.\n\n // Existing variant - irrelevant fields trimmed for clarity\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 0,\n 1\n ],\n }\n ]\n }\n\n // New variant with conflicting call information\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThe resulting merged variant would overwrite the existing calls with those\nfrom the new variant:\n\n {\n \"variantSetId\": \"10473108253681171589\",\n \"referenceName\": \"1\",\n \"start\": \"10582\",\n \"referenceBases\": \"G\",\n \"alternateBases\": [\n \"A\"\n ],\n \"calls\": [\n {\n \"callSetId\": \"10473108253681171589-0\",\n \"callSetName\": \"CALLSET0\",\n \"genotype\": [\n 1,\n 1\n ],\n }\n ]\n }\n\nThis may be the desired outcome, but it is up to the user to determine if\nif that is indeed the case.", - "request": { - "$ref": "MergeVariantsRequest" - } + "id": "genomics.variants.merge" }, "import": { "path": "v1/variants:import", @@ -596,41 +466,92 @@ }, "parameterOrder": [], "httpMethod": "POST" + }, + "search": { + "id": "genomics.variants.search", + "path": "v1/variants/search", + "request": { + "$ref": "SearchVariantsRequest" + }, + "description": "Gets a list of variants matching the criteria.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchVariants](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/variantmethods.avdl#L126).", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "SearchVariantsResponse" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "flatPath": "v1/variants/search" + }, + "get": { + "parameters": { + "variantId": { + "location": "path", + "description": "The ID of the variant.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "flatPath": "v1/variants/{variantId}", + "id": "genomics.variants.get", + "path": "v1/variants/{variantId}", + "description": "Gets a variant by ID.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "httpMethod": "GET", + "parameterOrder": [ + "variantId" + ], + "response": { + "$ref": "Variant" + } + }, + "patch": { + "response": { + "$ref": "Variant" + }, + "parameterOrder": [ + "variantId" + ], + "httpMethod": "PATCH", + "parameters": { + "variantId": { + "description": "The ID of the variant to be updated.", + "required": true, + "type": "string", + "location": "path" + }, + "updateMask": { + "description": "An optional mask specifying which fields to update. At this time, mutable\nfields are names and\ninfo. Acceptable values are \"names\" and\n\"info\". If unspecified, all mutable fields will be updated.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/variants/{variantId}", + "path": "v1/variants/{variantId}", + "id": "genomics.variants.patch", + "request": { + "$ref": "Variant" + }, + "description": "Updates a variant.\n\nFor the definitions of variants and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics. Returns the modified variant without\nits calls." } } }, "annotationsets": { "methods": { - "create": { - "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).", - "request": { - "$ref": "AnnotationSet" - }, - "response": { - "$ref": "AnnotationSet" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": {}, - "flatPath": "v1/annotationsets", - "path": "v1/annotationsets", - "id": "genomics.annotationsets.create" - }, "delete": { - "path": "v1/annotationsets/{annotationSetId}", - "id": "genomics.annotationsets.delete", - "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "annotationSetId" - ], - "httpMethod": "DELETE", "parameters": { "annotationSetId": { "location": "path", @@ -643,7 +564,17 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" ], - "flatPath": "v1/annotationsets/{annotationSetId}" + "flatPath": "v1/annotationsets/{annotationSetId}", + "path": "v1/annotationsets/{annotationSetId}", + "id": "genomics.annotationsets.delete", + "description": "Deletes an annotation set. Caller must have WRITE permission\nfor the associated annotation set.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "annotationSetId" + ], + "httpMethod": "DELETE" }, "search": { "path": "v1/annotationsets/search", @@ -666,7 +597,6 @@ "flatPath": "v1/annotationsets/search" }, "get": { - "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset.", "response": { "$ref": "AnnotationSet" }, @@ -689,9 +619,17 @@ }, "flatPath": "v1/annotationsets/{annotationSetId}", "path": "v1/annotationsets/{annotationSetId}", - "id": "genomics.annotationsets.get" + "id": "genomics.annotationsets.get", + "description": "Gets an annotation set. Caller must have READ permission for\nthe associated dataset." }, "update": { + "response": { + "$ref": "AnnotationSet" + }, + "parameterOrder": [ + "annotationSetId" + ], + "httpMethod": "PUT", "parameters": { "updateMask": { "location": "query", @@ -700,10 +638,10 @@ "type": "string" }, "annotationSetId": { - "location": "path", "description": "The ID of the annotation set to be updated.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ @@ -716,27 +654,32 @@ "request": { "$ref": "AnnotationSet" }, - "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset.", + "description": "Updates an annotation set. The update must respect all mutability\nrestrictions and other invariants described on the annotation set resource.\nCaller must have WRITE permission for the associated dataset." + }, + "create": { + "path": "v1/annotationsets", + "id": "genomics.annotationsets.create", + "description": "Creates a new annotation set. Caller must have WRITE permission for the\nassociated dataset.\n\nThe following fields are required:\n\n * datasetId\n * referenceSetId\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field).", + "request": { + "$ref": "AnnotationSet" + }, "response": { "$ref": "AnnotationSet" }, - "parameterOrder": [ - "annotationSetId" + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" ], - "httpMethod": "PUT" + "parameters": {}, + "flatPath": "v1/annotationsets" } } }, "references": { "methods": { "search": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "parameters": {}, - "flatPath": "v1/references/search", "path": "v1/references/search", "id": "genomics.references.search", "description": "Searches for references which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferences](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L146).", @@ -747,7 +690,14 @@ "$ref": "SearchReferencesResponse" }, "parameterOrder": [], - "httpMethod": "POST" + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "parameters": {}, + "flatPath": "v1/references/search" }, "get": { "path": "v1/references/{referenceId}", @@ -762,10 +712,10 @@ "httpMethod": "GET", "parameters": { "referenceId": { + "location": "path", "description": "The ID of the reference.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ @@ -780,23 +730,21 @@ "bases": { "methods": { "list": { + "path": "v1/references/{referenceId}/bases", + "id": "genomics.references.bases.list", + "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).", + "response": { + "$ref": "ListBasesResponse" + }, + "parameterOrder": [ + "referenceId" + ], + "httpMethod": "GET", "parameters": { - "referenceId": { - "description": "The ID of the reference.", - "required": true, - "type": "string", - "location": "path" - }, - "end": { - "location": "query", - "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.", - "format": "int64", - "type": "string" - }, "pageToken": { + "location": "query", "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { "location": "query", @@ -809,6 +757,18 @@ "format": "int64", "type": "string", "location": "query" + }, + "referenceId": { + "description": "The ID of the reference.", + "required": true, + "type": "string", + "location": "path" + }, + "end": { + "description": "The end position (0-based, exclusive) of this query. Defaults to the length\nof this reference.", + "format": "int64", + "type": "string", + "location": "query" } }, "scopes": [ @@ -816,17 +776,7 @@ "https://www.googleapis.com/auth/genomics", "https://www.googleapis.com/auth/genomics.readonly" ], - "flatPath": "v1/references/{referenceId}/bases", - "path": "v1/references/{referenceId}/bases", - "id": "genomics.references.bases.list", - "description": "Lists the bases in a reference, optionally restricted to a range.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceBases](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L221).", - "response": { - "$ref": "ListBasesResponse" - }, - "parameterOrder": [ - "referenceId" - ], - "httpMethod": "GET" + "flatPath": "v1/references/{referenceId}/bases" } } } @@ -834,123 +784,6 @@ }, "datasets": { "methods": { - "getIamPolicy": { - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.", - "required": true, - "type": "string", - "pattern": "^datasets/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/datasets/{datasetsId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "genomics.datasets.getIamPolicy" - }, - "patch": { - "request": { - "$ref": "Dataset" - }, - "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.", - "response": { - "$ref": "Dataset" - }, - "parameterOrder": [ - "datasetId" - ], - "httpMethod": "PATCH", - "parameters": { - "datasetId": { - "location": "path", - "description": "The ID of the dataset to be updated.", - "required": true, - "type": "string" - }, - "updateMask": { - "location": "query", - "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.", - "format": "google-fieldmask", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/datasets/{datasetId}", - "path": "v1/datasets/{datasetId}", - "id": "genomics.datasets.patch" - }, - "get": { - "response": { - "$ref": "Dataset" - }, - "parameterOrder": [ - "datasetId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics", - "https://www.googleapis.com/auth/genomics.readonly" - ], - "parameters": { - "datasetId": { - "description": "The ID of the dataset.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/datasets/{datasetId}", - "path": "v1/datasets/{datasetId}", - "id": "genomics.datasets.get", - "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" - }, - "undelete": { - "response": { - "$ref": "Dataset" - }, - "parameterOrder": [ - "datasetId" - ], - "httpMethod": "POST", - "parameters": { - "datasetId": { - "description": "The ID of the dataset to be undeleted.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1/datasets/{datasetId}:undelete", - "path": "v1/datasets/{datasetId}:undelete", - "id": "genomics.datasets.undelete", - "request": { - "$ref": "UndeleteDatasetRequest" - }, - "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred." - }, "testIamPermissions": { "request": { "$ref": "TestIamPermissionsRequest" @@ -981,6 +814,16 @@ "id": "genomics.datasets.testIamPermissions" }, "delete": { + "path": "v1/datasets/{datasetId}", + "id": "genomics.datasets.delete", + "description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "datasetId" + ], + "httpMethod": "DELETE", "parameters": { "datasetId": { "description": "The ID of the dataset to be deleted.", @@ -993,19 +836,12 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" ], - "flatPath": "v1/datasets/{datasetId}", - "path": "v1/datasets/{datasetId}", - "id": "genomics.datasets.delete", - "description": "Deletes a dataset and all of its contents (all read group sets,\nreference sets, variant sets, call sets, annotation sets, etc.)\nThis is reversible (up to one week after the deletion) via\nthe\ndatasets.undelete\noperation.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "datasetId" - ], - "httpMethod": "DELETE" + "flatPath": "v1/datasets/{datasetId}" }, "list": { + "id": "genomics.datasets.list", + "path": "v1/datasets", + "description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "httpMethod": "GET", "parameterOrder": [], "response": { @@ -1013,9 +849,9 @@ }, "parameters": { "pageToken": { + "location": "query", "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 50. The maximum value is 1024.", @@ -1024,9 +860,9 @@ "location": "query" }, "projectId": { - "location": "query", "description": "Required. The Google Cloud project ID to list datasets for.", - "type": "string" + "type": "string", + "location": "query" } }, "scopes": [ @@ -1034,12 +870,13 @@ "https://www.googleapis.com/auth/genomics", "https://www.googleapis.com/auth/genomics.readonly" ], - "flatPath": "v1/datasets", - "id": "genomics.datasets.list", - "path": "v1/datasets", - "description": "Lists datasets within a project.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" + "flatPath": "v1/datasets" }, "setIamPolicy": { + "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.", + "request": { + "$ref": "SetIamPolicyRequest" + }, "response": { "$ref": "Policy" }, @@ -1062,13 +899,17 @@ }, "flatPath": "v1/datasets/{datasetsId}:setIamPolicy", "path": "v1/{+resource}:setIamPolicy", - "id": "genomics.datasets.setIamPolicy", - "description": "Sets the access control policy on the specified dataset. Replaces any\nexisting policy.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nSee \u003ca href=\"/iam/docs/managing-policies#setting_a_policy\"\u003eSetting a\nPolicy\u003c/a\u003e for more information.", - "request": { - "$ref": "SetIamPolicyRequest" - } + "id": "genomics.datasets.setIamPolicy" }, "create": { + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/datasets", + "path": "v1/datasets", + "id": "genomics.datasets.create", "request": { "$ref": "Dataset" }, @@ -1077,58 +918,129 @@ "$ref": "Dataset" }, "parameterOrder": [], + "httpMethod": "POST" + }, + "getIamPolicy": { + "path": "v1/{+resource}:getIamPolicy", + "id": "genomics.datasets.getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Gets the access control policy for the dataset. This is empty if the\npolicy or resource does not exist.\n\nSee \u003ca href=\"/iam/docs/managing-policies#getting_a_policy\"\u003eGetting a\nPolicy\u003c/a\u003e for more information.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], "httpMethod": "POST", - "parameters": {}, + "parameters": { + "resource": { + "pattern": "^datasets/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which policy is being specified. Format is\n`datasets/\u003cdataset ID\u003e`.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" ], - "flatPath": "v1/datasets", - "path": "v1/datasets", - "id": "genomics.datasets.create" + "flatPath": "v1/datasets/{datasetsId}:getIamPolicy" + }, + "patch": { + "path": "v1/datasets/{datasetId}", + "id": "genomics.datasets.patch", + "request": { + "$ref": "Dataset" + }, + "description": "Updates a dataset.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis method supports patch semantics.", + "response": { + "$ref": "Dataset" + }, + "parameterOrder": [ + "datasetId" + ], + "httpMethod": "PATCH", + "parameters": { + "datasetId": { + "location": "path", + "description": "The ID of the dataset to be updated.", + "required": true, + "type": "string" + }, + "updateMask": { + "location": "query", + "description": "An optional mask specifying which fields to update. At this time, the only\nmutable field is name. The only\nacceptable value is \"name\". If unspecified, all mutable fields will be\nupdated.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/datasets/{datasetId}" + }, + "get": { + "response": { + "$ref": "Dataset" + }, + "parameterOrder": [ + "datasetId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "parameters": { + "datasetId": { + "location": "path", + "description": "The ID of the dataset.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/datasets/{datasetId}", + "path": "v1/datasets/{datasetId}", + "id": "genomics.datasets.get", + "description": "Gets a dataset by ID.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" + }, + "undelete": { + "parameters": { + "datasetId": { + "location": "path", + "description": "The ID of the dataset to be undeleted.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1/datasets/{datasetId}:undelete", + "path": "v1/datasets/{datasetId}:undelete", + "id": "genomics.datasets.undelete", + "request": { + "$ref": "UndeleteDatasetRequest" + }, + "description": "Undeletes a dataset by restoring a dataset which was deleted via this API.\n\nFor the definitions of datasets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThis operation is only possible for a week after the deletion occurred.", + "response": { + "$ref": "Dataset" + }, + "parameterOrder": [ + "datasetId" + ], + "httpMethod": "POST" } } }, "annotations": { "methods": { - "create": { - "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.", - "request": { - "$ref": "Annotation" - }, - "response": { - "$ref": "Annotation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": {}, - "flatPath": "v1/annotations", - "path": "v1/annotations", - "id": "genomics.annotations.create" - }, - "batchCreate": { - "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.", - "request": { - "$ref": "BatchCreateAnnotationsRequest" - }, - "response": { - "$ref": "BatchCreateAnnotationsResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": {}, - "flatPath": "v1/annotations:batchCreate", - "path": "v1/annotations:batchCreate", - "id": "genomics.annotations.batchCreate" - }, "search": { "parameters": {}, "scopes": [ @@ -1184,10 +1096,10 @@ "type": "string" }, "annotationId": { + "location": "path", "description": "The ID of the annotation to be updated.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "scopes": [ @@ -1219,10 +1131,10 @@ }, "parameters": { "annotationId": { - "location": "path", "description": "The ID of the annotation to be deleted.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ @@ -1233,17 +1145,50 @@ "id": "genomics.annotations.delete", "path": "v1/annotations/{annotationId}", "description": "Deletes an annotation. Caller must have WRITE permission for\nthe associated annotation set." + }, + "create": { + "description": "Creates a new annotation. Caller must have WRITE permission\nfor the associated annotation set.\n\nThe following fields are required:\n\n* annotationSetId\n* referenceName or\n referenceId\n\n### Transcripts\n\nFor annotations of type TRANSCRIPT, the following fields of\ntranscript must be provided:\n\n* exons.start\n* exons.end\n\nAll other fields may be optionally specified, unless documented as being\nserver-generated (for example, the `id` field). The annotated\nrange must be no longer than 100Mbp (mega base pairs). See the\nAnnotation resource\nfor additional restrictions on each field.", + "request": { + "$ref": "Annotation" + }, + "response": { + "$ref": "Annotation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": {}, + "flatPath": "v1/annotations", + "path": "v1/annotations", + "id": "genomics.annotations.create" + }, + "batchCreate": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": {}, + "flatPath": "v1/annotations:batchCreate", + "path": "v1/annotations:batchCreate", + "id": "genomics.annotations.batchCreate", + "description": "Creates one or more new annotations atomically. All annotations must\nbelong to the same annotation set. Caller must have WRITE\npermission for this annotation set. For optimal performance, batch\npositionally adjacent annotations together.\n\nIf the request has a systemic issue, such as an attempt to write to\nan inaccessible annotation set, the entire RPC will fail accordingly. For\nlesser data issues, when possible an error will be isolated to the\ncorresponding batch entry in the response; the remaining well formed\nannotations will be created normally.\n\nFor details on the requirements for each individual annotation resource,\nsee\nCreateAnnotation.", + "request": { + "$ref": "BatchCreateAnnotationsRequest" + }, + "response": { + "$ref": "BatchCreateAnnotationsResponse" + }, + "parameterOrder": [], + "httpMethod": "POST" } } }, "variantsets": { "methods": { "create": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "VariantSet" - }, "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", @@ -1255,7 +1200,12 @@ "request": { "$ref": "VariantSet" }, - "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server." + "description": "Creates a new variant set.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nThe provided variant set must have a valid `datasetId` set - all other\nfields are optional. Note that the `id` field will be ignored, as this is\nassigned by the server.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "VariantSet" + } }, "export": { "response": { @@ -1267,10 +1217,10 @@ "httpMethod": "POST", "parameters": { "variantSetId": { - "location": "path", "description": "Required. The ID of the variant set that contains variant data which\nshould be exported. The caller must have READ access to this variant set.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ @@ -1287,6 +1237,8 @@ "description": "Exports variant set data to an external destination.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" }, "search": { + "id": "genomics.variantsets.search", + "path": "v1/variantsets/search", "request": { "$ref": "SearchVariantSetsRequest" }, @@ -1302,24 +1254,15 @@ "https://www.googleapis.com/auth/genomics", "https://www.googleapis.com/auth/genomics.readonly" ], - "flatPath": "v1/variantsets/search", - "id": "genomics.variantsets.search", - "path": "v1/variantsets/search" + "flatPath": "v1/variantsets/search" }, "patch": { - "response": { - "$ref": "VariantSet" - }, - "parameterOrder": [ - "variantSetId" - ], - "httpMethod": "PATCH", "parameters": { "updateMask": { + "location": "query", "description": "An optional mask specifying which fields to update. Supported fields:\n\n* metadata.\n* name.\n* description.\n\nLeaving `updateMask` unset is equivalent to specifying all mutable\nfields.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "variantSetId": { "description": "The ID of the variant to be updated (must already exist).", @@ -1338,9 +1281,19 @@ "request": { "$ref": "VariantSet" }, - "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" + "description": "Updates a variant set using patch semantics.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "response": { + "$ref": "VariantSet" + }, + "parameterOrder": [ + "variantSetId" + ], + "httpMethod": "PATCH" }, "get": { + "path": "v1/variantsets/{variantSetId}", + "id": "genomics.variantsets.get", + "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "response": { "$ref": "VariantSet" }, @@ -1361,12 +1314,19 @@ "location": "path" } }, - "flatPath": "v1/variantsets/{variantSetId}", - "path": "v1/variantsets/{variantSetId}", - "id": "genomics.variantsets.get", - "description": "Gets a variant set by ID.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)" + "flatPath": "v1/variantsets/{variantSetId}" }, "delete": { + "path": "v1/variantsets/{variantSetId}", + "id": "genomics.variantsets.delete", + "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "variantSetId" + ], + "httpMethod": "DELETE", "parameters": { "variantSetId": { "location": "path", @@ -1379,54 +1339,13 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" ], - "flatPath": "v1/variantsets/{variantSetId}", - "path": "v1/variantsets/{variantSetId}", - "id": "genomics.variantsets.delete", - "description": "Deletes a variant set including all variants, call sets, and calls within.\nThis is not reversible.\n\nFor the definitions of variant sets and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "variantSetId" - ], - "httpMethod": "DELETE" + "flatPath": "v1/variantsets/{variantSetId}" } } }, "operations": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.", - "request": { - "$ref": "CancelOperationRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": { - "name": { - "pattern": "^operations/.+$", - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "genomics.operations.cancel" - }, "list": { - "path": "v1/{+name}", - "id": "genomics.operations.list", "description": "Lists operations that match the specified filter in the request.", "response": { "$ref": "ListOperationsResponse" @@ -1464,19 +1383,11 @@ "type": "string" } }, - "flatPath": "v1/operations" + "flatPath": "v1/operations", + "path": "v1/{+name}", + "id": "genomics.operations.list" }, "get": { - "path": "v1/{+name}", - "id": "genomics.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.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/genomics" @@ -1490,21 +1401,121 @@ "type": "string" } }, - "flatPath": "v1/operations/{operationsId}" + "flatPath": "v1/operations/{operationsId}", + "path": "v1/{+name}", + "id": "genomics.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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET" + }, + "cancel": { + "path": "v1/{+name}:cancel", + "id": "genomics.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^operations/.+$", + "location": "path" + } + }, + "flatPath": "v1/operations/{operationsId}:cancel" + } + } + }, + "referencesets": { + "methods": { + "search": { + "path": "v1/referencesets/search", + "id": "genomics.referencesets.search", + "request": { + "$ref": "SearchReferenceSetsRequest" + }, + "description": "Searches for reference sets which match the given criteria.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.searchReferenceSets](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L71)", + "response": { + "$ref": "SearchReferenceSetsResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "flatPath": "v1/referencesets/search" + }, + "get": { + "parameters": { + "referenceSetId": { + "location": "path", + "description": "The ID of the reference set.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics", + "https://www.googleapis.com/auth/genomics.readonly" + ], + "flatPath": "v1/referencesets/{referenceSetId}", + "path": "v1/referencesets/{referenceSetId}", + "id": "genomics.referencesets.get", + "description": "Gets a reference set.\n\nFor the definitions of references and other genomics resources, see\n[Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nImplements\n[GlobalAllianceApi.getReferenceSet](https://github.com/ga4gh/schemas/blob/v0.5.1/src/main/resources/avro/referencemethods.avdl#L83).", + "response": { + "$ref": "ReferenceSet" + }, + "parameterOrder": [ + "referenceSetId" + ], + "httpMethod": "GET" } } } }, "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, "bearer_token": { - "location": "query", "description": "OAuth bearer token.", - "type": "string" + "type": "string", + "location": "query" }, "upload_protocol": { "location": "query", @@ -1523,9 +1534,9 @@ "location": "query" }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "$.xgafv": { "enumDescriptions": [ @@ -1546,357 +1557,44 @@ "location": "query" }, "alt": { - "type": "string", - "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", "description": "Data format for response.", "default": "json", "enum": [ "json", "media", "proto" - ] + ], + "type": "string", + "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" }, "access_token": { + "location": "query", "description": "OAuth access token.", - "type": "string", - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" + "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.", + "type": "string" } }, "schemas": { - "SearchVariantSetsResponse": { - "id": "SearchVariantSetsResponse", - "description": "The search variant sets response.", - "type": "object", - "properties": { - "variantSets": { - "description": "The variant sets belonging to the requested dataset.", - "type": "array", - "items": { - "$ref": "VariantSet" - } - }, - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" - } - } - }, - "Empty": { - "id": "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 `{}`.", - "type": "object", - "properties": {} - }, - "Entry": { - "type": "object", - "properties": { - "status": { - "description": "The creation status.", - "$ref": "Status" - }, - "annotation": { - "description": "The created annotation, if creation was successful.", - "$ref": "Annotation" - } - }, - "id": "Entry" - }, - "Position": { - "description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.", - "type": "object", - "properties": { - "position": { - "description": "The 0-based offset from the start of the forward strand for that reference.", - "format": "int64", - "type": "string" - }, - "referenceName": { - "description": "The name of the reference in whatever reference set is being used.", - "type": "string" - }, - "reverseStrand": { - "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.", - "type": "boolean" - } - }, - "id": "Position" - }, - "SearchReferenceSetsResponse": { - "id": "SearchReferenceSetsResponse", - "type": "object", - "properties": { - "referenceSets": { - "description": "The matching references sets.", - "type": "array", - "items": { - "$ref": "ReferenceSet" - } - }, - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" - } - } - }, - "SearchCallSetsRequest": { - "id": "SearchCallSetsRequest", - "description": "The call set search request.", - "type": "object", - "properties": { - "name": { - "description": "Only return call sets for which a substring of the name matches this\nstring.", - "type": "string" - }, - "pageToken": { - "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.", - "format": "int32", - "type": "integer" - }, - "variantSetIds": { - "description": "Restrict the query to call sets within the given variant sets. At least one\nID must be provided.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ImportReadGroupSetsRequest": { - "id": "ImportReadGroupSetsRequest", - "description": "The read group set import request.", - "type": "object", - "properties": { - "datasetId": { - "description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.", - "type": "string" - }, - "sourceUris": { - "description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.", - "type": "array", - "items": { - "type": "string" - } - }, - "referenceSetId": { - "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.", - "type": "string" - }, - "partitionStrategy": { - "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.", - "type": "string", - "enumDescriptions": [ - "", - "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.", - "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set." - ], - "enum": [ - "PARTITION_STRATEGY_UNSPECIFIED", - "PER_FILE_PER_SAMPLE", - "MERGE_ALL" - ] - } - } - }, - "Policy": { - "id": "Policy", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", - "type": "object", - "properties": { - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Version of the `Policy`. The default version is 0.", - "format": "int32", - "type": "integer" - }, - "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - } - } - }, - "Annotation": { - "id": "Annotation", - "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.", - "type": "object", - "properties": { - "end": { - "description": "The end position of the range on the reference, 0-based exclusive.", - "format": "int64", - "type": "string" - }, - "transcript": { - "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`.", - "$ref": "Transcript" - }, - "start": { - "description": "The start position of the range on the reference, 0-based inclusive.", - "format": "int64", - "type": "string" - }, - "annotationSetId": { - "description": "The annotation set to which this annotation belongs.", - "type": "string" - }, - "name": { - "description": "The display name of this annotation.", - "type": "string" - }, - "variant": { - "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`.", - "$ref": "VariantAnnotation" - }, - "id": { - "description": "The server-generated annotation ID, unique across all annotations.", - "type": "string" - }, - "referenceId": { - "description": "The ID of the Google Genomics reference associated with this range.", - "type": "string" - }, - "reverseStrand": { - "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.", - "type": "boolean" - }, - "referenceName": { - "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.", - "type": "string" - }, - "info": { - "additionalProperties": { - "type": "array", - "items": { - "type": "any" - } - }, - "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", - "type": "object" - }, - "type": { - "description": "The data type for this annotation. Must match the containing annotation\nset's type.", - "type": "string", - "enumDescriptions": [ - "", - "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.", - "A `VARIANT` annotation type.", - "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.", - "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA." - ], - "enum": [ - "ANNOTATION_TYPE_UNSPECIFIED", - "GENERIC", - "VARIANT", - "GENE", - "TRANSCRIPT" - ] - } - } - }, - "CancelOperationRequest": { - "id": "CancelOperationRequest", - "description": "The request message for Operations.CancelOperation.", - "type": "object", - "properties": {} - }, - "SearchReadsRequest": { - "description": "The read search request.", - "type": "object", - "properties": { - "readGroupIds": { - "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.", - "type": "array", - "items": { - "type": "string" - } - }, - "end": { - "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.", - "format": "int64", - "type": "string" - }, - "pageToken": { - "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", - "format": "int32", - "type": "integer" - }, - "start": { - "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.", - "format": "int64", - "type": "string" - }, - "referenceName": { - "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.", - "type": "string" - }, - "readGroupSetIds": { - "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "SearchReadsRequest" - }, "Operation": { - "id": "Operation", "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "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": { - "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, "name": { "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", "type": "string" }, "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { "additionalProperties": { @@ -1905,8 +1603,21 @@ }, "description": "An OperationMetadata object. This will always be returned with the Operation.", "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": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.", + "type": "object" } - } + }, + "id": "Operation" }, "RuntimeMetadata": { "id": "RuntimeMetadata", @@ -1934,7 +1645,6 @@ } }, "VariantCall": { - "id": "VariantCall", "description": "A call represents the determination of genotype with respect to a particular\nvariant. It may include associated information such as quality and phasing.\nFor example, a call might assign a probability of 0.32 to the occurrence of\na SNP named rs1234 in a call set with the name NA12345.", "type": "object", "properties": { @@ -1976,10 +1686,10 @@ "description": "The ID of the call set this variant call belongs to.", "type": "string" } - } + }, + "id": "VariantCall" }, "SearchVariantsResponse": { - "id": "SearchVariantsResponse", "description": "The variant search response.", "type": "object", "properties": { @@ -1994,9 +1704,11 @@ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", "type": "string" } - } + }, + "id": "SearchVariantsResponse" }, "ListBasesResponse": { + "id": "ListBasesResponse", "type": "object", "properties": { "sequence": { @@ -2012,13 +1724,17 @@ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", "type": "string" } - }, - "id": "ListBasesResponse" + } }, "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.", "type": "object", "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" @@ -2027,17 +1743,12 @@ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "type": "object" + } } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" } }, "id": "Status" @@ -2066,6 +1777,7 @@ "id": "Binding" }, "Range": { + "id": "Range", "description": "A 0-based half-open genomic coordinate range for search requests.", "type": "object", "properties": { @@ -2083,8 +1795,7 @@ "description": "The reference sequence name, for example `chr1`,\n`1`, or `chrX`.", "type": "string" } - }, - "id": "Range" + } }, "VariantSet": { "description": "A variant set is a collection of call sets and variants. It contains summary\nstatistics of those contents. A variant set belongs to a dataset.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", @@ -2128,6 +1839,7 @@ "id": "VariantSet" }, "BatchCreateAnnotationsResponse": { + "id": "BatchCreateAnnotationsResponse", "type": "object", "properties": { "entries": { @@ -2137,10 +1849,10 @@ "$ref": "Entry" } } - }, - "id": "BatchCreateAnnotationsResponse" + } }, "ReferenceBound": { + "id": "ReferenceBound", "description": "ReferenceBound records an upper bound for the starting coordinate of\nvariants in a particular reference.", "type": "object", "properties": { @@ -2153,32 +1865,47 @@ "description": "The name of the reference associated with this reference bound.", "type": "string" } - }, - "id": "ReferenceBound" + } }, "SearchCallSetsResponse": { "id": "SearchCallSetsResponse", "description": "The call set search response.", "type": "object", "properties": { + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" + }, "callSets": { "description": "The list of matching call sets.", "type": "array", "items": { "$ref": "CallSet" } - }, - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" } } }, "Variant": { - "id": "Variant", "description": "A variant represents a change in DNA sequence relative to a reference\nsequence. For example, a variant could represent a SNP or an insertion.\nVariants belong to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\nEach of the calls on a variant represent a determination of genotype with\nrespect to that variant. For example, a call might assign probability of 0.32\nto the occurrence of a SNP named rs1234 in a sample named NA12345. A call\nbelongs to a call set, which contains related calls typically from one\nsample.", "type": "object", "properties": { + "quality": { + "description": "A measure of how likely this variant is to be real.\nA higher value is better.", + "format": "double", + "type": "number" + }, + "id": { + "description": "The server-generated variant ID, unique across all variants.", + "type": "string" + }, + "variantSetId": { + "description": "The ID of the variant set this variant belongs to.", + "type": "string" + }, + "referenceName": { + "description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)", + "type": "string" + }, "info": { "description": "A map of additional variant information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", "type": "object", @@ -2235,25 +1962,9 @@ "description": "The position at which this variant occurs (0-based).\nThis corresponds to the first base of the string of reference bases.", "format": "int64", "type": "string" - }, - "quality": { - "description": "A measure of how likely this variant is to be real.\nA higher value is better.", - "format": "double", - "type": "number" - }, - "id": { - "description": "The server-generated variant ID, unique across all variants.", - "type": "string" - }, - "variantSetId": { - "description": "The ID of the variant set this variant belongs to.", - "type": "string" - }, - "referenceName": { - "description": "The reference on which this variant occurs.\n(such as `chr20` or `X`)", - "type": "string" } - } + }, + "id": "Variant" }, "ListOperationsResponse": { "id": "ListOperationsResponse", @@ -2274,16 +1985,15 @@ } }, "OperationMetadata": { - "id": "OperationMetadata", "description": "Metadata describing an Operation.", "type": "object", "properties": { "labels": { + "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", + "type": "object", "additionalProperties": { "type": "string" - }, - "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", - "type": "object" + } }, "createTime": { "description": "The time at which the job was submitted to the Genomics service.", @@ -2316,32 +2026,28 @@ "type": "string" }, "request": { + "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", - "type": "object" + } }, "runtimeMetadata": { + "description": "Runtime metadata on this Operation.", + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "description": "Runtime metadata on this Operation.", - "type": "object" + } } - } + }, + "id": "OperationMetadata" }, "SearchVariantsRequest": { "description": "The variant search request.", "type": "object", "properties": { - "end": { - "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.", - "format": "int64", - "type": "string" - }, "pageToken": { "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", "type": "string" @@ -2382,6 +2088,11 @@ "items": { "type": "string" } + }, + "end": { + "description": "The end of the window, 0-based exclusive. If unspecified or 0, defaults to\nthe length of the reference.", + "format": "int64", + "type": "string" } }, "id": "SearchVariantsRequest" @@ -2416,21 +2127,22 @@ "SearchAnnotationsResponse": { "type": "object", "properties": { - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" - }, "annotations": { "description": "The matching annotations.", "type": "array", "items": { "$ref": "Annotation" } + }, + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" } }, "id": "SearchAnnotationsResponse" }, "ClinicalCondition": { + "id": "ClinicalCondition", "type": "object", "properties": { "names": { @@ -2455,24 +2167,23 @@ "description": "The MedGen concept id associated with this gene.\nSearch for these IDs at http://www.ncbi.nlm.nih.gov/medgen/", "type": "string" } - }, - "id": "ClinicalCondition" + } }, "SearchReadsResponse": { "id": "SearchReadsResponse", "description": "The read search response.", "type": "object", "properties": { - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" - }, "alignments": { "description": "The list of matching alignments sorted by mapped genomic coordinate,\nif any, ascending in position within the same reference. Unmapped reads,\nwhich have no position, are returned contiguously and are sorted in\nascending lexicographic order by fragment name.", "type": "array", "items": { "$ref": "Read" } + }, + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" } } }, @@ -2506,6 +2217,14 @@ "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.", "type": "object", "properties": { + "instanceName": { + "description": "The instance on which the operation is running.", + "type": "string" + }, + "zone": { + "description": "The availability zone in which the instance resides.", + "type": "string" + }, "machineType": { "description": "The machine type of the instance.", "type": "string" @@ -2516,14 +2235,6 @@ "items": { "type": "string" } - }, - "instanceName": { - "description": "The instance on which the operation is running.", - "type": "string" - }, - "zone": { - "description": "The availability zone in which the instance resides.", - "type": "string" } }, "id": "ComputeEngine" @@ -2539,24 +2250,24 @@ "type": "number" }, "range": { - "description": "The genomic coordinate range spanned by this bucket.", - "$ref": "Range" + "$ref": "Range", + "description": "The genomic coordinate range spanned by this bucket." } } }, "ExternalId": { + "id": "ExternalId", "type": "object", "properties": { - "sourceName": { - "description": "The name of the source of this data.", - "type": "string" - }, "id": { "description": "The id used by the source of this data.", "type": "string" + }, + "sourceName": { + "description": "The name of the source of this data.", + "type": "string" } - }, - "id": "ExternalId" + } }, "SearchVariantSetsRequest": { "id": "SearchVariantSetsRequest", @@ -2582,30 +2293,9 @@ } }, "VariantSetMetadata": { - "id": "VariantSetMetadata", "description": "Metadata describes a single piece of variant call metadata.\nThese data include a top level key and either a single value string (value)\nor a list of key-value pairs (info.)\nValue and info are mutually exclusive.", "type": "object", "properties": { - "number": { - "description": "The number of values that can be included in a field described by this\nmetadata.", - "type": "string" - }, - "value": { - "description": "The value field for simple metadata", - "type": "string" - }, - "id": { - "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.", - "type": "string" - }, - "key": { - "description": "The top-level key.", - "type": "string" - }, - "description": { - "description": "A textual description of this metadata.", - "type": "string" - }, "info": { "description": "Remaining structured metadata key-value pairs. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", "type": "object", @@ -2635,8 +2325,29 @@ "CHARACTER", "STRING" ] + }, + "number": { + "description": "The number of values that can be included in a field described by this\nmetadata.", + "type": "string" + }, + "value": { + "description": "The value field for simple metadata", + "type": "string" + }, + "id": { + "description": "User-provided ID field, not enforced by this API.\nTwo or more pieces of structured metadata with identical\nid and key fields are considered equivalent.", + "type": "string" + }, + "key": { + "description": "The top-level key.", + "type": "string" + }, + "description": { + "description": "A textual description of this metadata.", + "type": "string" } - } + }, + "id": "VariantSetMetadata" }, "Reference": { "description": "A reference is a canonical assembled DNA sequence, intended to act as a\nreference coordinate space for other genomic annotations. A single reference\nmight represent the human chromosome 1 or mitochandrial DNA, for instance. A\nreference belongs to one or more reference sets.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", @@ -2737,12 +2448,12 @@ "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them.", "type": "object", "additionalProperties": { + "type": "string", "enum": [ "INFO_MERGE_OPERATION_UNSPECIFIED", "IGNORE_NEW", "MOVE_TO_CALLS" - ], - "type": "string" + ] } }, "variantSetId": { @@ -2769,10 +2480,39 @@ "id": "BatchCreateAnnotationsRequest" }, "Read": { - "id": "Read", "description": "A read alignment describes a linear alignment of a string of DNA to a\nreference sequence, in addition to metadata\nabout the fragment (the molecule of DNA sequenced) and the read (the bases\nwhich were read by the sequencer). A read is equivalent to a line in a SAM\nfile. A read belongs to exactly one read group and exactly one\nread group set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)\n\n### Reverse-stranded reads\n\nMapped reads (reads having a non-null `alignment`) can be aligned to either\nthe forward or the reverse strand of their associated reference. Strandedness\nof a mapped read is encoded by `alignment.position.reverseStrand`.\n\nIf we consider the reference to be a forward-stranded coordinate space of\n`[0, reference.length)` with `0` as the left-most position and\n`reference.length` as the right-most position, reads are always aligned left\nto right. That is, `alignment.position.position` always refers to the\nleft-most reference coordinate and `alignment.cigar` describes the alignment\nof this read to the reference from left to right. All per-base fields such as\n`alignedSequence` and `alignedQuality` share this same left-to-right\norientation; this is true of reads which are aligned to either strand. For\nreverse-stranded reads, this means that `alignedSequence` is the reverse\ncomplement of the bases that were originally reported by the sequencing\nmachine.\n\n### Generating a reference-aligned sequence string\n\nWhen interacting with mapped reads, it's often useful to produce a string\nrepresenting the local alignment of the read to reference. The following\npseudocode demonstrates one way of doing this:\n\n out = \"\"\n offset = 0\n for c in read.alignment.cigar {\n switch c.operation {\n case \"ALIGNMENT_MATCH\", \"SEQUENCE_MATCH\", \"SEQUENCE_MISMATCH\":\n out += read.alignedSequence[offset:offset+c.operationLength]\n offset += c.operationLength\n break\n case \"CLIP_SOFT\", \"INSERT\":\n offset += c.operationLength\n break\n case \"PAD\":\n out += repeat(\"*\", c.operationLength)\n break\n case \"DELETE\":\n out += repeat(\"-\", c.operationLength)\n break\n case \"SKIP\":\n out += repeat(\" \", c.operationLength)\n break\n case \"CLIP_HARD\":\n break\n }\n }\n return out\n\n### Converting to SAM's CIGAR string\n\nThe following pseudocode generates a SAM CIGAR string from the\n`cigar` field. Note that this is a lossy conversion\n(`cigar.referenceSequence` is lost).\n\n cigarMap = {\n \"ALIGNMENT_MATCH\": \"M\",\n \"INSERT\": \"I\",\n \"DELETE\": \"D\",\n \"SKIP\": \"N\",\n \"CLIP_SOFT\": \"S\",\n \"CLIP_HARD\": \"H\",\n \"PAD\": \"P\",\n \"SEQUENCE_MATCH\": \"=\",\n \"SEQUENCE_MISMATCH\": \"X\",\n }\n cigarStr = \"\"\n for c in read.alignment.cigar {\n cigarStr += c.operationLength + cigarMap[c.operation]\n }\n return cigarStr", "type": "object", "properties": { + "numberReads": { + "description": "The number of reads in the fragment (extension to SAM flag 0x1).", + "format": "int32", + "type": "integer" + }, + "id": { + "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.", + "type": "string" + }, + "secondaryAlignment": { + "description": "Whether this alignment is secondary. Equivalent to SAM flag 0x100.\nA secondary alignment represents an alternative to the primary alignment\nfor this read. Aligners may return secondary alignments if a read can map\nambiguously to multiple coordinates in the genome. By convention, each read\nhas one and only one alignment where both `secondaryAlignment`\nand `supplementaryAlignment` are false.", + "type": "boolean" + }, + "fragmentName": { + "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.", + "type": "string" + }, + "readGroupSetId": { + "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.", + "type": "string" + }, + "duplicateFragment": { + "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).", + "type": "boolean" + }, + "readNumber": { + "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.", + "format": "int32", + "type": "integer" + }, "readGroupId": { "description": "The ID of the read group this read belongs to. A read belongs to exactly\none read group. This is a server-generated ID which is distinct from SAM's\nRG tag (for that value, see\nReadGroup.name).", "type": "string" @@ -2823,55 +2563,15 @@ "alignment": { "$ref": "LinearAlignment", "description": "The linear alignment for this alignment record. This field is null for\nunmapped reads." - }, - "numberReads": { - "description": "The number of reads in the fragment (extension to SAM flag 0x1).", - "format": "int32", - "type": "integer" - }, - "id": { - "description": "The server-generated read ID, unique across all reads. This is different\nfrom the `fragmentName`.", - "type": "string" - }, - "secondaryAlignment": { - "description": "Whether this alignment is secondary. Equivalent to SAM flag 0x100.\nA secondary alignment represents an alternative to the primary alignment\nfor this read. Aligners may return secondary alignments if a read can map\nambiguously to multiple coordinates in the genome. By convention, each read\nhas one and only one alignment where both `secondaryAlignment`\nand `supplementaryAlignment` are false.", - "type": "boolean" - }, - "fragmentName": { - "description": "The fragment name. Equivalent to QNAME (query template name) in SAM.", - "type": "string" - }, - "readGroupSetId": { - "description": "The ID of the read group set this read belongs to. A read belongs to\nexactly one read group set.", - "type": "string" - }, - "duplicateFragment": { - "description": "The fragment is a PCR or optical duplicate (SAM flag 0x400).", - "type": "boolean" - }, - "readNumber": { - "description": "The read number in sequencing. 0-based and less than numberReads. This\nfield replaces SAM flag 0x40 and 0x80.", - "format": "int32", - "type": "integer" } - } + }, + "id": "Read" }, "ReferenceSet": { "id": "ReferenceSet", "description": "A reference set is a set of references which typically comprise a reference\nassembly for a species, such as `GRCh38` which is representative\nof the human genome. A reference set defines a common coordinate space for\ncomparing reference-aligned experimental data. A reference set contains 1 or\nmore references.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "type": "object", "properties": { - "sourceAccessions": { - "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.", - "type": "array", - "items": { - "type": "string" - } - }, - "description": { - "description": "Free text description of this reference set.", - "type": "string" - }, "sourceUri": { "description": "The URI from which the references were obtained.", "type": "string" @@ -2899,6 +2599,17 @@ "id": { "description": "The server-generated reference set ID, unique across all reference sets.", "type": "string" + }, + "sourceAccessions": { + "description": "All known corresponding accession IDs in INSDC (GenBank/ENA/DDBJ) ideally\nwith a version number, for example `NC_000001.11`.", + "type": "array", + "items": { + "type": "string" + } + }, + "description": { + "description": "Free text description of this reference set.", + "type": "string" } } }, @@ -2913,7 +2624,6 @@ "type": "string" }, "operation": { - "type": "string", "enumDescriptions": [ "", "An alignment match indicates that a sequence can be aligned to the\nreference without evidence of an INDEL. Unlike the\n`SEQUENCE_MATCH` and `SEQUENCE_MISMATCH` operators,\nthe `ALIGNMENT_MATCH` operator does not indicate whether the\nreference and read sequences are an exact match. This operator is\nequivalent to SAM's `M`.", @@ -2937,7 +2647,8 @@ "PAD", "SEQUENCE_MATCH", "SEQUENCE_MISMATCH" - ] + ], + "type": "string" }, "referenceSequence": { "description": "`referenceSequence` is only used at mismatches\n(`SEQUENCE_MISMATCH`) and deletions (`DELETE`).\nFilling this field replaces SAM's MD tag. If the relevant information is\nnot available, this field is unset.", @@ -2968,17 +2679,10 @@ "id": "Transcript" }, "AnnotationSet": { + "id": "AnnotationSet", "description": "An annotation set is a logical grouping of annotations that share consistent\ntype information and provenance. Examples of annotation sets include 'all\ngenes from refseq', and 'all variant annotations from ClinVar'.", "type": "object", "properties": { - "datasetId": { - "description": "The dataset to which this annotation set belongs.", - "type": "string" - }, - "sourceUri": { - "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.", - "type": "string" - }, "name": { "description": "The display name for this annotation set.", "type": "string" @@ -2988,6 +2692,8 @@ "type": "string" }, "type": { + "description": "The type of annotations contained within this set.", + "type": "string", "enumDescriptions": [ "", "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.", @@ -3001,28 +2707,34 @@ "VARIANT", "GENE", "TRANSCRIPT" - ], - "description": "The type of annotations contained within this set.", - "type": "string" + ] }, "info": { - "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", - "type": "object", "additionalProperties": { "type": "array", "items": { "type": "any" } - } + }, + "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", + "type": "object" }, "id": { "description": "The server-generated annotation set ID, unique across all annotation sets.", "type": "string" + }, + "datasetId": { + "description": "The dataset to which this annotation set belongs.", + "type": "string" + }, + "sourceUri": { + "description": "The source URI describing the file from which this annotation set was\ngenerated, if any.", + "type": "string" } - }, - "id": "AnnotationSet" + } }, "Experiment": { + "id": "Experiment", "type": "object", "properties": { "sequencingCenter": { @@ -3041,10 +2753,10 @@ "description": "The instrument model used as part of this experiment. This maps to\nsequencing technology in the SAM spec.", "type": "string" } - }, - "id": "Experiment" + } }, "ListDatasetsResponse": { + "id": "ListDatasetsResponse", "description": "The dataset list response.", "type": "object", "properties": { @@ -3059,10 +2771,10 @@ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", "type": "string" } - }, - "id": "ListDatasetsResponse" + } }, "TestIamPermissionsRequest": { + "id": "TestIamPermissionsRequest", "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { @@ -3073,10 +2785,10 @@ "type": "string" } } - }, - "id": "TestIamPermissionsRequest" + } }, "ExportReadGroupSetRequest": { + "id": "ExportReadGroupSetRequest", "description": "The read group set export request.", "type": "object", "properties": { @@ -3095,11 +2807,9 @@ "description": "Required. The Google Cloud project ID that owns this\nexport. The caller must have WRITE access to this project.", "type": "string" } - }, - "id": "ExportReadGroupSetRequest" + } }, "Exon": { - "id": "Exon", "type": "object", "properties": { "end": { @@ -3117,12 +2827,27 @@ "format": "int64", "type": "string" } - } + }, + "id": "Exon" }, "CallSet": { + "id": "CallSet", "description": "A call set is a collection of variant calls, typically for one sample. It\nbelongs to a variant set.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "type": "object", "properties": { + "id": { + "description": "The server-generated call set ID, unique across all call sets.", + "type": "string" + }, + "created": { + "description": "The date this call set was created in milliseconds from the epoch.", + "format": "int64", + "type": "string" + }, + "sampleId": { + "description": "The sample ID this call set corresponds to.", + "type": "string" + }, "name": { "description": "The call set name.", "type": "string" @@ -3143,47 +2868,45 @@ "items": { "type": "string" } - }, - "id": { - "description": "The server-generated call set ID, unique across all call sets.", - "type": "string" - }, - "created": { - "description": "The date this call set was created in milliseconds from the epoch.", - "format": "int64", - "type": "string" - }, - "sampleId": { - "description": "The sample ID this call set corresponds to.", - "type": "string" } - }, - "id": "CallSet" + } }, "SearchAnnotationSetsResponse": { - "id": "SearchAnnotationSetsResponse", "type": "object", "properties": { + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" + }, "annotationSets": { "description": "The matching annotation sets.", "type": "array", "items": { "$ref": "AnnotationSet" } - }, - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" } - } + }, + "id": "SearchAnnotationSetsResponse" }, "ImportVariantsRequest": { "description": "The variant data import request.", "type": "object", "properties": { + "format": { + "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.", + "type": "string", + "enumDescriptions": [ + "", + "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.", + "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed." + ], + "enum": [ + "FORMAT_UNSPECIFIED", + "FORMAT_VCF", + "FORMAT_COMPLETE_GENOMICS" + ] + }, "infoMergeConfig": { - "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.", - "type": "object", "additionalProperties": { "enum": [ "INFO_MERGE_OPERATION_UNSPECIFIED", @@ -3191,7 +2914,9 @@ "MOVE_TO_CALLS" ], "type": "string" - } + }, + "description": "A mapping between info field keys and the InfoMergeOperations to\nbe performed on them. This is plumbed down to the MergeVariantRequests\ngenerated by the resulting import job.", + "type": "object" }, "variantSetId": { "description": "Required. The variant set to which variant data should be imported.", @@ -3207,28 +2932,17 @@ "normalizeReferenceNames": { "description": "Convert reference names to the canonical representation.\nhg19 haploytypes (those reference names containing \"_hap\")\nare not modified in any way.\nAll other reference names are modified according to the following rules:\nThe reference name is capitalized.\nThe \"chr\" prefix is dropped for all autosomes and sex chromsomes.\nFor example \"chr17\" becomes \"17\" and \"chrX\" becomes \"X\".\nAll mitochondrial chromosomes (\"chrM\", \"chrMT\", etc) become \"MT\".", "type": "boolean" - }, - "format": { - "enumDescriptions": [ - "", - "VCF (Variant Call Format). The VCF files may be gzip compressed. gVCF is\nalso supported. Disclaimer: gzip VCF imports are currently much slower\nthan equivalent uncompressed VCF imports. For this reason, uncompressed\nVCF is currently recommended for imports with more than 1GB combined\nuncompressed size, or for time sensitive imports.", - "Complete Genomics masterVarBeta format. The masterVarBeta files may\nbe bzip2 compressed." - ], - "enum": [ - "FORMAT_UNSPECIFIED", - "FORMAT_VCF", - "FORMAT_COMPLETE_GENOMICS" - ], - "description": "The format of the variant data being imported. If unspecified, defaults to\nto `VCF`.", - "type": "string" } }, "id": "ImportVariantsRequest" }, "ListCoverageBucketsResponse": { - "id": "ListCoverageBucketsResponse", "type": "object", "properties": { + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" + }, "bucketWidth": { "description": "The length of each coverage bucket in base pairs. Note that buckets at the\nend of a reference sequence may be shorter. This value is omitted if the\nbucket width is infinity (the default behaviour, with no range or\n`targetBucketWidth`).", "format": "int64", @@ -3240,84 +2954,14 @@ "items": { "$ref": "CoverageBucket" } - }, - "nextPageToken": { - "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", - "type": "string" } - } + }, + "id": "ListCoverageBucketsResponse" }, "VariantAnnotation": { + "id": "VariantAnnotation", "type": "object", "properties": { - "type": { - "enumDescriptions": [ - "", - "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.", - "`INSERTION` indicates an insertion.", - "`DELETION` indicates a deletion.", - "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.", - "`SNP` indicates a single nucleotide polymorphism.", - "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.", - "`CNV` indicates a variation in copy number." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "TYPE_OTHER", - "INSERTION", - "DELETION", - "SUBSTITUTION", - "SNP", - "STRUCTURAL", - "CNV" - ], - "description": "Type has been adapted from ClinVar's list of variant types.", - "type": "string" - }, - "alternateBases": { - "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.", - "type": "string" - }, - "geneId": { - "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.", - "type": "string" - }, - "clinicalSignificance": { - "enumDescriptions": [ - "", - "`OTHER` should be used when no other clinical significance\nvalue will suffice.", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "", - "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field." - ], - "enum": [ - "CLINICAL_SIGNIFICANCE_UNSPECIFIED", - "CLINICAL_SIGNIFICANCE_OTHER", - "UNCERTAIN", - "BENIGN", - "LIKELY_BENIGN", - "LIKELY_PATHOGENIC", - "PATHOGENIC", - "DRUG_RESPONSE", - "HISTOCOMPATIBILITY", - "CONFERS_SENSITIVITY", - "RISK_FACTOR", - "ASSOCIATION", - "PROTECTIVE", - "MULTIPLE_REPORTED" - ], - "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/", - "type": "string" - }, "conditions": { "description": "The set of conditions associated with this variant.\nA condition describes the way a variant influences human health.", "type": "array", @@ -3357,9 +3001,76 @@ "items": { "type": "string" } + }, + "type": { + "description": "Type has been adapted from ClinVar's list of variant types.", + "type": "string", + "enumDescriptions": [ + "", + "`TYPE_OTHER` should be used when no other Type will suffice.\nFurther explanation of the variant type may be included in the\ninfo field.", + "`INSERTION` indicates an insertion.", + "`DELETION` indicates a deletion.", + "`SUBSTITUTION` indicates a block substitution of\ntwo or more nucleotides.", + "`SNP` indicates a single nucleotide polymorphism.", + "`STRUCTURAL` indicates a large structural variant,\nincluding chromosomal fusions, inversions, etc.", + "`CNV` indicates a variation in copy number." + ], + "enum": [ + "TYPE_UNSPECIFIED", + "TYPE_OTHER", + "INSERTION", + "DELETION", + "SUBSTITUTION", + "SNP", + "STRUCTURAL", + "CNV" + ] + }, + "alternateBases": { + "description": "The alternate allele for this variant. If multiple alternate alleles\nexist at this location, create a separate variant for each one, as they\nmay represent distinct conditions.", + "type": "string" + }, + "geneId": { + "description": "Google annotation ID of the gene affected by this variant. This should\nbe provided when the variant is created.", + "type": "string" + }, + "clinicalSignificance": { + "description": "Describes the clinical significance of a variant.\nIt is adapted from the ClinVar controlled vocabulary for clinical\nsignificance described at:\nhttp://www.ncbi.nlm.nih.gov/clinvar/docs/clinsig/", + "type": "string", + "enumDescriptions": [ + "", + "`OTHER` should be used when no other clinical significance\nvalue will suffice.", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "", + "`MULTIPLE_REPORTED` should be used when multiple clinical\nsignficances are reported for a variant. The original clinical\nsignificance values may be provided in the `info` field." + ], + "enum": [ + "CLINICAL_SIGNIFICANCE_UNSPECIFIED", + "CLINICAL_SIGNIFICANCE_OTHER", + "UNCERTAIN", + "BENIGN", + "LIKELY_BENIGN", + "LIKELY_PATHOGENIC", + "PATHOGENIC", + "DRUG_RESPONSE", + "HISTOCOMPATIBILITY", + "CONFERS_SENSITIVITY", + "RISK_FACTOR", + "ASSOCIATION", + "PROTECTIVE", + "MULTIPLE_REPORTED" + ] } - }, - "id": "VariantAnnotation" + } }, "ExportVariantSetRequest": { "id": "ExportVariantSetRequest", @@ -3400,6 +3111,7 @@ } }, "SearchAnnotationsRequest": { + "id": "SearchAnnotationsRequest", "type": "object", "properties": { "annotationSetIds": { @@ -3436,8 +3148,7 @@ "format": "int64", "type": "string" } - }, - "id": "SearchAnnotationsRequest" + } }, "OperationEvent": { "description": "An event that occurred during an Operation.", @@ -3464,13 +3175,13 @@ "id": "CodingSequence", "type": "object", "properties": { - "end": { - "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.", + "start": { + "description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.", "format": "int64", "type": "string" }, - "start": { - "description": "The start of the coding sequence on this annotation's reference sequence,\n0-based inclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.", + "end": { + "description": "The end of the coding sequence on this annotation's reference sequence,\n0-based exclusive. Note that this position is relative to the reference\nstart, and *not* the containing annotation start.", "format": "int64", "type": "string" } @@ -3491,10 +3202,10 @@ "id": "TestIamPermissionsResponse" }, "GetIamPolicyRequest": { + "id": "GetIamPolicyRequest", "description": "Request message for `GetIamPolicy` method.", "type": "object", - "properties": {}, - "id": "GetIamPolicyRequest" + "properties": {} }, "SearchReferencesResponse": { "type": "object", @@ -3524,25 +3235,25 @@ } }, "types": { - "enumDescriptions": [ - "", - "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.", - "A `VARIANT` annotation type.", - "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.", - "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA." - ], "description": "If specified, only annotation sets that have any of these types are\nreturned.", "type": "array", "items": { - "type": "string", "enum": [ "ANNOTATION_TYPE_UNSPECIFIED", "GENERIC", "VARIANT", "GENE", "TRANSCRIPT" - ] - } + ], + "type": "string" + }, + "enumDescriptions": [ + "", + "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.", + "A `VARIANT` annotation type.", + "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.", + "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA." + ] }, "name": { "description": "Only return annotations sets for which a substring of the name matches this\nstring (case insensitive).", @@ -3565,6 +3276,7 @@ "id": "SearchAnnotationSetsRequest" }, "SearchReadGroupSetsResponse": { + "id": "SearchReadGroupSetsResponse", "description": "The read group set search response.", "type": "object", "properties": { @@ -3579,8 +3291,7 @@ "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", "type": "string" } - }, - "id": "SearchReadGroupSetsResponse" + } }, "LinearAlignment": { "id": "LinearAlignment", @@ -3588,8 +3299,8 @@ "type": "object", "properties": { "position": { - "description": "The position of this alignment.", - "$ref": "Position" + "$ref": "Position", + "description": "The position of this alignment." }, "cigar": { "description": "Represents the local alignment of this sequence (alignment matches, indels,\netc) against the reference.", @@ -3639,6 +3350,7 @@ "id": "SearchReferencesRequest" }, "Dataset": { + "id": "Dataset", "description": "A Dataset is a collection of genomic data.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "type": "object", "properties": { @@ -3659,8 +3371,7 @@ "description": "The Google Cloud project ID that this dataset belongs to.", "type": "string" } - }, - "id": "Dataset" + } }, "ImportVariantsResponse": { "description": "The variant data import response.", @@ -3677,9 +3388,28 @@ "id": "ImportVariantsResponse" }, "ReadGroup": { + "id": "ReadGroup", "description": "A read group is all the data that's processed the same way by the sequencer.", "type": "object", "properties": { + "name": { + "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.", + "type": "string" + }, + "referenceSetId": { + "description": "The reference set the reads in this read group are aligned to.", + "type": "string" + }, + "info": { + "additionalProperties": { + "type": "array", + "items": { + "type": "any" + } + }, + "description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", + "type": "object" + }, "id": { "description": "The server-generated read group ID, unique for all read groups.\nNote: This is different than the @RG ID field in the SAM spec. For that\nvalue, see name.", "type": "string" @@ -3709,32 +3439,12 @@ "type": "string" }, "experiment": { - "description": "The experiment used to generate this read group.", - "$ref": "Experiment" - }, - "name": { - "description": "The read group name. This corresponds to the @RG ID field in the SAM spec.", - "type": "string" - }, - "referenceSetId": { - "description": "The reference set the reads in this read group are aligned to.", - "type": "string" - }, - "info": { - "description": "A map of additional read group information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", - "type": "object", - "additionalProperties": { - "type": "array", - "items": { - "type": "any" - } - } + "$ref": "Experiment", + "description": "The experiment used to generate this read group." } - }, - "id": "ReadGroup" + } }, "ReadGroupSet": { - "id": "ReadGroupSet", "description": "A read group set is a logical collection of read groups, which are\ncollections of reads produced by a sequencer. A read group set typically\nmodels reads corresponding to one sample, sequenced one way, and aligned one\nway.\n\n* A read group set belongs to one dataset.\n* A read group belongs to one read group set.\n* A read belongs to one read group.\n\nFor more genomics resource definitions, see [Fundamentals of Google\nGenomics](https://cloud.google.com/genomics/fundamentals-of-google-genomics)", "type": "object", "properties": { @@ -3775,12 +3485,302 @@ "description": "The server-generated read group set ID, unique for all read group sets.", "type": "string" } + }, + "id": "ReadGroupSet" + }, + "SearchVariantSetsResponse": { + "id": "SearchVariantSetsResponse", + "description": "The search variant sets response.", + "type": "object", + "properties": { + "variantSets": { + "description": "The variant sets belonging to the requested dataset.", + "type": "array", + "items": { + "$ref": "VariantSet" + } + }, + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" + } } + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "Entry": { + "type": "object", + "properties": { + "status": { + "description": "The creation status.", + "$ref": "Status" + }, + "annotation": { + "$ref": "Annotation", + "description": "The created annotation, if creation was successful." + } + }, + "id": "Entry" + }, + "Position": { + "description": "An abstraction for referring to a genomic position, in relation to some\nalready known reference. For now, represents a genomic position as a\nreference name, a base number on that reference (0-based), and a\ndetermination of forward or reverse strand.", + "type": "object", + "properties": { + "position": { + "description": "The 0-based offset from the start of the forward strand for that reference.", + "format": "int64", + "type": "string" + }, + "referenceName": { + "description": "The name of the reference in whatever reference set is being used.", + "type": "string" + }, + "reverseStrand": { + "description": "Whether this position is on the reverse strand, as opposed to the forward\nstrand.", + "type": "boolean" + } + }, + "id": "Position" + }, + "SearchReferenceSetsResponse": { + "type": "object", + "properties": { + "referenceSets": { + "description": "The matching references sets.", + "type": "array", + "items": { + "$ref": "ReferenceSet" + } + }, + "nextPageToken": { + "description": "The continuation token, which is used to page through large result sets.\nProvide this value in a subsequent request to return the next page of\nresults. This field will be empty if there aren't any additional results.", + "type": "string" + } + }, + "id": "SearchReferenceSetsResponse" + }, + "SearchCallSetsRequest": { + "id": "SearchCallSetsRequest", + "description": "The call set search request.", + "type": "object", + "properties": { + "name": { + "description": "Only return call sets for which a substring of the name matches this\nstring.", + "type": "string" + }, + "pageToken": { + "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 1024.", + "format": "int32", + "type": "integer" + }, + "variantSetIds": { + "description": "Restrict the query to call sets within the given variant sets. At least one\nID must be provided.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ImportReadGroupSetsRequest": { + "id": "ImportReadGroupSetsRequest", + "description": "The read group set import request.", + "type": "object", + "properties": { + "referenceSetId": { + "description": "The reference set to which the imported read group sets are aligned to, if\nany. The reference names of this reference set must be a superset of those\nfound in the imported file headers. If no reference set id is provided, a\nbest effort is made to associate with a matching reference set.", + "type": "string" + }, + "partitionStrategy": { + "description": "The partition strategy describes how read groups are partitioned into read\ngroup sets.", + "type": "string", + "enumDescriptions": [ + "", + "In most cases, this strategy yields one read group set per file. This is\nthe default behavior.\n\nAllocate one read group set per file per sample. For BAM files, read\ngroups are considered to share a sample if they have identical sample\nnames. Furthermore, all reads for each file which do not belong to a read\ngroup, if any, will be grouped into a single read group set per-file.", + "Includes all read groups in all imported files into a single read group\nset. Requires that the headers for all imported files are equivalent. All\nreads which do not belong to a read group, if any, will be grouped into a\nseparate read group set." + ], + "enum": [ + "PARTITION_STRATEGY_UNSPECIFIED", + "PER_FILE_PER_SAMPLE", + "MERGE_ALL" + ] + }, + "datasetId": { + "description": "Required. The ID of the dataset these read group sets will belong to. The\ncaller must have WRITE permissions to this dataset.", + "type": "string" + }, + "sourceUris": { + "description": "A list of URIs pointing at [BAM\nfiles](https://samtools.github.io/hts-specs/SAMv1.pdf)\nin Google Cloud Storage.\nThose URIs can include wildcards (*), but do not add or remove\nmatching files before import has completed.\n\nNote that Google Cloud Storage object listing is only eventually\nconsistent: files added may be not be immediately visible to\neveryone. Thus, if using a wildcard it is preferable not to start\nthe import immediately after the files are created.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Policy": { + "id": "Policy", + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", + "type": "object", + "properties": { + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32", + "type": "integer" + }, + "bindings": { + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + } + } + }, + "Annotation": { + "description": "An annotation describes a region of reference genome. The value of an\nannotation may be one of several canonical types, supplemented by arbitrary\ninfo tags. An annotation is not inherently associated with a specific\nsample or individual (though a client could choose to use annotations in\nthis way). Example canonical annotation types are `GENE` and\n`VARIANT`.", + "type": "object", + "properties": { + "info": { + "description": "A map of additional read alignment information. This must be of the form\nmap\u003cstring, string[]\u003e (string key mapping to a list of string values).", + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "any" + } + } + }, + "type": { + "description": "The data type for this annotation. Must match the containing annotation\nset's type.", + "type": "string", + "enumDescriptions": [ + "", + "A `GENERIC` annotation type should be used when no other annotation\ntype will suffice. This represents an untyped annotation of the reference\ngenome.", + "A `VARIANT` annotation type.", + "A `GENE` annotation type represents the existence of a gene at the\nassociated reference coordinates. The start coordinate is typically the\ngene's transcription start site and the end is typically the end of the\ngene's last exon.", + "A `TRANSCRIPT` annotation type represents the assertion that a\nparticular region of the reference genome may be transcribed as RNA." + ], + "enum": [ + "ANNOTATION_TYPE_UNSPECIFIED", + "GENERIC", + "VARIANT", + "GENE", + "TRANSCRIPT" + ] + }, + "end": { + "description": "The end position of the range on the reference, 0-based exclusive.", + "format": "int64", + "type": "string" + }, + "transcript": { + "$ref": "Transcript", + "description": "A transcript value represents the assertion that a particular region of\nthe reference genome may be transcribed as RNA. An alternative splicing\npattern would be represented as a separate transcript object. This field\nis only set for annotations of type `TRANSCRIPT`." + }, + "start": { + "description": "The start position of the range on the reference, 0-based inclusive.", + "format": "int64", + "type": "string" + }, + "annotationSetId": { + "description": "The annotation set to which this annotation belongs.", + "type": "string" + }, + "name": { + "description": "The display name of this annotation.", + "type": "string" + }, + "variant": { + "$ref": "VariantAnnotation", + "description": "A variant annotation, which describes the effect of a variant on the\ngenome, the coding sequence, and/or higher level consequences at the\norganism level e.g. pathogenicity. This field is only set for annotations\nof type `VARIANT`." + }, + "id": { + "description": "The server-generated annotation ID, unique across all annotations.", + "type": "string" + }, + "referenceId": { + "description": "The ID of the Google Genomics reference associated with this range.", + "type": "string" + }, + "reverseStrand": { + "description": "Whether this range refers to the reverse strand, as opposed to the forward\nstrand. Note that regardless of this field, the start/end position of the\nrange always refer to the forward strand.", + "type": "boolean" + }, + "referenceName": { + "description": "The display name corresponding to the reference specified by\n`referenceId`, for example `chr1`, `1`, or `chrX`.", + "type": "string" + } + }, + "id": "Annotation" + }, + "CancelOperationRequest": { + "id": "CancelOperationRequest", + "description": "The request message for Operations.CancelOperation.", + "type": "object", + "properties": {} + }, + "SearchReadsRequest": { + "description": "The read search request.", + "type": "object", + "properties": { + "referenceName": { + "description": "The reference sequence name, for example `chr1`, `1`, or `chrX`. If set to\n`*`, only unmapped reads are returned. If unspecified, all reads (mapped\nand unmapped) are returned.", + "type": "string" + }, + "readGroupSetIds": { + "description": "The IDs of the read groups sets within which to search for reads. All\nspecified read group sets must be aligned against a common set of reference\nsequences; this defines the genomic coordinates for the query. Must specify\none of `readGroupSetIds` or `readGroupIds`.", + "type": "array", + "items": { + "type": "string" + } + }, + "readGroupIds": { + "description": "The IDs of the read groups within which to search for reads. All specified\nread groups must belong to the same read group sets. Must specify one of\n`readGroupSetIds` or `readGroupIds`.", + "type": "array", + "items": { + "type": "string" + } + }, + "end": { + "description": "The end position of the range on the reference, 0-based exclusive. If\nspecified, `referenceName` must also be specified.", + "format": "int64", + "type": "string" + }, + "pageToken": { + "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of results to return in a single page. If unspecified,\ndefaults to 256. The maximum value is 2048.", + "format": "int32", + "type": "integer" + }, + "start": { + "description": "The start position of the range on the reference, 0-based inclusive. If\nspecified, `referenceName` must also be specified.", + "format": "int64", + "type": "string" + } + }, + "id": "SearchReadsRequest" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "version": "v1", @@ -3788,6 +3788,9 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/genomics": { + "description": "View and manage Genomics data" + }, "https://www.googleapis.com/auth/bigquery": { "description": "View and manage your data in Google BigQuery" }, @@ -3799,9 +3802,6 @@ }, "https://www.googleapis.com/auth/genomics.readonly": { "description": "View Genomics data" - }, - "https://www.googleapis.com/auth/genomics": { - "description": "View and manage Genomics data" } } }
diff --git a/genomics/v1alpha2/genomics-api.json b/genomics/v1alpha2/genomics-api.json index 98d5308..cbcd591 100644 --- a/genomics/v1alpha2/genomics-api.json +++ b/genomics/v1alpha2/genomics-api.json
@@ -1,1002 +1,32 @@ { - "rootUrl": "https://genomics.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "genomics", - "batchPath": "batch", - "revision": "20171221", - "documentationLink": "https://cloud.google.com/genomics", - "id": "genomics:v1alpha2", - "title": "Genomics API", - "discoveryVersion": "v1", - "ownerName": "Google", - "resources": { - "pipelines": { - "methods": { - "get": { - "response": { - "$ref": "Pipeline" - }, - "parameterOrder": [ - "pipelineId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": { - "pipelineId": { - "location": "path", - "description": "Caller must have READ access to the project in which this pipeline\nis defined.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1alpha2/pipelines/{pipelineId}", - "path": "v1alpha2/pipelines/{pipelineId}", - "id": "genomics.pipelines.get", - "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project." - }, - "setOperationStatus": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": {}, - "flatPath": "v1alpha2/pipelines:setOperationStatus", - "path": "v1alpha2/pipelines:setOperationStatus", - "id": "genomics.pipelines.setOperationStatus", - "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.", - "request": { - "$ref": "SetOperationStatusRequest" - } - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "pipelineId" - ], - "httpMethod": "DELETE", - "parameters": { - "pipelineId": { - "location": "path", - "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1alpha2/pipelines/{pipelineId}", - "path": "v1alpha2/pipelines/{pipelineId}", - "id": "genomics.pipelines.delete", - "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project." - }, - "getControllerConfig": { - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ControllerConfig" - }, - "parameters": { - "operationId": { - "location": "query", - "description": "The operation to retrieve controller configuration for.", - "type": "string" - }, - "validationToken": { - "location": "query", - "format": "uint64", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1alpha2/pipelines:getControllerConfig", - "id": "genomics.pipelines.getControllerConfig", - "path": "v1alpha2/pipelines:getControllerConfig", - "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users." - }, - "list": { - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListPipelinesResponse" - }, - "parameters": { - "namePrefix": { - "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.", - "type": "string", - "location": "query" - }, - "pageToken": { - "location": "query", - "description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.", - "type": "string" - }, - "pageSize": { - "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "projectId": { - "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1alpha2/pipelines", - "id": "genomics.pipelines.list", - "path": "v1alpha2/pipelines", - "description": "Lists pipelines.\n\nCaller must have READ permission to the project." - }, - "create": { - "path": "v1alpha2/pipelines", - "id": "genomics.pipelines.create", - "request": { - "$ref": "Pipeline" - }, - "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project.", - "response": { - "$ref": "Pipeline" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1alpha2/pipelines" - }, - "run": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1alpha2/pipelines:run", - "path": "v1alpha2/pipelines:run", - "id": "genomics.pipelines.run", - "request": { - "$ref": "RunPipelineRequest" - }, - "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled." - } - } - }, - "operations": { - "methods": { - "cancel": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^operations/.+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "flatPath": "v1alpha2/operations/{operationsId}:cancel", - "id": "genomics.operations.cancel", - "path": "v1alpha2/{+name}:cancel", - "request": { - "$ref": "CancelOperationRequest" - }, - "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation." - }, - "list": { - "path": "v1alpha2/{+name}", - "id": "genomics.operations.list", - "description": "Lists operations that match the specified filter in the request.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": { - "name": { - "pattern": "^operations$", - "location": "path", - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`", - "type": "string" - } - }, - "flatPath": "v1alpha2/operations" - }, - "get": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/genomics" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^operations/.+$", - "location": "path" - } - }, - "flatPath": "v1alpha2/operations/{operationsId}", - "path": "v1alpha2/{+name}", - "id": "genomics.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." - } - } - } - }, - "parameters": { - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - } - }, "schemas": { - "PipelineParameter": { - "properties": { - "name": { - "description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.", - "type": "string" - }, - "description": { - "description": "Human-readable description.", - "type": "string" - }, - "localCopy": { - "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be.", - "$ref": "LocalCopy" - }, - "defaultValue": { - "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.", - "type": "string" - } - }, - "id": "PipelineParameter", - "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.", - "type": "object" - }, - "LoggingOptions": { - "description": "The logging options for the pipeline run.", - "type": "object", - "properties": { - "gcsPath": { - "description": "The location in Google Cloud Storage to which the pipeline logs\nwill be copied. Can be specified as a fully qualified directory\npath, in which case logs will be output with a unique identifier\nas the filename in that directory, or as a fully specified path,\nwhich must end in `.log`, in which case that path will be\nused, and the user must ensure that logs are not\noverwritten. Stdout and stderr logs from the run are also\ngenerated and output as `-stdout.log` and `-stderr.log`.", - "type": "string" - } - }, - "id": "LoggingOptions" - }, - "RunPipelineRequest": { - "properties": { - "ephemeralPipeline": { - "$ref": "Pipeline", - "description": "A new pipeline object to run once and then delete." - }, - "pipelineArgs": { - "description": "The arguments to use when running this pipeline.", - "$ref": "RunPipelineArgs" - }, - "pipelineId": { - "description": "The already created pipeline to run.", - "type": "string" - } - }, - "id": "RunPipelineRequest", - "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.", - "type": "object" - }, - "CancelOperationRequest": { - "properties": {}, - "id": "CancelOperationRequest", - "description": "The request message for Operations.CancelOperation.", - "type": "object" - }, - "RuntimeMetadata": { - "properties": { - "computeEngine": { - "description": "Execution information specific to Google Compute Engine.", - "$ref": "ComputeEngine" - } - }, - "id": "RuntimeMetadata", - "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.", - "type": "object" - }, - "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.", - "type": "any" - }, - "description": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.", - "type": "object" - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", - "type": "string" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "An OperationMetadata object. This will always be returned with the Operation.", - "type": "object" - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object" - }, - "ImportReadGroupSetsResponse": { - "properties": { - "readGroupSetIds": { - "description": "IDs of the read group sets that were created.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "ImportReadGroupSetsResponse", - "description": "The read group set import response.", - "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.", - "type": "object", - "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 is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - } - }, - "id": "Status" - }, - "ServiceAccount": { - "properties": { - "email": { - "description": "Email address of the service account. Defaults to `default`,\nwhich uses the compute service account associated with the project.", - "type": "string" - }, - "scopes": { - "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "ServiceAccount", - "description": "A Google Cloud Service Account.", - "type": "object" - }, - "PipelineResources": { - "properties": { - "zones": { - "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.", - "type": "array", - "items": { - "type": "string" - } - }, - "acceleratorCount": { - "description": "Optional. The number of accelerators of the specified type to attach.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances:\nNVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.", - "format": "int64", - "type": "string" - }, - "acceleratorType": { - "description": "Optional. The Compute Engine defined accelerator type.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances: NVIDIA®\nTesla® drivers and NVIDIA® CUDA toolkit.\nPlease see https://cloud.google.com/compute/docs/gpus/ for a list of\navailable accelerator types.", - "type": "string" - }, - "minimumCpuCores": { - "description": "The minimum number of cores to use. Defaults to 1.", - "format": "int32", - "type": "integer" - }, - "noAddress": { - "description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).", - "type": "boolean" - }, - "disks": { - "description": "Disks to attach.", - "type": "array", - "items": { - "$ref": "Disk" - } - }, - "bootDiskSizeGb": { - "description": "The size of the boot disk. Defaults to 10 (GB).", - "format": "int32", - "type": "integer" - }, - "minimumRamGb": { - "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)", - "format": "double", - "type": "number" - }, - "preemptible": { - "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.", - "type": "boolean" - } - }, - "id": "PipelineResources", - "description": "The system resources for the pipeline run.", - "type": "object" - }, - "Pipeline": { - "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.", - "type": "object", - "properties": { - "inputParameters": { - "description": "Input parameters of the pipeline.", - "type": "array", - "items": { - "$ref": "PipelineParameter" - } - }, - "resources": { - "$ref": "PipelineResources", - "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb" - }, - "name": { - "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.", - "type": "string" - }, - "projectId": { - "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.", - "type": "string" - }, - "pipelineId": { - "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.", - "type": "string" - }, - "outputParameters": { - "description": "Output parameters of the pipeline.", - "type": "array", - "items": { - "$ref": "PipelineParameter" - } - }, - "docker": { - "$ref": "DockerExecutor", - "description": "Specifies the docker run information." - }, - "description": { - "description": "User-specified description.", - "type": "string" - } - }, - "id": "Pipeline" - }, - "OperationEvent": { - "description": "An event that occurred during an Operation.", - "type": "object", - "properties": { - "startTime": { - "description": "Optional time of when event started.", - "format": "google-datetime", - "type": "string" - }, - "description": { - "description": "Required description of event.", - "type": "string" - }, - "endTime": { - "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "OperationEvent" - }, - "ControllerConfig": { - "properties": { - "machineType": { - "type": "string" - }, - "cmd": { - "type": "string" - }, - "vars": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - }, - "image": { - "type": "string" - }, - "gcsLogPath": { - "type": "string" - }, - "gcsSources": { - "additionalProperties": { - "$ref": "RepeatedString" - }, - "type": "object" - }, - "gcsSinks": { - "additionalProperties": { - "$ref": "RepeatedString" - }, - "type": "object" - }, - "disks": { - "additionalProperties": { - "type": "string" - }, - "type": "object" - } - }, - "id": "ControllerConfig", - "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.", - "type": "object" - }, - "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.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations.", - "type": "object" - }, - "RepeatedString": { - "properties": { - "values": { - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "RepeatedString", - "type": "object" - }, - "OperationMetadata": { - "properties": { - "startTime": { - "description": "The time at which the job began to run.", - "format": "google-datetime", - "type": "string" - }, - "request": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", - "type": "object" - }, - "runtimeMetadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Runtime metadata on this Operation.", - "type": "object" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", - "type": "object" - }, - "createTime": { - "description": "The time at which the job was submitted to the Genomics service.", - "format": "google-datetime", - "type": "string" - }, - "projectId": { - "description": "The Google Cloud Project in which the job is scoped.", - "type": "string" - }, - "clientId": { - "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.", - "type": "string" - }, - "endTime": { - "description": "The time at which the job stopped running.", - "format": "google-datetime", - "type": "string" - }, - "events": { - "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.", - "type": "array", - "items": { - "$ref": "OperationEvent" - } - } - }, - "id": "OperationMetadata", - "description": "Metadata describing an Operation.", - "type": "object" - }, - "ListPipelinesResponse": { - "properties": { - "nextPageToken": { - "description": "The token to use to get the next page of results.", - "type": "string" - }, - "pipelines": { - "description": "The matched pipelines.", - "type": "array", - "items": { - "$ref": "Pipeline" - } - } - }, - "id": "ListPipelinesResponse", - "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.", - "type": "object" - }, - "RunPipelineArgs": { - "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.", - "type": "object" - }, - "logging": { - "description": "Required. Logging options. Used by the service to communicate results\nto the user.", - "$ref": "LoggingOptions" - }, - "outputs": { - "additionalProperties": { - "type": "string" - }, - "description": "Pipeline output arguments; keys are defined in the pipeline\ndocumentation. All output parameters of without default values\nmust be specified. If parameters with defaults are specified\nhere, the defaults will be overridden.", - "type": "object" - }, - "resources": { - "description": "Specifies resource requirements/overrides for the pipeline run.", - "$ref": "PipelineResources" - }, - "keepVmAliveOnFailureDuration": { - "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.", - "format": "google-duration", - "type": "string" - }, - "projectId": { - "description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.", - "type": "string" - }, - "clientId": { - "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.", - "type": "string" - }, - "inputs": { - "additionalProperties": { - "type": "string" - }, - "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.", - "type": "object" - }, - "serviceAccount": { - "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used.", - "$ref": "ServiceAccount" - } - }, - "id": "RunPipelineArgs", - "description": "The pipeline run arguments.", - "type": "object" - }, - "SetOperationStatusRequest": { - "properties": { - "operationId": { - "type": "string" - }, - "errorMessage": { - "type": "string" - }, - "validationToken": { - "format": "uint64", - "type": "string" - }, - "errorCode": { - "enum": [ - "OK", - "CANCELLED", - "UNKNOWN", - "INVALID_ARGUMENT", - "DEADLINE_EXCEEDED", - "NOT_FOUND", - "ALREADY_EXISTS", - "PERMISSION_DENIED", - "UNAUTHENTICATED", - "RESOURCE_EXHAUSTED", - "FAILED_PRECONDITION", - "ABORTED", - "OUT_OF_RANGE", - "UNIMPLEMENTED", - "INTERNAL", - "UNAVAILABLE", - "DATA_LOSS" - ], - "type": "string", - "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" - ] - }, - "timestampEvents": { - "type": "array", - "items": { - "$ref": "TimestampEvent" - } - } - }, - "id": "SetOperationStatusRequest", - "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.", - "type": "object" - }, - "ComputeEngine": { - "properties": { - "machineType": { - "description": "The machine type of the instance.", - "type": "string" - }, - "diskNames": { - "description": "The names of the disks that were created for this pipeline.", - "type": "array", - "items": { - "type": "string" - } - }, - "instanceName": { - "description": "The instance on which the operation is running.", - "type": "string" - }, - "zone": { - "description": "The availability zone in which the instance resides.", - "type": "string" - } - }, - "id": "ComputeEngine", - "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.", - "type": "object" - }, - "ImportVariantsResponse": { - "description": "The variant data import response.", - "type": "object", - "properties": { - "callSetIds": { - "description": "IDs of the call sets created during the import.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "ImportVariantsResponse" - }, "TimestampEvent": { + "description": "Stores the list of events and times they occured for major events in job\nexecution.", + "type": "object", "properties": { - "description": { - "description": "String indicating the type of event", - "type": "string" - }, "timestamp": { "description": "The time this event occured.", "format": "google-datetime", "type": "string" + }, + "description": { + "description": "String indicating the type of event", + "type": "string" } }, - "id": "TimestampEvent", - "description": "Stores the list of events and times they occured for major events in job\nexecution.", - "type": "object" + "id": "TimestampEvent" }, "LocalCopy": { "description": "LocalCopy defines how a remote file should be copied to and from the VM.", "type": "object", "properties": { - "path": { - "description": "Required. The path within the user's docker container where\nthis input should be localized to and from, relative to the specified\ndisk's mount point. For example: file.txt,", - "type": "string" - }, "disk": { "description": "Required. The name of the disk where this parameter is\nlocated. Can be the name of one of the disks specified in the\nResources field, or \"boot\", which represents the Docker\ninstance's boot disk and has a mount point of `/`.", "type": "string" + }, + "path": { + "description": "Required. The path within the user's docker container where\nthis input should be localized to and from, relative to the specified\ndisk's mount point. For example: file.txt,", + "type": "string" } }, "id": "LocalCopy" @@ -1005,25 +35,35 @@ "description": "The Docker execuctor specification.", "type": "object", "properties": { - "cmd": { - "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.", - "type": "string" - }, "imageName": { "description": "Required. Image name from either Docker Hub or Google Container Registry.\nUsers that run pipelines must have READ access to the image.", "type": "string" + }, + "cmd": { + "description": "Required. The command or newline delimited script to run. The command\nstring will be executed within a bash shell.\n\nIf the command exits with a non-zero exit code, output parameter\nde-localization will be skipped and the pipeline operation's\n`error` field will be populated.\n\nMaximum command string length is 16384.", + "type": "string" } }, "id": "DockerExecutor" }, "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" + "type": "object", + "properties": {}, + "id": "Empty" }, "Disk": { + "description": "A Google Compute Engine disk resource specification.", + "type": "object", "properties": { + "readOnly": { + "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time.", + "type": "boolean" + }, + "source": { + "description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.", + "type": "string" + }, "name": { "description": "Required. The name of the disk that can be used in the pipeline\nparameters. Must be 1 - 63 characters.\nThe name \"boot\" is reserved for system use.", "type": "string" @@ -1056,24 +96,605 @@ "mountPoint": { "description": "Required at create time and cannot be overridden at run time.\nSpecifies the path in the docker container where files on\nthis disk should be located. For example, if `mountPoint`\nis `/mnt/disk`, and the parameter has `localPath`\n`inputs/file.txt`, the docker container can access the data at\n`/mnt/disk/inputs/file.txt`.", "type": "string" + } + }, + "id": "Disk" + }, + "PipelineParameter": { + "description": "Parameters facilitate setting and delivering data into the\npipeline's execution environment. They are defined at create time,\nwith optional defaults, and can be overridden at run time.\n\nIf `localCopy` is unset, then the parameter specifies a string that\nis passed as-is into the pipeline, as the value of the environment\nvariable with the given name. A default value can be optionally\nspecified at create time. The default can be overridden at run time\nusing the inputs map. If no default is given, a value must be\nsupplied at runtime.\n\nIf `localCopy` is defined, then the parameter specifies a data\nsource or sink, both in Google Cloud Storage and on the Docker container\nwhere the pipeline computation is run. The service account associated with\nthe Pipeline (by\ndefault the project's Compute Engine service account) must have access to the\nGoogle Cloud Storage paths.\n\nAt run time, the Google Cloud Storage paths can be overridden if a default\nwas provided at create time, or must be set otherwise. The pipeline runner\nshould add a key/value pair to either the inputs or outputs map. The\nindicated data copies will be carried out before/after pipeline execution,\njust as if the corresponding arguments were provided to `gsutil cp`.\n\nFor example: Given the following `PipelineParameter`, specified\nin the `inputParameters` list:\n\n```\n{name: \"input_file\", localCopy: {path: \"file.txt\", disk: \"pd1\"}}\n```\n\nwhere `disk` is defined in the `PipelineResources` object as:\n\n```\n{name: \"pd1\", mountPoint: \"/mnt/disk/\"}\n```\n\nWe create a disk named `pd1`, mount it on the host VM, and map\n`/mnt/pd1` to `/mnt/disk` in the docker container. At\nruntime, an entry for `input_file` would be required in the inputs\nmap, such as:\n\n```\n inputs[\"input_file\"] = \"gs://my-bucket/bar.txt\"\n```\n\nThis would generate the following gsutil call:\n\n```\n gsutil cp gs://my-bucket/bar.txt /mnt/pd1/file.txt\n```\n\nThe file `/mnt/pd1/file.txt` maps to `/mnt/disk/file.txt` in the\nDocker container. Acceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eGoogle Cloud storage path\u003c/th\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\u003ctd\u003eglob\u003c/td\u003e\u003ctd\u003edirectory\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nFor outputs, the direction of the copy is reversed:\n\n```\n gsutil cp /mnt/disk/file.txt gs://my-bucket/bar.txt\n```\n\nAcceptable paths are:\n\n\u003ctable\u003e\n \u003cthead\u003e\n \u003ctr\u003e\u003cth\u003eLocal path\u003c/th\u003e\u003cth\u003eGoogle Cloud Storage path\u003c/th\u003e\u003c/tr\u003e\n \u003c/thead\u003e\n \u003ctbody\u003e\n \u003ctr\u003e\u003ctd\u003efile\u003c/td\u003e\u003ctd\u003efile\u003c/td\u003e\u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003efile\u003c/td\u003e\n \u003ctd\u003edirectory - directory must already exist\u003c/td\u003e\n \u003c/tr\u003e\n \u003ctr\u003e\n \u003ctd\u003eglob\u003c/td\u003e\n \u003ctd\u003edirectory - directory will be created if it doesn't exist\u003c/td\u003e\u003c/tr\u003e\n \u003c/tbody\u003e\n\u003c/table\u003e\n\nOne restriction due to docker limitations, is that for outputs that are found\non the boot disk, the local path cannot be a glob and must be a file.", + "type": "object", + "properties": { + "description": { + "description": "Human-readable description.", + "type": "string" }, - "readOnly": { - "description": "Specifies how a sourced-base persistent disk will be mounted. See\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#use_multi_instances\nfor more details.\nCan only be set at create time.", - "type": "boolean" + "localCopy": { + "description": "If present, this parameter is marked for copying to and from the VM.\n`LocalCopy` indicates where on the VM the file should be. The value\ngiven to this parameter (either at runtime or using `defaultValue`)\nmust be the remote path where the file should be.", + "$ref": "LocalCopy" }, - "source": { - "description": "The full or partial URL of the persistent disk to attach. See\nhttps://cloud.google.com/compute/docs/reference/latest/instances#resource\nand\nhttps://cloud.google.com/compute/docs/disks/persistent-disks#snapshots\nfor more details.", + "defaultValue": { + "description": "The default value for this parameter. Can be overridden at runtime.\nIf `localCopy` is present, then this must be a Google Cloud Storage path\nbeginning with `gs://`.", + "type": "string" + }, + "name": { + "description": "Required. Name of the parameter - the pipeline runner uses this string\nas the key to the input and output maps in RunPipeline.", "type": "string" } }, - "id": "Disk", - "description": "A Google Compute Engine disk resource specification.", - "type": "object" + "id": "PipelineParameter" + }, + "LoggingOptions": { + "description": "The logging options for the pipeline run.", + "type": "object", + "properties": { + "gcsPath": { + "description": "The location in Google Cloud Storage to which the pipeline logs\nwill be copied. Can be specified as a fully qualified directory\npath, in which case logs will be output with a unique identifier\nas the filename in that directory, or as a fully specified path,\nwhich must end in `.log`, in which case that path will be\nused, and the user must ensure that logs are not\noverwritten. Stdout and stderr logs from the run are also\ngenerated and output as `-stdout.log` and `-stderr.log`.", + "type": "string" + } + }, + "id": "LoggingOptions" + }, + "RunPipelineRequest": { + "description": "The request to run a pipeline. If `pipelineId` is specified, it\nrefers to a saved pipeline created with CreatePipeline and set as\nthe `pipelineId` of the returned Pipeline object. If\n`ephemeralPipeline` is specified, that pipeline is run once\nwith the given args and not saved. It is an error to specify both\n`pipelineId` and `ephemeralPipeline`. `pipelineArgs`\nmust be specified.", + "type": "object", + "properties": { + "pipelineArgs": { + "$ref": "RunPipelineArgs", + "description": "The arguments to use when running this pipeline." + }, + "pipelineId": { + "description": "The already created pipeline to run.", + "type": "string" + }, + "ephemeralPipeline": { + "description": "A new pipeline object to run once and then delete.", + "$ref": "Pipeline" + } + }, + "id": "RunPipelineRequest" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "type": "object", + "properties": {}, + "id": "CancelOperationRequest" + }, + "RuntimeMetadata": { + "description": "Runtime metadata that will be populated in the\nruntimeMetadata\nfield of the Operation associated with a RunPipeline execution.", + "type": "object", + "properties": { + "computeEngine": { + "$ref": "ComputeEngine", + "description": "Execution information specific to Google Compute Engine." + } + }, + "id": "RuntimeMetadata" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "properties": { + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "An OperationMetadata object. This will always be returned with the Operation.", + "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": "If importing ReadGroupSets, an ImportReadGroupSetsResponse is returned. If importing Variants, an ImportVariantsResponse is returned. For pipelines and exports, an Empty response is returned.", + "type": "object" + }, + "name": { + "description": "The server-assigned name, which is only unique within the same service that originally returns it. For example: `operations/CJHU7Oi_ChDrveSpBRjfuL-qzoWAgEw`", + "type": "string" + } + }, + "id": "Operation" + }, + "ImportReadGroupSetsResponse": { + "description": "The read group set import response.", + "type": "object", + "properties": { + "readGroupSetIds": { + "description": "IDs of the read group sets that were created.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "ImportReadGroupSetsResponse" + }, + "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.", + "type": "object", + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "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" + } + }, + "id": "Status" + }, + "ServiceAccount": { + "description": "A Google Cloud Service Account.", + "type": "object", + "properties": { + "email": { + "description": "Email address of the service account. Defaults to `default`,\nwhich uses the compute service account associated with the project.", + "type": "string" + }, + "scopes": { + "description": "List of scopes to be enabled for this service account on the VM.\nThe following scopes are automatically included:\n\n* https://www.googleapis.com/auth/compute\n* https://www.googleapis.com/auth/devstorage.full_control\n* https://www.googleapis.com/auth/genomics\n* https://www.googleapis.com/auth/logging.write\n* https://www.googleapis.com/auth/monitoring.write", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "ServiceAccount" + }, + "PipelineResources": { + "description": "The system resources for the pipeline run.", + "type": "object", + "properties": { + "noAddress": { + "description": "Whether to assign an external IP to the instance. This is an experimental\nfeature that may go away. Defaults to false.\nCorresponds to `--no_address` flag for [gcloud compute instances create]\n(https://cloud.google.com/sdk/gcloud/reference/compute/instances/create).\nIn order to use this, must be true for both create time and run time.\nCannot be true at run time if false at create time. If you need to ssh into\na private IP VM for debugging, you can ssh to a public VM and then ssh into\nthe private VM's Internal IP. If noAddress is set, this pipeline run may\nonly load docker images from Google Container Registry and not Docker Hub.\nBefore using this, you must\n[configure access to Google services from internal IPs](https://cloud.google.com/compute/docs/configure-private-google-access#configuring_access_to_google_services_from_internal_ips).", + "type": "boolean" + }, + "disks": { + "description": "Disks to attach.", + "type": "array", + "items": { + "$ref": "Disk" + } + }, + "bootDiskSizeGb": { + "description": "The size of the boot disk. Defaults to 10 (GB).", + "format": "int32", + "type": "integer" + }, + "preemptible": { + "description": "Whether to use preemptible VMs. Defaults to `false`. In order to use this,\nmust be true for both create time and run time. Cannot be true at run time\nif false at create time.", + "type": "boolean" + }, + "minimumRamGb": { + "description": "The minimum amount of RAM to use. Defaults to 3.75 (GB)", + "format": "double", + "type": "number" + }, + "zones": { + "description": "List of Google Compute Engine availability zones to which resource\ncreation will restricted. If empty, any zone may be chosen.", + "type": "array", + "items": { + "type": "string" + } + }, + "minimumCpuCores": { + "description": "The minimum number of cores to use. Defaults to 1.", + "format": "int32", + "type": "integer" + }, + "acceleratorType": { + "description": "Optional. The Compute Engine defined accelerator type.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances: NVIDIA®\nTesla® drivers and NVIDIA® CUDA toolkit.\nPlease see https://cloud.google.com/compute/docs/gpus/ for a list of\navailable accelerator types.", + "type": "string" + }, + "acceleratorCount": { + "description": "Optional. The number of accelerators of the specified type to attach.\nBy specifying this parameter, you will download and install the following\nthird-party software onto your managed Compute Engine instances:\nNVIDIA® Tesla® drivers and NVIDIA® CUDA toolkit.", + "format": "int64", + "type": "string" + } + }, + "id": "PipelineResources" + }, + "Pipeline": { + "description": "The pipeline object. Represents a transformation from a set of input\nparameters to a set of output parameters. The transformation is defined\nas a docker image and command to run within that image. Each pipeline\nis run on a Google Compute Engine VM. A pipeline can be created with the\n`create` method and then later run with the `run` method, or a pipeline can\nbe defined and run all at once with the `run` method.", + "type": "object", + "properties": { + "resources": { + "description": "Required. Specifies resource requirements for the pipeline run.\nRequired fields:\n\n*\nminimumCpuCores\n\n*\nminimumRamGb", + "$ref": "PipelineResources" + }, + "name": { + "description": "Required. A user specified pipeline name that does not have to be unique.\nThis name can be used for filtering Pipelines in ListPipelines.", + "type": "string" + }, + "pipelineId": { + "description": "Unique pipeline id that is generated by the service when CreatePipeline\nis called. Cannot be specified in the Pipeline used in the\nCreatePipelineRequest, and will be populated in the response to\nCreatePipeline and all subsequent Get and List calls. Indicates that the\nservice has registered this pipeline.", + "type": "string" + }, + "projectId": { + "description": "Required. The project in which to create the pipeline. The caller must have\nWRITE access.", + "type": "string" + }, + "outputParameters": { + "description": "Output parameters of the pipeline.", + "type": "array", + "items": { + "$ref": "PipelineParameter" + } + }, + "description": { + "description": "User-specified description.", + "type": "string" + }, + "docker": { + "$ref": "DockerExecutor", + "description": "Specifies the docker run information." + }, + "inputParameters": { + "description": "Input parameters of the pipeline.", + "type": "array", + "items": { + "$ref": "PipelineParameter" + } + } + }, + "id": "Pipeline" + }, + "OperationEvent": { + "description": "An event that occurred during an Operation.", + "type": "object", + "properties": { + "endTime": { + "description": "Optional time of when event finished. An event can have a start time and no\nfinish time. If an event has a finish time, there must be a start time.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "Optional time of when event started.", + "format": "google-datetime", + "type": "string" + }, + "description": { + "description": "Required description of event.", + "type": "string" + } + }, + "id": "OperationEvent" + }, + "ControllerConfig": { + "description": "Stores the information that the controller will fetch from the\nserver in order to run. Should only be used by VMs created by the\nPipelines Service and not by end users.", + "type": "object", + "properties": { + "gcsSources": { + "additionalProperties": { + "$ref": "RepeatedString" + }, + "type": "object" + }, + "gcsSinks": { + "additionalProperties": { + "$ref": "RepeatedString" + }, + "type": "object" + }, + "disks": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "machineType": { + "type": "string" + }, + "cmd": { + "type": "string" + }, + "vars": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "image": { + "type": "string" + }, + "gcsLogPath": { + "type": "string" + } + }, + "id": "ControllerConfig" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + }, + "id": "ListOperationsResponse" + }, + "RepeatedString": { + "type": "object", + "properties": { + "values": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "RepeatedString" + }, + "OperationMetadata": { + "description": "Metadata describing an Operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time at which the job was submitted to the Genomics service.", + "format": "google-datetime", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Optionally provided by the caller when submitting the request that creates\nthe operation.", + "type": "object" + }, + "projectId": { + "description": "The Google Cloud Project in which the job is scoped.", + "type": "string" + }, + "clientId": { + "description": "This field is deprecated. Use `labels` instead. Optionally provided by the\ncaller when submitting the request that creates the operation.", + "type": "string" + }, + "events": { + "description": "Optional event messages that were generated during the job's execution.\nThis also contains any warnings that were generated during import\nor export.", + "type": "array", + "items": { + "$ref": "OperationEvent" + } + }, + "endTime": { + "description": "The time at which the job stopped running.", + "format": "google-datetime", + "type": "string" + }, + "startTime": { + "description": "The time at which the job began to run.", + "format": "google-datetime", + "type": "string" + }, + "request": { + "description": "The original request that started the operation. Note that this will be in\ncurrent version of the API. If the operation was started with v1beta2 API\nand a GetOperation is performed on v1 API, a v1 request will be returned.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "runtimeMetadata": { + "description": "Runtime metadata on this Operation.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "id": "OperationMetadata" + }, + "ListPipelinesResponse": { + "description": "The response of ListPipelines. Contains at most `pageSize`\npipelines. If it contains `pageSize` pipelines, and more pipelines\nexist, then `nextPageToken` will be populated and should be\nused as the `pageToken` argument to a subsequent ListPipelines\nrequest.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "The token to use to get the next page of results.", + "type": "string" + }, + "pipelines": { + "description": "The matched pipelines.", + "type": "array", + "items": { + "$ref": "Pipeline" + } + } + }, + "id": "ListPipelinesResponse" + }, + "RunPipelineArgs": { + "description": "The pipeline run arguments.", + "type": "object", + "properties": { + "projectId": { + "description": "Required. The project in which to run the pipeline. The caller must have\nWRITER access to all Google Cloud services and resources (e.g. Google\nCompute Engine) will be used.", + "type": "string" + }, + "clientId": { + "description": "This field is deprecated. Use `labels` instead. Client-specified pipeline\noperation identifier.", + "type": "string" + }, + "serviceAccount": { + "$ref": "ServiceAccount", + "description": "The Google Cloud Service Account that will be used to access data and\nservices. By default, the compute service account associated with\n`projectId` is used." + }, + "inputs": { + "description": "Pipeline input arguments; keys are defined in the pipeline documentation.\nAll input parameters that do not have default values must be specified.\nIf parameters with defaults are specified here, the defaults will be\noverridden.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "labels": { + "description": "Labels to apply to this pipeline run. Labels will also be applied to\ncompute resources (VM, disks) created by this pipeline run. When listing\noperations, operations can filtered by labels.\nLabel keys may not be empty; label values may be empty. Non-empty labels\nmust be 1-63 characters long, and comply with [RFC1035]\n(https://www.ietf.org/rfc/rfc1035.txt).\nSpecifically, the name must be 1-63 characters long and match the regular\nexpression `[a-z]([-a-z0-9]*[a-z0-9])?` which means the first\ncharacter must be a lowercase letter, and all following characters must be\na dash, lowercase letter, or digit, except the last character, which cannot\nbe a dash.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "logging": { + "$ref": "LoggingOptions", + "description": "Required. Logging options. Used by the service to communicate results\nto the user." + }, + "keepVmAliveOnFailureDuration": { + "description": "How long to keep the VM up after a failure (for example docker command\nfailed, copying input or output files failed, etc). While the VM is up, one\ncan ssh into the VM to debug. Default is 0; maximum allowed value is 1 day.", + "format": "google-duration", + "type": "string" + }, + "resources": { + "description": "Specifies resource requirements/overrides for the pipeline run.", + "$ref": "PipelineResources" + }, + "outputs": { + "additionalProperties": { + "type": "string" + }, + "description": "Pipeline output arguments; keys are defined in the pipeline\ndocumentation. All output parameters of without default values\nmust be specified. If parameters with defaults are specified\nhere, the defaults will be overridden.", + "type": "object" + } + }, + "id": "RunPipelineArgs" + }, + "SetOperationStatusRequest": { + "description": "Request to set operation status. Should only be used by VMs\ncreated by the Pipelines Service and not by end users.", + "type": "object", + "properties": { + "operationId": { + "type": "string" + }, + "errorMessage": { + "type": "string" + }, + "validationToken": { + "format": "uint64", + "type": "string" + }, + "errorCode": { + "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" + ], + "enum": [ + "OK", + "CANCELLED", + "UNKNOWN", + "INVALID_ARGUMENT", + "DEADLINE_EXCEEDED", + "NOT_FOUND", + "ALREADY_EXISTS", + "PERMISSION_DENIED", + "UNAUTHENTICATED", + "RESOURCE_EXHAUSTED", + "FAILED_PRECONDITION", + "ABORTED", + "OUT_OF_RANGE", + "UNIMPLEMENTED", + "INTERNAL", + "UNAVAILABLE", + "DATA_LOSS" + ], + "type": "string" + }, + "timestampEvents": { + "type": "array", + "items": { + "$ref": "TimestampEvent" + } + } + }, + "id": "SetOperationStatusRequest" + }, + "ComputeEngine": { + "description": "Describes a Compute Engine resource that is being managed by a running\npipeline.", + "type": "object", + "properties": { + "machineType": { + "description": "The machine type of the instance.", + "type": "string" + }, + "diskNames": { + "description": "The names of the disks that were created for this pipeline.", + "type": "array", + "items": { + "type": "string" + } + }, + "instanceName": { + "description": "The instance on which the operation is running.", + "type": "string" + }, + "zone": { + "description": "The availability zone in which the instance resides.", + "type": "string" + } + }, + "id": "ComputeEngine" + }, + "ImportVariantsResponse": { + "description": "The variant data import response.", + "type": "object", + "properties": { + "callSetIds": { + "description": "IDs of the call sets created during the import.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "ImportVariantsResponse" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "version": "v1alpha2", @@ -1081,19 +702,398 @@ "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/compute": { - "description": "View and manage your Google Compute Engine resources" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" }, "https://www.googleapis.com/auth/genomics": { "description": "View and manage Genomics data" + }, + "https://www.googleapis.com/auth/compute": { + "description": "View and manage your Google Compute Engine resources" } } } }, - "servicePath": "", + "kind": "discovery#restDescription", "description": "Upload, process, query, and search Genomics data in the cloud.", - "kind": "discovery#restDescription" + "servicePath": "", + "rootUrl": "https://genomics.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "genomics", + "batchPath": "batch", + "revision": "20171221", + "documentationLink": "https://cloud.google.com/genomics", + "id": "genomics:v1alpha2", + "title": "Genomics API", + "ownerName": "Google", + "discoveryVersion": "v1", + "resources": { + "pipelines": { + "methods": { + "get": { + "description": "Retrieves a pipeline based on ID.\n\nCaller must have READ permission to the project.", + "response": { + "$ref": "Pipeline" + }, + "parameterOrder": [ + "pipelineId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "pipelineId": { + "location": "path", + "description": "Caller must have READ access to the project in which this pipeline\nis defined.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1alpha2/pipelines/{pipelineId}", + "path": "v1alpha2/pipelines/{pipelineId}", + "id": "genomics.pipelines.get" + }, + "setOperationStatus": { + "request": { + "$ref": "SetOperationStatusRequest" + }, + "description": "Sets status of a given operation. Any new timestamps (as determined by\ndescription) are appended to TimestampEvents. Should only be called by VMs\ncreated by the Pipelines Service and not by end users.", + "httpMethod": "PUT", + "parameterOrder": [], + "response": { + "$ref": "Empty" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1alpha2/pipelines:setOperationStatus", + "id": "genomics.pipelines.setOperationStatus", + "path": "v1alpha2/pipelines:setOperationStatus" + }, + "getControllerConfig": { + "flatPath": "v1alpha2/pipelines:getControllerConfig", + "path": "v1alpha2/pipelines:getControllerConfig", + "id": "genomics.pipelines.getControllerConfig", + "description": "Gets controller configuration information. Should only be called\nby VMs created by the Pipelines Service and not by end users.", + "response": { + "$ref": "ControllerConfig" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "operationId": { + "description": "The operation to retrieve controller configuration for.", + "type": "string", + "location": "query" + }, + "validationToken": { + "location": "query", + "format": "uint64", + "type": "string" + } + } + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "pipelineId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "pipelineId": { + "description": "Caller must have WRITE access to the project in which this pipeline\nis defined.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1alpha2/pipelines/{pipelineId}", + "path": "v1alpha2/pipelines/{pipelineId}", + "id": "genomics.pipelines.delete", + "description": "Deletes a pipeline based on ID.\n\nCaller must have WRITE permission to the project." + }, + "list": { + "flatPath": "v1alpha2/pipelines", + "id": "genomics.pipelines.list", + "path": "v1alpha2/pipelines", + "description": "Lists pipelines.\n\nCaller must have READ permission to the project.", + "httpMethod": "GET", + "parameterOrder": [], + "response": { + "$ref": "ListPipelinesResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "namePrefix": { + "location": "query", + "description": "Pipelines with names that match this prefix should be\nreturned. If unspecified, all pipelines in the project, up to\n`pageSize`, will be returned.", + "type": "string" + }, + "pageToken": { + "description": "Token to use to indicate where to start getting results.\nIf unspecified, returns the first page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Number of pipelines to return at once. Defaults to 256, and max\nis 2048.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "projectId": { + "description": "Required. The name of the project to search for pipelines. Caller\nmust have READ access to this project.", + "type": "string", + "location": "query" + } + } + }, + "create": { + "request": { + "$ref": "Pipeline" + }, + "description": "Creates a pipeline that can be run later. Create takes a Pipeline that\nhas all fields other than `pipelineId` populated, and then returns\nthe same pipeline with `pipelineId` populated. This id can be used\nto run the pipeline.\n\nCaller must have WRITE permission to the project.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "Pipeline" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1alpha2/pipelines", + "id": "genomics.pipelines.create", + "path": "v1alpha2/pipelines" + }, + "run": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": {}, + "flatPath": "v1alpha2/pipelines:run", + "path": "v1alpha2/pipelines:run", + "id": "genomics.pipelines.run", + "description": "Runs a pipeline. If `pipelineId` is specified in the request, then\nrun a saved pipeline. If `ephemeralPipeline` is specified, then run\nthat pipeline once without saving a copy.\n\nThe caller must have READ permission to the project where the pipeline\nis stored and WRITE permission to the project where the pipeline will be\nrun, as VMs will be created and storage will be used.\n\nIf a pipeline operation is still running after 6 days, it will be canceled.", + "request": { + "$ref": "RunPipelineRequest" + } + } + } + }, + "operations": { + "methods": { + "list": { + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "filter": { + "description": "A string for filtering Operations.\nThe following filter fields are supported:\n\n* projectId: Required. Corresponds to\n OperationMetadata.projectId.\n* createTime: The time this job was created, in seconds from the\n [epoch](http://en.wikipedia.org/wiki/Unix_time). Can use `\u003e=` and/or `\u003c=`\n operators.\n* status: Can be `RUNNING`, `SUCCESS`, `FAILURE`, or `CANCELED`. Only\n one status may be specified.\n* labels.key where key is a label key.\n\nExamples:\n\n* `projectId = my-project AND createTime \u003e= 1432140000`\n* `projectId = my-project AND createTime \u003e= 1432140000 AND createTime \u003c= 1432150000 AND status = RUNNING`\n* `projectId = my-project AND labels.color = *`\n* `projectId = my-project AND labels.color = red`", + "type": "string", + "location": "query" + }, + "name": { + "location": "path", + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^operations$" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of results to return. If unspecified, defaults to\n256. The maximum value is 2048.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1alpha2/operations", + "path": "v1alpha2/{+name}", + "id": "genomics.operations.list", + "description": "Lists operations that match the specified filter in the request." + }, + "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", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^operations/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "flatPath": "v1alpha2/operations/{operationsId}", + "id": "genomics.operations.get", + "path": "v1alpha2/{+name}" + }, + "cancel": { + "flatPath": "v1alpha2/operations/{operationsId}:cancel", + "path": "v1alpha2/{+name}:cancel", + "id": "genomics.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. Clients may use Operations.GetOperation or Operations.ListOperations to check whether the cancellation succeeded or the operation completed despite cancellation.", + "request": { + "$ref": "CancelOperationRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/genomics" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^operations/.+$" + } + } + } + } + } + }, + "parameters": { + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + } + } }
diff --git a/iam/v1/iam-api.json b/iam/v1/iam-api.json index 512b46f..95fbcc6 100644 --- a/iam/v1/iam-api.json +++ b/iam/v1/iam-api.json
@@ -1,10 +1,20 @@ { + "rootUrl": "https://iam.googleapis.com/", + "ownerDomain": "google.com", + "name": "iam", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Identity and Access Management (IAM) API", + "ownerName": "Google", "resources": { "organizations": { "resources": { "roles": { "methods": { "undelete": { + "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete", + "path": "v1/{+name}:undelete", + "id": "iam.organizations.roles.undelete", "description": "Undelete a Role, bringing it back in its previous state.", "request": { "$ref": "UndeleteRoleRequest" @@ -27,15 +37,9 @@ "type": "string", "pattern": "^organizations/[^/]+/roles/[^/]+$" } - }, - "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}:undelete", - "path": "v1/{+name}:undelete", - "id": "iam.organizations.roles.undelete" + } }, "get": { - "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", - "path": "v1/{+name}", - "id": "iam.organizations.roles.get", "description": "Gets a Role definition.", "response": { "$ref": "Role" @@ -44,34 +48,34 @@ "name" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "name": { + "location": "path", "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", "required": true, "type": "string", - "pattern": "^organizations/[^/]+/roles/[^/]+$", - "location": "path" + "pattern": "^organizations/[^/]+/roles/[^/]+$" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", + "path": "v1/{+name}", + "id": "iam.organizations.roles.get" }, "patch": { - "description": "Updates a Role definition.", "request": { "$ref": "Role" }, - "response": { - "$ref": "Role" - }, + "description": "Updates a Role definition.", + "httpMethod": "PATCH", "parameterOrder": [ "name" ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], + "response": { + "$ref": "Role" + }, "parameters": { "updateMask": { "location": "query", @@ -87,40 +91,43 @@ "pattern": "^organizations/[^/]+/roles/[^/]+$" } }, - "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", - "path": "v1/{+name}", - "id": "iam.organizations.roles.patch" - }, - "delete": { - "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed.", - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Role" - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", + "id": "iam.organizations.roles.patch", + "path": "v1/{+name}" + }, + "delete": { + "response": { + "$ref": "Role" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", "parameters": { + "name": { + "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/roles/[^/]+$", + "location": "path" + }, "etag": { "description": "Used to perform a consistent read-modify-write.", "format": "byte", "type": "string", "location": "query" - }, - "name": { - "location": "path", - "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/roles/[^/]+$" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/organizations/{organizationsId}/roles/{rolesId}", + "path": "v1/{+name}", "id": "iam.organizations.roles.delete", - "path": "v1/{+name}" + "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed." }, "list": { "description": "Lists the Roles defined on a resource.", @@ -135,28 +142,6 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "pageSize": { - "location": "query", - "description": "Optional limit on the number of roles to include in the response.", - "format": "int32", - "type": "integer" - }, - "view": { - "description": "Optional view for the returned Role objects.", - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "FULL" - ] - }, - "parent": { - "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - }, "showDeleted": { "description": "Include Roles that have been deleted.", "type": "boolean", @@ -166,6 +151,28 @@ "location": "query", "description": "Optional pagination token returned in an earlier ListRolesResponse.", "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional limit on the number of roles to include in the response.", + "format": "int32", + "type": "integer" + }, + "view": { + "location": "query", + "enum": [ + "BASIC", + "FULL" + ], + "description": "Optional view for the returned Role objects.", + "type": "string" + }, + "parent": { + "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" } }, "flatPath": "v1/organizations/{organizationsId}/roles", @@ -173,17 +180,13 @@ "path": "v1/{+parent}/roles" }, "create": { - "request": { - "$ref": "CreateRoleRequest" - }, - "description": "Creates a new Role.", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], "response": { "$ref": "Role" }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", "parameters": { "parent": { "location": "path", @@ -197,8 +200,12 @@ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/organizations/{organizationsId}/roles", + "path": "v1/{+parent}/roles", "id": "iam.organizations.roles.create", - "path": "v1/{+parent}/roles" + "request": { + "$ref": "CreateRoleRequest" + }, + "description": "Creates a new Role." } } } @@ -208,233 +215,8 @@ "resources": { "serviceAccounts": { "methods": { - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions", - "id": "iam.projects.serviceAccounts.testIamPermissions", - "path": "v1/{+resource}:testIamPermissions" - }, - "delete": { - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}", - "id": "iam.projects.serviceAccounts.delete", - "path": "v1/{+name}", - "description": "Deletes a ServiceAccount." - }, - "signBlob": { - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob", - "path": "v1/{+name}:signBlob", - "id": "iam.projects.serviceAccounts.signBlob", - "request": { - "$ref": "SignBlobRequest" - }, - "description": "Signs a blob using a service account's system-managed private key.", - "response": { - "$ref": "SignBlobResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "flatPath": "v1/projects/{projectsId}/serviceAccounts", - "path": "v1/{+name}/serviceAccounts", - "id": "iam.projects.serviceAccounts.list", - "description": "Lists ServiceAccounts for a project.", - "response": { - "$ref": "ListServiceAccountsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "location": "query", - "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "ServiceAccount" - }, - "parameters": { - "name": { - "location": "path", - "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/serviceAccounts", - "id": "iam.projects.serviceAccounts.create", - "path": "v1/{+name}/serviceAccounts", - "request": { - "$ref": "CreateServiceAccountRequest" - }, - "description": "Creates a ServiceAccount\nand returns it." - }, - "setIamPolicy": { - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy", - "id": "iam.projects.serviceAccounts.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "description": "Sets the IAM access control policy for a\nServiceAccount.", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" - } - } - }, - "signJwt": { - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt", - "id": "iam.projects.serviceAccounts.signJwt", - "path": "v1/{+name}:signJwt", - "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail.", - "request": { - "$ref": "SignJwtRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "SignJwtResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" - } - } - }, - "getIamPolicy": { - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Policy" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy", - "id": "iam.projects.serviceAccounts.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "description": "Returns the IAM access control policy for a\nServiceAccount." - }, "get": { + "description": "Gets a ServiceAccount.", "response": { "$ref": "ServiceAccount" }, @@ -442,22 +224,21 @@ "name" ], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "name": { + "location": "path", "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}", "path": "v1/{+name}", - "id": "iam.projects.serviceAccounts.get", - "description": "Gets a ServiceAccount." + "id": "iam.projects.serviceAccounts.get" }, "update": { "description": "Updates a ServiceAccount.\n\nCurrently, only the following fields are updatable:\n`display_name` .\nThe `etag` is mandatory.", @@ -486,20 +267,257 @@ "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}", "path": "v1/{+name}", "id": "iam.projects.serviceAccounts.update" + }, + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "iam.projects.serviceAccounts.testIamPermissions", + "description": "Tests the specified permissions against the IAM access control policy\nfor a ServiceAccount.", + "request": { + "$ref": "TestIamPermissionsRequest" + } + }, + "delete": { + "description": "Deletes a ServiceAccount.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}", + "path": "v1/{+name}", + "id": "iam.projects.serviceAccounts.delete" + }, + "signBlob": { + "request": { + "$ref": "SignBlobRequest" + }, + "description": "Signs a blob using a service account's system-managed private key.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "SignBlobResponse" + }, + "parameters": { + "name": { + "location": "path", + "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signBlob", + "id": "iam.projects.serviceAccounts.signBlob", + "path": "v1/{+name}:signBlob" + }, + "list": { + "flatPath": "v1/projects/{projectsId}/serviceAccounts", + "path": "v1/{+name}/serviceAccounts", + "id": "iam.projects.serviceAccounts.list", + "description": "Lists ServiceAccounts for a project.", + "response": { + "$ref": "ListServiceAccountsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "location": "path", + "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + }, + "pageToken": { + "description": "Optional pagination token returned in an earlier\nListServiceAccountsResponse.next_page_token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional limit on the number of service accounts to include in the\nresponse. Further accounts can subsequently be obtained by including the\nListServiceAccountsResponse.next_page_token\nin a subsequent request.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "create": { + "flatPath": "v1/projects/{projectsId}/serviceAccounts", + "path": "v1/{+name}/serviceAccounts", + "id": "iam.projects.serviceAccounts.create", + "description": "Creates a ServiceAccount\nand returns it.", + "request": { + "$ref": "CreateServiceAccountRequest" + }, + "response": { + "$ref": "ServiceAccount" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "Required. The resource name of the project associated with the service\naccounts, such as `projects/my-project-123`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + } + }, + "setIamPolicy": { + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "id": "iam.projects.serviceAccounts.setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the IAM access control policy for a\nServiceAccount.", + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "signJwt": { + "response": { + "$ref": "SignJwtResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:signJwt", + "path": "v1/{+name}:signJwt", + "id": "iam.projects.serviceAccounts.signJwt", + "request": { + "$ref": "SignJwtRequest" + }, + "description": "Signs a JWT using a service account's system-managed private key.\n\nIf no expiry time (`exp`) is provided in the `SignJwtRequest`, IAM sets an\nan expiry time of one hour by default. If you request an expiry time of\nmore than one hour, the request will fail." + }, + "getIamPolicy": { + "description": "Returns the IAM access control policy for a\nServiceAccount.", + "httpMethod": "POST", + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}:getIamPolicy", + "id": "iam.projects.serviceAccounts.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy" } }, "resources": { "keys": { "methods": { "list": { - "httpMethod": "GET", + "description": "Lists ServiceAccountKeys.", "response": { "$ref": "ListServiceAccountKeysResponse" }, "parameterOrder": [ "name" ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { + "name": { + "location": "path", + "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" + }, "keyTypes": { "location": "query", "enum": [ @@ -510,31 +528,21 @@ "description": "Filters the types of keys the user wants to include in the list\nresponse. Duplicate key types are not allowed. If no key type\nis provided, all keys are returned.", "type": "string", "repeated": true - }, - "name": { - "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID`, will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys", - "id": "iam.projects.serviceAccounts.keys.list", "path": "v1/{+name}/keys", - "description": "Lists ServiceAccountKeys." + "id": "iam.projects.serviceAccounts.keys.list" }, "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], + "description": "Gets the ServiceAccountKey\nby key id.", "response": { "$ref": "ServiceAccountKey" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], @@ -550,22 +558,18 @@ "type": "string" }, "name": { + "location": "path", "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\n\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$" } }, "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}", - "id": "iam.projects.serviceAccounts.keys.get", "path": "v1/{+name}", - "description": "Gets the ServiceAccountKey\nby key id." + "id": "iam.projects.serviceAccounts.keys.get" }, "create": { - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys", - "path": "v1/{+name}/keys", - "id": "iam.projects.serviceAccounts.keys.create", "request": { "$ref": "CreateServiceAccountKeyRequest" }, @@ -579,41 +583,44 @@ "httpMethod": "POST", "parameters": { "name": { + "location": "path", "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys", + "path": "v1/{+name}/keys", + "id": "iam.projects.serviceAccounts.keys.create" }, "delete": { - "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}", - "id": "iam.projects.serviceAccounts.keys.delete", - "path": "v1/{+name}", - "description": "Deletes a ServiceAccountKey.", - "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], + "httpMethod": "DELETE", "parameters": { "name": { + "location": "path", "description": "The resource name of the service account key in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/serviceAccounts/[^/]+/keys/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1/projects/{projectsId}/serviceAccounts/{serviceAccountsId}/keys/{keysId}", + "path": "v1/{+name}", + "id": "iam.projects.serviceAccounts.keys.delete", + "description": "Deletes a ServiceAccountKey." } } } @@ -621,159 +628,46 @@ }, "roles": { "methods": { - "patch": { - "request": { - "$ref": "Role" - }, - "description": "Updates a Role definition.", - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], + "delete": { "response": { "$ref": "Role" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", "parameters": { - "updateMask": { - "description": "A mask describing which fields in the Role have changed.", - "format": "google-fieldmask", + "etag": { + "description": "Used to perform a consistent read-modify-write.", + "format": "byte", "type": "string", "location": "query" }, "name": { - "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/roles/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", - "id": "iam.projects.roles.patch", - "path": "v1/{+name}" - }, - "undelete": { - "description": "Undelete a Role, bringing it back in its previous state.", - "request": { - "$ref": "UndeleteRoleRequest" - }, - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Role" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", "required": true, "type": "string", - "pattern": "^projects/[^/]+/roles/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete", - "id": "iam.projects.roles.undelete", - "path": "v1/{+name}:undelete" - }, - "get": { - "description": "Gets a Role definition.", - "response": { - "$ref": "Role" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", - "required": true, - "type": "string", "pattern": "^projects/[^/]+/roles/[^/]+$", "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", "path": "v1/{+name}", - "id": "iam.projects.roles.get" - }, - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Role" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/roles/[^/]+$", - "location": "path" - }, - "etag": { - "location": "query", - "description": "Used to perform a consistent read-modify-write.", - "format": "byte", - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", "id": "iam.projects.roles.delete", - "path": "v1/{+name}", "description": "Soft deletes a role. The role is suspended and cannot be used to create new\nIAM Policy Bindings.\nThe Role will not be included in `ListRoles()` unless `show_deleted` is set\nin the `ListRolesRequest`. The Role contains the deleted boolean set.\nExisting Bindings remains, but are inactive. The Role can be undeleted\nwithin 7 days. After 7 days the Role is deleted and all Bindings associated\nwith the role are removed." }, "list": { - "flatPath": "v1/projects/{projectsId}/roles", - "id": "iam.projects.roles.list", - "path": "v1/{+parent}/roles", - "description": "Lists the Roles defined on a resource.", - "httpMethod": "GET", "response": { "$ref": "ListRolesResponse" }, "parameterOrder": [ "parent" ], + "httpMethod": "GET", "parameters": { - "pageSize": { - "description": "Optional limit on the number of roles to include in the response.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "view": { - "description": "Optional view for the returned Role objects.", - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "FULL" - ] - }, - "parent": { - "location": "path", - "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, "showDeleted": { "description": "Include Roles that have been deleted.", "type": "boolean", @@ -783,11 +677,37 @@ "description": "Optional pagination token returned in an earlier ListRolesResponse.", "type": "string", "location": "query" + }, + "pageSize": { + "description": "Optional limit on the number of roles to include in the response.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "view": { + "location": "query", + "enum": [ + "BASIC", + "FULL" + ], + "description": "Optional view for the returned Role objects.", + "type": "string" + }, + "parent": { + "location": "path", + "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1/projects/{projectsId}/roles", + "path": "v1/{+parent}/roles", + "id": "iam.projects.roles.list", + "description": "Lists the Roles defined on a resource." }, "create": { "description": "Creates a new Role.", @@ -806,16 +726,103 @@ ], "parameters": { "parent": { - "location": "path", "description": "The resource name of the parent resource in one of the following formats:\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`", "required": true, "type": "string", - "pattern": "^projects/[^/]+$" + "pattern": "^projects/[^/]+$", + "location": "path" } }, "flatPath": "v1/projects/{projectsId}/roles", "path": "v1/{+parent}/roles", "id": "iam.projects.roles.create" + }, + "patch": { + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Role" + }, + "parameters": { + "updateMask": { + "location": "query", + "description": "A mask describing which fields in the Role have changed.", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "location": "path", + "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/roles/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", + "id": "iam.projects.roles.patch", + "path": "v1/{+name}", + "request": { + "$ref": "Role" + }, + "description": "Updates a Role definition." + }, + "undelete": { + "flatPath": "v1/projects/{projectsId}/roles/{rolesId}:undelete", + "id": "iam.projects.roles.undelete", + "path": "v1/{+name}:undelete", + "request": { + "$ref": "UndeleteRoleRequest" + }, + "description": "Undelete a Role, bringing it back in its previous state.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Role" + }, + "parameters": { + "name": { + "description": "The resource name of the role in one of the following formats:\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/roles/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "get": { + "flatPath": "v1/projects/{projectsId}/roles/{rolesId}", + "id": "iam.projects.roles.get", + "path": "v1/{+name}", + "description": "Gets a Role definition.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Role" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/roles/[^/]+$" + } + } } } } @@ -823,40 +830,28 @@ }, "roles": { "methods": { - "queryGrantableRoles": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "QueryGrantableRolesResponse" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/roles:queryGrantableRoles", - "id": "iam.roles.queryGrantableRoles", - "path": "v1/roles:queryGrantableRoles", - "request": { - "$ref": "QueryGrantableRolesRequest" - }, - "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource." - }, "list": { - "description": "Lists the Roles defined on a resource.", + "httpMethod": "GET", + "parameterOrder": [], "response": { "$ref": "ListRolesResponse" }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { - "pageSize": { + "showDeleted": { + "description": "Include Roles that have been deleted.", + "type": "boolean", + "location": "query" + }, + "pageToken": { "location": "query", + "description": "Optional pagination token returned in an earlier ListRolesResponse.", + "type": "string" + }, + "pageSize": { "description": "Optional limit on the number of roles to include in the response.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "view": { "location": "query", @@ -871,21 +866,15 @@ "description": "The resource name of the parent resource in one of the following formats:\n`` (empty string) -- this refers to curated roles.\n`organizations/{ORGANIZATION_ID}`\n`projects/{PROJECT_ID}`", "type": "string", "location": "query" - }, - "showDeleted": { - "location": "query", - "description": "Include Roles that have been deleted.", - "type": "boolean" - }, - "pageToken": { - "description": "Optional pagination token returned in an earlier ListRolesResponse.", - "type": "string", - "location": "query" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/roles", + "id": "iam.roles.list", "path": "v1/roles", - "id": "iam.roles.list" + "description": "Lists the Roles defined on a resource." }, "get": { "description": "Gets a Role definition.", @@ -901,35 +890,53 @@ ], "parameters": { "name": { - "location": "path", "description": "The resource name of the role in one of the following formats:\n`roles/{ROLE_NAME}`\n`organizations/{ORGANIZATION_ID}/roles/{ROLE_NAME}`\n`projects/{PROJECT_ID}/roles/{ROLE_NAME}`", "required": true, "type": "string", - "pattern": "^roles/[^/]+$" + "pattern": "^roles/[^/]+$", + "location": "path" } }, "flatPath": "v1/roles/{rolesId}", "path": "v1/{+name}", "id": "iam.roles.get" + }, + "queryGrantableRoles": { + "description": "Queries roles that can be granted on a particular resource.\nA role is grantable if it can be used as the role in a binding for a policy\nfor that resource.", + "request": { + "$ref": "QueryGrantableRolesRequest" + }, + "response": { + "$ref": "QueryGrantableRolesResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v1/roles:queryGrantableRoles", + "path": "v1/roles:queryGrantableRoles", + "id": "iam.roles.queryGrantableRoles" } } }, "permissions": { "methods": { "queryTestablePermissions": { + "description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource.", "request": { "$ref": "QueryTestablePermissionsRequest" }, - "description": "Lists the permissions testable on a resource.\nA permission is testable if it can be tested for an identity on a resource.", "response": { "$ref": "QueryTestablePermissionsResponse" }, "parameterOrder": [], "httpMethod": "POST", - "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "parameters": {}, "flatPath": "v1/permissions:queryTestablePermissions", "path": "v1/permissions:queryTestablePermissions", "id": "iam.permissions.queryTestablePermissions" @@ -938,46 +945,28 @@ } }, "parameters": { - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "default": "true" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, - "$.xgafv": { - "description": "V1 error format.", + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", + "location": "query" + }, + "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" @@ -986,20 +975,16 @@ "enum": [ "1", "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", + ], + "description": "V1 error format.", "type": "string" }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "alt": { - "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -1007,7 +992,13 @@ "media", "proto" ], - "type": "string" + "type": "string", + "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" }, "access_token": { "description": "OAuth access token.", @@ -1015,14 +1006,30 @@ "location": "query" }, "key": { + "location": "query", "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.", + "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.", "type": "string", "location": "query" }, - "quotaUser": { + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { "location": "query", - "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.", + "description": "OAuth 2.0 token for the current user.", "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" } }, "version": "v1", @@ -1031,12 +1038,189 @@ "description": "Manages identity and access control for Google Cloud Platform resources, including the creation of service accounts, which you can use to authenticate to Google and make API calls.", "servicePath": "", "basePath": "", - "revision": "20171228", - "documentationLink": "https://cloud.google.com/iam/", "id": "iam:v1", + "documentationLink": "https://cloud.google.com/iam/", + "revision": "20171228", "discoveryVersion": "v1", "version_module": true, "schemas": { + "SignBlobResponse": { + "description": "The service account sign blob response.", + "type": "object", + "properties": { + "signature": { + "description": "The signed blob.", + "format": "byte", + "type": "string" + }, + "keyId": { + "description": "The id of the key used to sign the blob.", + "type": "string" + } + }, + "id": "SignBlobResponse" + }, + "SignJwtRequest": { + "description": "The service account sign JWT request.", + "type": "object", + "properties": { + "payload": { + "description": "The JWT payload to sign, a JSON JWT Claim set.", + "type": "string" + } + }, + "id": "SignJwtRequest" + }, + "Permission": { + "description": "A permission which can be included by a role.", + "type": "object", + "properties": { + "stage": { + "description": "The current launch stage of the permission.", + "type": "string", + "enumDescriptions": [ + "The permission is currently in an alpha phase.", + "The permission is currently in a beta phase.", + "The permission is generally available.", + "The permission is being deprecated." + ], + "enum": [ + "ALPHA", + "BETA", + "GA", + "DEPRECATED" + ] + }, + "name": { + "description": "The name of this Permission.", + "type": "string" + }, + "onlyInPredefinedRoles": { + "description": "This permission can ONLY be used in predefined roles.", + "type": "boolean" + }, + "title": { + "description": "The title of this Permission.", + "type": "string" + }, + "description": { + "description": "A brief description of what this Permission is used for.", + "type": "string" + }, + "customRolesSupportLevel": { + "description": "The current custom role support level.", + "type": "string", + "enumDescriptions": [ + "Permission is fully supported for custom role use.", + "Permission is being tested to check custom role compatibility.", + "Permission is not supported for custom role use." + ], + "enum": [ + "SUPPORTED", + "TESTING", + "NOT_SUPPORTED" + ] + } + }, + "id": "Permission" + }, + "PolicyDelta": { + "description": "The difference delta between two policies.", + "type": "object", + "properties": { + "bindingDeltas": { + "description": "The delta for Bindings between two policies.", + "type": "array", + "items": { + "$ref": "BindingDelta" + } + } + }, + "id": "PolicyDelta" + }, + "ListServiceAccountsResponse": { + "description": "The service account list response.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.", + "type": "string" + }, + "accounts": { + "description": "The list of matching service accounts.", + "type": "array", + "items": { + "$ref": "ServiceAccount" + } + } + }, + "id": "ListServiceAccountsResponse" + }, + "QueryGrantableRolesResponse": { + "description": "The grantable role query response.", + "type": "object", + "properties": { + "roles": { + "description": "The list of matching roles.", + "type": "array", + "items": { + "$ref": "Role" + } + }, + "nextPageToken": { + "description": "To retrieve the next page of results, set\n`QueryGrantableRolesRequest.page_token` to this value.", + "type": "string" + } + }, + "id": "QueryGrantableRolesResponse" + }, + "SignBlobRequest": { + "description": "The service account sign blob request.", + "type": "object", + "properties": { + "bytesToSign": { + "description": "The bytes to sign.", + "format": "byte", + "type": "string" + } + }, + "id": "SignBlobRequest" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "policy": { + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", + "$ref": "Policy" + } + }, + "id": "SetIamPolicyRequest" + }, + "QueryTestablePermissionsResponse": { + "description": "The response containing permissions which can be tested on a resource.", + "type": "object", + "properties": { + "permissions": { + "description": "The Permissions testable on the requested resource.", + "type": "array", + "items": { + "$ref": "Permission" + } + }, + "nextPageToken": { + "description": "To retrieve the next page of results, set\n`QueryTestableRolesRequest.page_token` to this value.", + "type": "string" + } + }, + "id": "QueryTestablePermissionsResponse" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, "CreateServiceAccountKeyRequest": { "description": "The service account key create request.", "type": "object", @@ -1056,6 +1240,8 @@ ] }, "privateKeyType": { + "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.", + "type": "string", "enumDescriptions": [ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.", "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.", @@ -1065,9 +1251,7 @@ "TYPE_UNSPECIFIED", "TYPE_PKCS12_FILE", "TYPE_GOOGLE_CREDENTIALS_FILE" - ], - "description": "The output format of the private key. `GOOGLE_CREDENTIALS_FILE` is the\ndefault output format.", - "type": "string" + ] } }, "id": "CreateServiceAccountKeyRequest" @@ -1148,8 +1332,8 @@ "type": "object", "properties": { "policyDelta": { - "description": "Policy delta between the original policy and the newly set policy.", - "$ref": "PolicyDelta" + "$ref": "PolicyDelta", + "description": "Policy delta between the original policy and the newly set policy." } }, "id": "AuditData" @@ -1199,13 +1383,13 @@ "description": "The service account create request.", "type": "object", "properties": { - "serviceAccount": { - "$ref": "ServiceAccount", - "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` ." - }, "accountId": { "description": "Required. The account id that is used to generate the service account\nemail address and a stable unique id. It is unique within a project,\nmust be 6-30 characters long, and match the regular expression\n`[a-z]([-a-z0-9]*[a-z0-9])` to comply with RFC1035.", "type": "string" + }, + "serviceAccount": { + "description": "The ServiceAccount resource to create.\nCurrently, only the following values are user assignable:\n`display_name` .", + "$ref": "ServiceAccount" } }, "id": "CreateServiceAccountRequest" @@ -1239,6 +1423,8 @@ "type": "string" }, "stage": { + "description": "The current launch stage of the role.", + "type": "string", "enumDescriptions": [ "The user has indicated this role is currently in an alpha phase.", "The user has indicated this role is currently in a beta phase.", @@ -1254,9 +1440,7 @@ "DEPRECATED", "DISABLED", "EAP" - ], - "description": "The current launch stage of the role.", - "type": "string" + ] }, "name": { "description": "The name of the role.\n\nWhen Role is used in CreateRole, the role name must not be set.\n\nWhen Role is used in output and other input such as UpdateRole, the role\nname is the complete path, e.g., roles/logging.viewer for curated roles\nand organizations/{ORGANIZATION_ID}/roles/logging.viewer for custom roles.", @@ -1283,10 +1467,50 @@ }, "id": "Binding" }, + "QueryGrantableRolesRequest": { + "description": "The grantable role query request.", + "type": "object", + "properties": { + "fullResourceName": { + "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.", + "type": "string" + }, + "pageToken": { + "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.", + "type": "string" + }, + "pageSize": { + "description": "Optional limit on the number of roles to include in the response.", + "format": "int32", + "type": "integer" + }, + "view": { + "type": "string", + "enumDescriptions": [ + "Omits the `included_permissions` field.\nThis is the default value.", + "Returns all fields." + ], + "enum": [ + "BASIC", + "FULL" + ] + } + }, + "id": "QueryGrantableRolesRequest" + }, "ServiceAccount": { "description": "A service account in the Identity and Access Management API.\n\nTo create a service account, specify the `project_id` and the `account_id`\nfor the account. The `account_id` is unique within the project, and is used\nto generate the service account email address and a stable\n`unique_id`.\n\nIf the account already exists, the account's resource name is returned\nin the format of projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}. The caller\ncan use the name in other methods to access the account.\n\nAll other methods can identify the service account using the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\nUsing `-` as a wildcard for the `PROJECT_ID` will infer the project from\nthe account. The `ACCOUNT` value can be the `email` address or the\n`unique_id` of the service account.", "type": "object", "properties": { + "displayName": { + "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.", + "type": "string" + }, + "etag": { + "description": "Used to perform a consistent read-modify-write.", + "format": "byte", + "type": "string" + }, "name": { "description": "The resource name of the service account in the following format:\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.\n\nRequests using `-` as a wildcard for the `PROJECT_ID` will infer the\nproject from the `account` and the `ACCOUNT` value can be the `email`\naddress or the `unique_id` of the service account.\n\nIn responses the resource name will always be in the format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}`.", "type": "string" @@ -1306,50 +1530,10 @@ "uniqueId": { "description": "@OutputOnly The unique and stable id of the service account.", "type": "string" - }, - "displayName": { - "description": "Optional. A user-specified description of the service account. Must be\nfewer than 100 UTF-8 bytes.", - "type": "string" - }, - "etag": { - "description": "Used to perform a consistent read-modify-write.", - "format": "byte", - "type": "string" } }, "id": "ServiceAccount" }, - "QueryGrantableRolesRequest": { - "description": "The grantable role query request.", - "type": "object", - "properties": { - "pageSize": { - "description": "Optional limit on the number of roles to include in the response.", - "format": "int32", - "type": "integer" - }, - "view": { - "type": "string", - "enumDescriptions": [ - "Omits the `included_permissions` field.\nThis is the default value.", - "Returns all fields." - ], - "enum": [ - "BASIC", - "FULL" - ] - }, - "fullResourceName": { - "description": "Required. The full resource name to query from the list of grantable roles.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.", - "type": "string" - }, - "pageToken": { - "description": "Optional pagination token returned in an earlier\nQueryGrantableRolesResponse.", - "type": "string" - } - }, - "id": "QueryGrantableRolesRequest" - }, "CreateRoleRequest": { "description": "The request to create a new role.", "type": "object", @@ -1359,46 +1543,12 @@ "type": "string" }, "role": { - "$ref": "Role", - "description": "The Role resource to create." + "description": "The Role resource to create.", + "$ref": "Role" } }, "id": "CreateRoleRequest" }, - "QueryTestablePermissionsRequest": { - "description": "A request to get permissions which can be tested on a resource.", - "type": "object", - "properties": { - "fullResourceName": { - "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.", - "type": "string" - }, - "pageToken": { - "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.", - "type": "string" - }, - "pageSize": { - "description": "Optional limit on the number of permissions to include in the response.", - "format": "int32", - "type": "integer" - } - }, - "id": "QueryTestablePermissionsRequest" - }, - "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsResponse" - }, "ListServiceAccountKeysResponse": { "description": "The service account keys list response.", "type": "object", @@ -1413,24 +1563,44 @@ }, "id": "ListServiceAccountKeysResponse" }, + "TestIamPermissionsResponse": { + "description": "Response message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsResponse" + }, + "QueryTestablePermissionsRequest": { + "description": "A request to get permissions which can be tested on a resource.", + "type": "object", + "properties": { + "pageSize": { + "description": "Optional limit on the number of permissions to include in the response.", + "format": "int32", + "type": "integer" + }, + "fullResourceName": { + "description": "Required. The full resource name to query from the list of testable\npermissions.\n\nThe name follows the Google Cloud Platform resource format.\nFor example, a Cloud Platform project with id `my-project` will be named\n`//cloudresourcemanager.googleapis.com/projects/my-project`.", + "type": "string" + }, + "pageToken": { + "description": "Optional pagination token returned in an earlier\nQueryTestablePermissionsRequest.", + "type": "string" + } + }, + "id": "QueryTestablePermissionsRequest" + }, "ServiceAccountKey": { "description": "Represents a service account key.\n\nA service account has two sets of key-pairs: user-managed, and\nsystem-managed.\n\nUser-managed key-pairs can be created and deleted by users. Users are\nresponsible for rotating these keys periodically to ensure security of\ntheir service accounts. Users retain the private key of these key-pairs,\nand Google retains ONLY the public key.\n\nSystem-managed key-pairs are managed automatically by Google, and rotated\ndaily without user intervention. The private key never leaves Google's\nservers to maximize security.\n\nPublic keys for all service accounts are also published at the OAuth2\nService Account API.", "type": "object", "properties": { - "privateKeyData": { - "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.", - "format": "byte", - "type": "string" - }, - "publicKeyData": { - "description": "The public key data. Only provided in `GetServiceAccountKey` responses.", - "format": "byte", - "type": "string" - }, - "name": { - "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.", - "type": "string" - }, "validBeforeTime": { "description": "The key can be used before this timestamp.", "format": "google-datetime", @@ -1456,6 +1626,8 @@ "type": "string" }, "privateKeyType": { + "description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.", + "type": "string", "enumDescriptions": [ "Unspecified. Equivalent to `TYPE_GOOGLE_CREDENTIALS_FILE`.", "PKCS12 format.\nThe password for the PKCS12 file is `notasecret`.\nFor more information, see https://tools.ietf.org/html/rfc7292.", @@ -1465,196 +1637,31 @@ "TYPE_UNSPECIFIED", "TYPE_PKCS12_FILE", "TYPE_GOOGLE_CREDENTIALS_FILE" - ], - "description": "The output format for the private key.\nOnly provided in `CreateServiceAccountKey` responses, not\nin `GetServiceAccountKey` or `ListServiceAccountKey` responses.\n\nGoogle never exposes system-managed private keys, and never retains\nuser-managed private keys.", + ] + }, + "privateKeyData": { + "description": "The private key data. Only provided in `CreateServiceAccountKey`\nresponses. Make sure to keep the private key data secure because it\nallows for the assertion of the service account identity.\nWhen decoded, the private key data can be used to authenticate with\nGoogle API client libraries and with\n\u003ca href=\"/sdk/gcloud/reference/auth/activate-service-account\"\u003egcloud\nauth activate-service-account\u003c/a\u003e.", + "format": "byte", + "type": "string" + }, + "publicKeyData": { + "description": "The public key data. Only provided in `GetServiceAccountKey` responses.", + "format": "byte", + "type": "string" + }, + "name": { + "description": "The resource name of the service account key in the following format\n`projects/{PROJECT_ID}/serviceAccounts/{ACCOUNT}/keys/{key}`.", "type": "string" } }, "id": "ServiceAccountKey" - }, - "SignBlobResponse": { - "description": "The service account sign blob response.", - "type": "object", - "properties": { - "signature": { - "description": "The signed blob.", - "format": "byte", - "type": "string" - }, - "keyId": { - "description": "The id of the key used to sign the blob.", - "type": "string" - } - }, - "id": "SignBlobResponse" - }, - "SignJwtRequest": { - "description": "The service account sign JWT request.", - "type": "object", - "properties": { - "payload": { - "description": "The JWT payload to sign, a JSON JWT Claim set.", - "type": "string" - } - }, - "id": "SignJwtRequest" - }, - "Permission": { - "description": "A permission which can be included by a role.", - "type": "object", - "properties": { - "onlyInPredefinedRoles": { - "description": "This permission can ONLY be used in predefined roles.", - "type": "boolean" - }, - "title": { - "description": "The title of this Permission.", - "type": "string" - }, - "description": { - "description": "A brief description of what this Permission is used for.", - "type": "string" - }, - "customRolesSupportLevel": { - "description": "The current custom role support level.", - "type": "string", - "enumDescriptions": [ - "Permission is fully supported for custom role use.", - "Permission is being tested to check custom role compatibility.", - "Permission is not supported for custom role use." - ], - "enum": [ - "SUPPORTED", - "TESTING", - "NOT_SUPPORTED" - ] - }, - "stage": { - "description": "The current launch stage of the permission.", - "type": "string", - "enumDescriptions": [ - "The permission is currently in an alpha phase.", - "The permission is currently in a beta phase.", - "The permission is generally available.", - "The permission is being deprecated." - ], - "enum": [ - "ALPHA", - "BETA", - "GA", - "DEPRECATED" - ] - }, - "name": { - "description": "The name of this Permission.", - "type": "string" - } - }, - "id": "Permission" - }, - "PolicyDelta": { - "description": "The difference delta between two policies.", - "type": "object", - "properties": { - "bindingDeltas": { - "description": "The delta for Bindings between two policies.", - "type": "array", - "items": { - "$ref": "BindingDelta" - } - } - }, - "id": "PolicyDelta" - }, - "ListServiceAccountsResponse": { - "description": "The service account list response.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "To retrieve the next page of results, set\nListServiceAccountsRequest.page_token\nto this value.", - "type": "string" - }, - "accounts": { - "description": "The list of matching service accounts.", - "type": "array", - "items": { - "$ref": "ServiceAccount" - } - } - }, - "id": "ListServiceAccountsResponse" - }, - "QueryGrantableRolesResponse": { - "description": "The grantable role query response.", - "type": "object", - "properties": { - "roles": { - "description": "The list of matching roles.", - "type": "array", - "items": { - "$ref": "Role" - } - }, - "nextPageToken": { - "description": "To retrieve the next page of results, set\n`QueryGrantableRolesRequest.page_token` to this value.", - "type": "string" - } - }, - "id": "QueryGrantableRolesResponse" - }, - "SignBlobRequest": { - "description": "The service account sign blob request.", - "type": "object", - "properties": { - "bytesToSign": { - "description": "The bytes to sign.", - "format": "byte", - "type": "string" - } - }, - "id": "SignBlobRequest" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." - } - }, - "id": "SetIamPolicyRequest" - }, - "QueryTestablePermissionsResponse": { - "description": "The response containing permissions which can be tested on a resource.", - "type": "object", - "properties": { - "permissions": { - "description": "The Permissions testable on the requested resource.", - "type": "array", - "items": { - "$ref": "Permission" - } - }, - "nextPageToken": { - "description": "To retrieve the next page of results, set\n`QueryTestableRolesRequest.page_token` to this value.", - "type": "string" - } - }, - "id": "QueryTestablePermissionsResponse" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" } }, - "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, + "protocol": "rest", "canonicalName": "iam", "auth": { "oauth2": { @@ -1664,12 +1671,5 @@ } } } - }, - "rootUrl": "https://iam.googleapis.com/", - "ownerDomain": "google.com", - "name": "iam", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Identity and Access Management (IAM) API", - "ownerName": "Google" + } }
diff --git a/kgsearch/v1/kgsearch-api.json b/kgsearch/v1/kgsearch-api.json index d76ba45..01a7c9a 100644 --- a/kgsearch/v1/kgsearch-api.json +++ b/kgsearch/v1/kgsearch-api.json
@@ -1,17 +1,4 @@ { - "version": "v1", - "baseUrl": "https://kgsearch.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Searches the Google Knowledge Graph for entities.", - "servicePath": "", - "rootUrl": "https://kgsearch.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "kgsearch", - "batchPath": "batch", - "revision": "20180104", - "documentationLink": "https://developers.google.com/knowledge-graph/", - "id": "kgsearch:v1", "title": "Knowledge Graph Search API", "discoveryVersion": "v1", "ownerName": "Google", @@ -20,21 +7,21 @@ "entities": { "methods": { "search": { + "httpMethod": "GET", + "parameterOrder": [], "response": { "$ref": "SearchResponse" }, - "parameterOrder": [], - "httpMethod": "GET", "parameters": { "prefix": { - "location": "query", "description": "Enables prefix match against names and aliases of entities", - "type": "boolean" + "type": "boolean", + "location": "query" }, "query": { - "location": "query", "description": "The literal query string for search.", - "type": "string" + "type": "string", + "location": "query" }, "types": { "repeated": true, @@ -48,10 +35,10 @@ "type": "boolean" }, "languages": { - "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.", - "type": "string", "repeated": true, - "location": "query" + "location": "query", + "description": "The list of language codes (defined in ISO 693) to run the query with,\ne.g. 'en'.", + "type": "string" }, "ids": { "repeated": true, @@ -60,63 +47,50 @@ "type": "string" }, "limit": { + "location": "query", "description": "Limits the number of entities to be returned.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" } }, "flatPath": "v1/entities:search", - "path": "v1/entities:search", "id": "kgsearch.entities.search", + "path": "v1/entities:search", "description": "Searches Knowledge Graph for entities that match the constraints.\nA list of matched entities will be returned in response, which will be in\nJSON-LD format and compatible with http://schema.org" } } } }, "parameters": { - "upload_protocol": { + "fields": { "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" }, "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], "location": "query" }, "alt": { - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -128,7 +102,9 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], - "location": "query" + "location": "query", + "description": "Data format for response.", + "default": "json" }, "access_token": { "description": "OAuth access token.", @@ -136,39 +112,49 @@ "location": "query" }, "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { "location": "query", - "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.", + "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.", "type": "string" }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "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.", "type": "string", "location": "query" }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" } }, "schemas": { "SearchResponse": { + "id": "SearchResponse", + "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.", + "type": "object", "properties": { - "@type": { - "description": "The schema type of top-level JSON-LD object, e.g. ItemList.", - "type": "any" - }, "@context": { "description": "The local context applicable for the response. See more details at\nhttp://www.w3.org/TR/json-ld/#context-definitions.", "type": "any" @@ -179,16 +165,30 @@ "items": { "type": "any" } + }, + "@type": { + "description": "The schema type of top-level JSON-LD object, e.g. ItemList.", + "type": "any" } - }, - "id": "SearchResponse", - "description": "Response message includes the context and a list of matching results\nwhich contain the detail of associated entities.", - "type": "object" + } } }, + "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest" + "version": "v1", + "baseUrl": "https://kgsearch.googleapis.com/", + "servicePath": "", + "description": "Searches the Google Knowledge Graph for entities.", + "kind": "discovery#restDescription", + "rootUrl": "https://kgsearch.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "kgsearch", + "batchPath": "batch", + "revision": "20180104", + "documentationLink": "https://developers.google.com/knowledge-graph/", + "id": "kgsearch:v1" }
diff --git a/language/v1/language-api.json b/language/v1/language-api.json index 57f11a9..88728fb 100644 --- a/language/v1/language-api.json +++ b/language/v1/language-api.json
@@ -1,423 +1,6 @@ { - "basePath": "", - "revision": "20171231", - "documentationLink": "https://cloud.google.com/natural-language/", - "id": "language:v1", - "discoveryVersion": "v1", "version_module": true, "schemas": { - "ClassifyTextResponse": { - "type": "object", - "properties": { - "categories": { - "type": "array", - "items": { - "$ref": "ClassificationCategory" - }, - "description": "Categories representing the input document." - } - }, - "id": "ClassifyTextResponse", - "description": "The document classification response message." - }, - "EntityMention": { - "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.", - "type": "object", - "properties": { - "text": { - "$ref": "TextSpan", - "description": "The mention text." - }, - "type": { - "enumDescriptions": [ - "Unknown", - "Proper name", - "Common noun (or noun compound)" - ], - "enum": [ - "TYPE_UNKNOWN", - "PROPER", - "COMMON" - ], - "description": "The type of the entity mention.", - "type": "string" - }, - "sentiment": { - "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.", - "$ref": "Sentiment" - } - }, - "id": "EntityMention" - }, - "Sentence": { - "description": "Represents a sentence in the input document.", - "type": "object", - "properties": { - "text": { - "$ref": "TextSpan", - "description": "The sentence text." - }, - "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence." - } - }, - "id": "Sentence" - }, - "Sentiment": { - "properties": { - "score": { - "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).", - "format": "float", - "type": "number" - }, - "magnitude": { - "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).", - "format": "float", - "type": "number" - } - }, - "id": "Sentiment", - "description": "Represents the feeling associated with the entire text or entities in\nthe text.", - "type": "object" - }, - "AnalyzeEntitySentimentRequest": { - "description": "The entity-level sentiment analysis request message.", - "type": "object", - "properties": { - "encodingType": { - "description": "The encoding type used by the API to calculate offsets.", - "type": "string", - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ], - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ] - }, - "document": { - "$ref": "Document", - "description": "Input document." - } - }, - "id": "AnalyzeEntitySentimentRequest" - }, - "PartOfSpeech": { - "description": "Represents part of speech information for a token. Parts of speech\nare as defined in\nhttp://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf", - "type": "object", - "properties": { - "case": { - "enum": [ - "CASE_UNKNOWN", - "ACCUSATIVE", - "ADVERBIAL", - "COMPLEMENTIVE", - "DATIVE", - "GENITIVE", - "INSTRUMENTAL", - "LOCATIVE", - "NOMINATIVE", - "OBLIQUE", - "PARTITIVE", - "PREPOSITIONAL", - "REFLEXIVE_CASE", - "RELATIVE_CASE", - "VOCATIVE" - ], - "description": "The grammatical case.", - "type": "string", - "enumDescriptions": [ - "Case is not applicable in the analyzed language or is not predicted.", - "Accusative", - "Adverbial", - "Complementive", - "Dative", - "Genitive", - "Instrumental", - "Locative", - "Nominative", - "Oblique", - "Partitive", - "Prepositional", - "Reflexive", - "Relative", - "Vocative" - ] - }, - "tense": { - "enumDescriptions": [ - "Tense is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Future", - "Past", - "Present", - "Imperfect", - "Pluperfect" - ], - "enum": [ - "TENSE_UNKNOWN", - "CONDITIONAL_TENSE", - "FUTURE", - "PAST", - "PRESENT", - "IMPERFECT", - "PLUPERFECT" - ], - "description": "The grammatical tense.", - "type": "string" - }, - "reciprocity": { - "enumDescriptions": [ - "Reciprocity is not applicable in the analyzed language or is not\npredicted.", - "Reciprocal", - "Non-reciprocal" - ], - "enum": [ - "RECIPROCITY_UNKNOWN", - "RECIPROCAL", - "NON_RECIPROCAL" - ], - "description": "The grammatical reciprocity.", - "type": "string" - }, - "form": { - "enumDescriptions": [ - "Form is not applicable in the analyzed language or is not predicted.", - "Adnomial", - "Auxiliary", - "Complementizer", - "Final ending", - "Gerund", - "Realis", - "Irrealis", - "Short form", - "Long form", - "Order form", - "Specific form" - ], - "enum": [ - "FORM_UNKNOWN", - "ADNOMIAL", - "AUXILIARY", - "COMPLEMENTIZER", - "FINAL_ENDING", - "GERUND", - "REALIS", - "IRREALIS", - "SHORT", - "LONG", - "ORDER", - "SPECIFIC" - ], - "description": "The grammatical form.", - "type": "string" - }, - "number": { - "type": "string", - "enumDescriptions": [ - "Number is not applicable in the analyzed language or is not predicted.", - "Singular", - "Plural", - "Dual" - ], - "enum": [ - "NUMBER_UNKNOWN", - "SINGULAR", - "PLURAL", - "DUAL" - ], - "description": "The grammatical number." - }, - "voice": { - "description": "The grammatical voice.", - "type": "string", - "enumDescriptions": [ - "Voice is not applicable in the analyzed language or is not predicted.", - "Active", - "Causative", - "Passive" - ], - "enum": [ - "VOICE_UNKNOWN", - "ACTIVE", - "CAUSATIVE", - "PASSIVE" - ] - }, - "aspect": { - "description": "The grammatical aspect.", - "type": "string", - "enumDescriptions": [ - "Aspect is not applicable in the analyzed language or is not predicted.", - "Perfective", - "Imperfective", - "Progressive" - ], - "enum": [ - "ASPECT_UNKNOWN", - "PERFECTIVE", - "IMPERFECTIVE", - "PROGRESSIVE" - ] - }, - "mood": { - "type": "string", - "enumDescriptions": [ - "Mood is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Imperative", - "Indicative", - "Interrogative", - "Jussive", - "Subjunctive" - ], - "enum": [ - "MOOD_UNKNOWN", - "CONDITIONAL_MOOD", - "IMPERATIVE", - "INDICATIVE", - "INTERROGATIVE", - "JUSSIVE", - "SUBJUNCTIVE" - ], - "description": "The grammatical mood." - }, - "tag": { - "enumDescriptions": [ - "Unknown", - "Adjective", - "Adposition (preposition and postposition)", - "Adverb", - "Conjunction", - "Determiner", - "Noun (common and proper)", - "Cardinal number", - "Pronoun", - "Particle or other function word", - "Punctuation", - "Verb (all tenses and modes)", - "Other: foreign words, typos, abbreviations", - "Affix" - ], - "enum": [ - "UNKNOWN", - "ADJ", - "ADP", - "ADV", - "CONJ", - "DET", - "NOUN", - "NUM", - "PRON", - "PRT", - "PUNCT", - "VERB", - "X", - "AFFIX" - ], - "description": "The part of speech tag.", - "type": "string" - }, - "gender": { - "type": "string", - "enumDescriptions": [ - "Gender is not applicable in the analyzed language or is not predicted.", - "Feminine", - "Masculine", - "Neuter" - ], - "enum": [ - "GENDER_UNKNOWN", - "FEMININE", - "MASCULINE", - "NEUTER" - ], - "description": "The grammatical gender." - }, - "person": { - "enumDescriptions": [ - "Person is not applicable in the analyzed language or is not predicted.", - "First", - "Second", - "Third", - "Reflexive" - ], - "enum": [ - "PERSON_UNKNOWN", - "FIRST", - "SECOND", - "THIRD", - "REFLEXIVE_PERSON" - ], - "description": "The grammatical person.", - "type": "string" - }, - "proper": { - "enum": [ - "PROPER_UNKNOWN", - "PROPER", - "NOT_PROPER" - ], - "description": "The grammatical properness.", - "type": "string", - "enumDescriptions": [ - "Proper is not applicable in the analyzed language or is not predicted.", - "Proper", - "Not proper" - ] - } - }, - "id": "PartOfSpeech" - }, - "ClassificationCategory": { - "description": "Represents a category returned from the text classifier.", - "type": "object", - "properties": { - "confidence": { - "description": "The classifier's confidence of the category. Number represents how certain\nthe classifier is that this category represents the given text.", - "format": "float", - "type": "number" - }, - "name": { - "description": "The name of the category representing the document.", - "type": "string" - } - }, - "id": "ClassificationCategory" - }, - "AnalyzeSyntaxRequest": { - "id": "AnalyzeSyntaxRequest", - "description": "The syntax analysis request message.", - "type": "object", - "properties": { - "encodingType": { - "type": "string", - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ], - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "description": "The encoding type used by the API to calculate offsets." - }, - "document": { - "description": "Input document.", - "$ref": "Document" - } - } - }, "AnalyzeEntitiesResponse": { "description": "The entity analysis response message.", "type": "object", @@ -437,15 +20,26 @@ "id": "AnalyzeEntitiesResponse" }, "Entity": { + "id": "Entity", "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.", "type": "object", "properties": { + "sentiment": { + "$ref": "Sentiment", + "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document." + }, + "mentions": { + "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.", + "type": "array", + "items": { + "$ref": "EntityMention" + } + }, "name": { "description": "The representative name for the entity.", "type": "string" }, "type": { - "type": "string", "enumDescriptions": [ "Unknown", "Person", @@ -466,33 +60,22 @@ "CONSUMER_GOOD", "OTHER" ], - "description": "The entity type." + "description": "The entity type.", + "type": "string" }, "metadata": { - "type": "object", "additionalProperties": { "type": "string" }, - "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively." + "description": "Metadata associated with the entity.\n\nCurrently, Wikipedia URLs and Knowledge Graph MIDs are provided, if\navailable. The associated keys are \"wikipedia_url\" and \"mid\", respectively.", + "type": "object" }, "salience": { - "type": "number", "description": "The salience score associated with the entity in the [0, 1.0] range.\n\nThe salience score for an entity provides information about the\nimportance or centrality of that entity to the entire document text.\nScores closer to 0 are less salient, while scores closer to 1.0 are highly\nsalient.", - "format": "float" - }, - "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document." - }, - "mentions": { - "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.", - "type": "array", - "items": { - "$ref": "EntityMention" - } + "format": "float", + "type": "number" } - }, - "id": "Entity" + } }, "AnnotateTextRequest": { "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.", @@ -515,12 +98,12 @@ "type": "string" }, "document": { - "$ref": "Document", - "description": "Input document." + "description": "Input document.", + "$ref": "Document" }, "features": { - "$ref": "Features", - "description": "The enabled features." + "description": "The enabled features.", + "$ref": "Features" } }, "id": "AnnotateTextRequest" @@ -530,6 +113,7 @@ "type": "object", "properties": { "encodingType": { + "type": "string", "enumDescriptions": [ "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", @@ -542,54 +126,49 @@ "UTF16", "UTF32" ], - "description": "The encoding type used by the API to calculate sentence offsets.", - "type": "string" + "description": "The encoding type used by the API to calculate sentence offsets." }, "document": { - "$ref": "Document", - "description": "Input document." + "description": "Input document.", + "$ref": "Document" } }, "id": "AnalyzeSentimentRequest" }, "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.", "type": "object", "properties": { "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "type": "object" + } } }, "code": { - "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" + "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" } }, - "id": "Status" + "id": "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." }, "Features": { "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.", "type": "object", "properties": { - "extractEntities": { - "type": "boolean", - "description": "Extract entities." - }, "classifyText": { - "type": "boolean", - "description": "Classify the full document into categories." + "description": "Classify the full document into categories.", + "type": "boolean" }, "extractSyntax": { "description": "Extract syntax information.", @@ -600,22 +179,22 @@ "type": "boolean" }, "extractEntitySentiment": { - "description": "Extract entities and their associated sentiment.", + "type": "boolean", + "description": "Extract entities and their associated sentiment." + }, + "extractEntities": { + "description": "Extract entities.", "type": "boolean" } }, "id": "Features" }, "Document": { + "id": "Document", "description": "################################################################ #\n\nRepresents the input to API methods.", "type": "object", "properties": { - "language": { - "type": "string", - "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned." - }, "type": { - "type": "string", "enumDescriptions": [ "The content type is not specified.", "Plain text", @@ -626,34 +205,28 @@ "PLAIN_TEXT", "HTML" ], - "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error." + "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", + "type": "string" }, "content": { - "type": "string", - "description": "The content of the input in string format." + "description": "The content of the input in string format.", + "type": "string" }, "gcsContentUri": { - "type": "string", - "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported." + "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.", + "type": "string" + }, + "language": { + "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.", + "type": "string" } - }, - "id": "Document" + } }, "AnalyzeEntitiesRequest": { "description": "The entity analysis request message.", "type": "object", "properties": { - "document": { - "$ref": "Document", - "description": "Input document." - }, "encodingType": { - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ], "enum": [ "NONE", "UTF8", @@ -661,12 +234,23 @@ "UTF32" ], "description": "The encoding type used by the API to calculate offsets.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ] + }, + "document": { + "$ref": "Document", + "description": "Input document." } }, "id": "AnalyzeEntitiesRequest" }, "ClassifyTextRequest": { + "description": "The document classification request message.", "type": "object", "properties": { "document": { @@ -674,32 +258,37 @@ "description": "Input document." } }, - "id": "ClassifyTextRequest", - "description": "The document classification request message." + "id": "ClassifyTextRequest" }, "AnalyzeEntitySentimentResponse": { "description": "The entity-level sentiment analysis response message.", "type": "object", "properties": { + "language": { + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", + "type": "string" + }, "entities": { "description": "The recognized entities in the input document with associated sentiments.", "type": "array", "items": { "$ref": "Entity" } - }, - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" } }, "id": "AnalyzeEntitySentimentResponse" }, "AnalyzeSentimentResponse": { - "id": "AnalyzeSentimentResponse", "description": "The sentiment analysis response message.", "type": "object", "properties": { + "sentences": { + "description": "The sentiment for all the sentences in the document.", + "type": "array", + "items": { + "$ref": "Sentence" + } + }, "documentSentiment": { "$ref": "Sentiment", "description": "The overall sentiment of the input document." @@ -707,17 +296,12 @@ "language": { "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", "type": "string" - }, - "sentences": { - "description": "The sentiment for all the sentences in the document.", - "type": "array", - "items": { - "$ref": "Sentence" - } } - } + }, + "id": "AnalyzeSentimentResponse" }, "AnalyzeSyntaxResponse": { + "description": "The syntax analysis response message.", "type": "object", "properties": { "language": { @@ -739,10 +323,10 @@ } } }, - "id": "AnalyzeSyntaxResponse", - "description": "The syntax analysis response message." + "id": "AnalyzeSyntaxResponse" }, "AnnotateTextResponse": { + "description": "The text annotations response message.", "type": "object", "properties": { "categories": { @@ -753,12 +337,12 @@ } }, "documentSentiment": { - "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.", - "$ref": "Sentiment" + "$ref": "Sentiment", + "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment." }, "language": { - "type": "string", - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details." + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", + "type": "string" }, "entities": { "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.", @@ -782,104 +366,13 @@ } } }, - "id": "AnnotateTextResponse", - "description": "The text annotations response message." + "id": "AnnotateTextResponse" }, "DependencyEdge": { "description": "Represents dependency parse tree information for a token. (For more\ninformation on dependency labels, see\nhttp://www.aclweb.org/anthology/P13-2017", "type": "object", "properties": { - "headTokenIndex": { - "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.", - "format": "int32", - "type": "integer" - }, "label": { - "enum": [ - "UNKNOWN", - "ABBREV", - "ACOMP", - "ADVCL", - "ADVMOD", - "AMOD", - "APPOS", - "ATTR", - "AUX", - "AUXPASS", - "CC", - "CCOMP", - "CONJ", - "CSUBJ", - "CSUBJPASS", - "DEP", - "DET", - "DISCOURSE", - "DOBJ", - "EXPL", - "GOESWITH", - "IOBJ", - "MARK", - "MWE", - "MWV", - "NEG", - "NN", - "NPADVMOD", - "NSUBJ", - "NSUBJPASS", - "NUM", - "NUMBER", - "P", - "PARATAXIS", - "PARTMOD", - "PCOMP", - "POBJ", - "POSS", - "POSTNEG", - "PRECOMP", - "PRECONJ", - "PREDET", - "PREF", - "PREP", - "PRONL", - "PRT", - "PS", - "QUANTMOD", - "RCMOD", - "RCMODREL", - "RDROP", - "REF", - "REMNANT", - "REPARANDUM", - "ROOT", - "SNUM", - "SUFF", - "TMOD", - "TOPIC", - "VMOD", - "VOCATIVE", - "XCOMP", - "SUFFIX", - "TITLE", - "ADVPHMOD", - "AUXCAUS", - "AUXVV", - "DTMOD", - "FOREIGN", - "KW", - "LIST", - "NOMC", - "NOMCSUBJ", - "NOMCSUBJPASS", - "NUMC", - "COP", - "DISLOCATED", - "ASP", - "GMOD", - "GOBJ", - "INFMOD", - "MES", - "NCOMP" - ], "description": "The parse label for the token.", "type": "string", "enumDescriptions": [ @@ -966,7 +459,97 @@ "Infinitival modifier", "Measure", "Nominal complement of a noun" + ], + "enum": [ + "UNKNOWN", + "ABBREV", + "ACOMP", + "ADVCL", + "ADVMOD", + "AMOD", + "APPOS", + "ATTR", + "AUX", + "AUXPASS", + "CC", + "CCOMP", + "CONJ", + "CSUBJ", + "CSUBJPASS", + "DEP", + "DET", + "DISCOURSE", + "DOBJ", + "EXPL", + "GOESWITH", + "IOBJ", + "MARK", + "MWE", + "MWV", + "NEG", + "NN", + "NPADVMOD", + "NSUBJ", + "NSUBJPASS", + "NUM", + "NUMBER", + "P", + "PARATAXIS", + "PARTMOD", + "PCOMP", + "POBJ", + "POSS", + "POSTNEG", + "PRECOMP", + "PRECONJ", + "PREDET", + "PREF", + "PREP", + "PRONL", + "PRT", + "PS", + "QUANTMOD", + "RCMOD", + "RCMODREL", + "RDROP", + "REF", + "REMNANT", + "REPARANDUM", + "ROOT", + "SNUM", + "SUFF", + "TMOD", + "TOPIC", + "VMOD", + "VOCATIVE", + "XCOMP", + "SUFFIX", + "TITLE", + "ADVPHMOD", + "AUXCAUS", + "AUXVV", + "DTMOD", + "FOREIGN", + "KW", + "LIST", + "NOMC", + "NOMCSUBJ", + "NOMCSUBJPASS", + "NUMC", + "COP", + "DISLOCATED", + "ASP", + "GMOD", + "GOBJ", + "INFMOD", + "MES", + "NCOMP" ] + }, + "headTokenIndex": { + "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.", + "format": "int32", + "type": "integer" } }, "id": "DependencyEdge" @@ -982,12 +565,12 @@ "description": "Parts of speech tag for this token." }, "text": { - "$ref": "TextSpan", - "description": "The token text." + "description": "The token text.", + "$ref": "TextSpan" }, "dependencyEdge": { - "description": "Dependency tree parse for this token.", - "$ref": "DependencyEdge" + "$ref": "DependencyEdge", + "description": "Dependency tree parse for this token." } }, "id": "Token", @@ -995,6 +578,9 @@ "type": "object" }, "TextSpan": { + "id": "TextSpan", + "description": "Represents an output piece of text.", + "type": "object", "properties": { "beginOffset": { "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.", @@ -1002,29 +588,438 @@ "type": "integer" }, "content": { - "type": "string", - "description": "The content of the output text." + "description": "The content of the output text.", + "type": "string" + } + } + }, + "ClassifyTextResponse": { + "description": "The document classification response message.", + "type": "object", + "properties": { + "categories": { + "description": "Categories representing the input document.", + "type": "array", + "items": { + "$ref": "ClassificationCategory" + } } }, - "id": "TextSpan", - "description": "Represents an output piece of text.", - "type": "object" + "id": "ClassifyTextResponse" + }, + "EntityMention": { + "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.", + "type": "object", + "properties": { + "text": { + "$ref": "TextSpan", + "description": "The mention text." + }, + "type": { + "enum": [ + "TYPE_UNKNOWN", + "PROPER", + "COMMON" + ], + "description": "The type of the entity mention.", + "type": "string", + "enumDescriptions": [ + "Unknown", + "Proper name", + "Common noun (or noun compound)" + ] + }, + "sentiment": { + "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.", + "$ref": "Sentiment" + } + }, + "id": "EntityMention" + }, + "Sentence": { + "description": "Represents a sentence in the input document.", + "type": "object", + "properties": { + "text": { + "description": "The sentence text.", + "$ref": "TextSpan" + }, + "sentiment": { + "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.", + "$ref": "Sentiment" + } + }, + "id": "Sentence" + }, + "Sentiment": { + "id": "Sentiment", + "description": "Represents the feeling associated with the entire text or entities in\nthe text.", + "type": "object", + "properties": { + "score": { + "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).", + "format": "float", + "type": "number" + }, + "magnitude": { + "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).", + "format": "float", + "type": "number" + } + } + }, + "AnalyzeEntitySentimentRequest": { + "description": "The entity-level sentiment analysis request message.", + "type": "object", + "properties": { + "encodingType": { + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ], + "enum": [ + "NONE", + "UTF8", + "UTF16", + "UTF32" + ], + "description": "The encoding type used by the API to calculate offsets.", + "type": "string" + }, + "document": { + "$ref": "Document", + "description": "Input document." + } + }, + "id": "AnalyzeEntitySentimentRequest" + }, + "PartOfSpeech": { + "type": "object", + "properties": { + "form": { + "enum": [ + "FORM_UNKNOWN", + "ADNOMIAL", + "AUXILIARY", + "COMPLEMENTIZER", + "FINAL_ENDING", + "GERUND", + "REALIS", + "IRREALIS", + "SHORT", + "LONG", + "ORDER", + "SPECIFIC" + ], + "description": "The grammatical form.", + "type": "string", + "enumDescriptions": [ + "Form is not applicable in the analyzed language or is not predicted.", + "Adnomial", + "Auxiliary", + "Complementizer", + "Final ending", + "Gerund", + "Realis", + "Irrealis", + "Short form", + "Long form", + "Order form", + "Specific form" + ] + }, + "number": { + "enumDescriptions": [ + "Number is not applicable in the analyzed language or is not predicted.", + "Singular", + "Plural", + "Dual" + ], + "enum": [ + "NUMBER_UNKNOWN", + "SINGULAR", + "PLURAL", + "DUAL" + ], + "description": "The grammatical number.", + "type": "string" + }, + "voice": { + "enum": [ + "VOICE_UNKNOWN", + "ACTIVE", + "CAUSATIVE", + "PASSIVE" + ], + "description": "The grammatical voice.", + "type": "string", + "enumDescriptions": [ + "Voice is not applicable in the analyzed language or is not predicted.", + "Active", + "Causative", + "Passive" + ] + }, + "aspect": { + "enumDescriptions": [ + "Aspect is not applicable in the analyzed language or is not predicted.", + "Perfective", + "Imperfective", + "Progressive" + ], + "enum": [ + "ASPECT_UNKNOWN", + "PERFECTIVE", + "IMPERFECTIVE", + "PROGRESSIVE" + ], + "description": "The grammatical aspect.", + "type": "string" + }, + "mood": { + "enumDescriptions": [ + "Mood is not applicable in the analyzed language or is not predicted.", + "Conditional", + "Imperative", + "Indicative", + "Interrogative", + "Jussive", + "Subjunctive" + ], + "enum": [ + "MOOD_UNKNOWN", + "CONDITIONAL_MOOD", + "IMPERATIVE", + "INDICATIVE", + "INTERROGATIVE", + "JUSSIVE", + "SUBJUNCTIVE" + ], + "description": "The grammatical mood.", + "type": "string" + }, + "tag": { + "enumDescriptions": [ + "Unknown", + "Adjective", + "Adposition (preposition and postposition)", + "Adverb", + "Conjunction", + "Determiner", + "Noun (common and proper)", + "Cardinal number", + "Pronoun", + "Particle or other function word", + "Punctuation", + "Verb (all tenses and modes)", + "Other: foreign words, typos, abbreviations", + "Affix" + ], + "enum": [ + "UNKNOWN", + "ADJ", + "ADP", + "ADV", + "CONJ", + "DET", + "NOUN", + "NUM", + "PRON", + "PRT", + "PUNCT", + "VERB", + "X", + "AFFIX" + ], + "description": "The part of speech tag.", + "type": "string" + }, + "gender": { + "enum": [ + "GENDER_UNKNOWN", + "FEMININE", + "MASCULINE", + "NEUTER" + ], + "description": "The grammatical gender.", + "type": "string", + "enumDescriptions": [ + "Gender is not applicable in the analyzed language or is not predicted.", + "Feminine", + "Masculine", + "Neuter" + ] + }, + "person": { + "description": "The grammatical person.", + "type": "string", + "enumDescriptions": [ + "Person is not applicable in the analyzed language or is not predicted.", + "First", + "Second", + "Third", + "Reflexive" + ], + "enum": [ + "PERSON_UNKNOWN", + "FIRST", + "SECOND", + "THIRD", + "REFLEXIVE_PERSON" + ] + }, + "proper": { + "enumDescriptions": [ + "Proper is not applicable in the analyzed language or is not predicted.", + "Proper", + "Not proper" + ], + "enum": [ + "PROPER_UNKNOWN", + "PROPER", + "NOT_PROPER" + ], + "description": "The grammatical properness.", + "type": "string" + }, + "case": { + "enum": [ + "CASE_UNKNOWN", + "ACCUSATIVE", + "ADVERBIAL", + "COMPLEMENTIVE", + "DATIVE", + "GENITIVE", + "INSTRUMENTAL", + "LOCATIVE", + "NOMINATIVE", + "OBLIQUE", + "PARTITIVE", + "PREPOSITIONAL", + "REFLEXIVE_CASE", + "RELATIVE_CASE", + "VOCATIVE" + ], + "description": "The grammatical case.", + "type": "string", + "enumDescriptions": [ + "Case is not applicable in the analyzed language or is not predicted.", + "Accusative", + "Adverbial", + "Complementive", + "Dative", + "Genitive", + "Instrumental", + "Locative", + "Nominative", + "Oblique", + "Partitive", + "Prepositional", + "Reflexive", + "Relative", + "Vocative" + ] + }, + "tense": { + "enum": [ + "TENSE_UNKNOWN", + "CONDITIONAL_TENSE", + "FUTURE", + "PAST", + "PRESENT", + "IMPERFECT", + "PLUPERFECT" + ], + "description": "The grammatical tense.", + "type": "string", + "enumDescriptions": [ + "Tense is not applicable in the analyzed language or is not predicted.", + "Conditional", + "Future", + "Past", + "Present", + "Imperfect", + "Pluperfect" + ] + }, + "reciprocity": { + "enumDescriptions": [ + "Reciprocity is not applicable in the analyzed language or is not\npredicted.", + "Reciprocal", + "Non-reciprocal" + ], + "enum": [ + "RECIPROCITY_UNKNOWN", + "RECIPROCAL", + "NON_RECIPROCAL" + ], + "description": "The grammatical reciprocity.", + "type": "string" + } + }, + "id": "PartOfSpeech", + "description": "Represents part of speech information for a token. Parts of speech\nare as defined in\nhttp://www.lrec-conf.org/proceedings/lrec2012/pdf/274_Paper.pdf" + }, + "ClassificationCategory": { + "description": "Represents a category returned from the text classifier.", + "type": "object", + "properties": { + "confidence": { + "description": "The classifier's confidence of the category. Number represents how certain\nthe classifier is that this category represents the given text.", + "format": "float", + "type": "number" + }, + "name": { + "description": "The name of the category representing the document.", + "type": "string" + } + }, + "id": "ClassificationCategory" + }, + "AnalyzeSyntaxRequest": { + "description": "The syntax analysis request message.", + "type": "object", + "properties": { + "encodingType": { + "enum": [ + "NONE", + "UTF8", + "UTF16", + "UTF32" + ], + "description": "The encoding type used by the API to calculate offsets.", + "type": "string", + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ] + }, + "document": { + "description": "Input document.", + "$ref": "Document" + } + }, + "id": "AnalyzeSyntaxRequest" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "canonicalName": "Cloud Natural Language", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, "https://www.googleapis.com/auth/cloud-language": { "description": "Apply machine learning models to reveal the structure and meaning of text" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" } } } @@ -1038,44 +1033,6 @@ "resources": { "documents": { "methods": { - "annotateText": { - "response": { - "$ref": "AnnotateTextResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {}, - "flatPath": "v1/documents:annotateText", - "path": "v1/documents:annotateText", - "id": "language.documents.annotateText", - "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.", - "request": { - "$ref": "AnnotateTextRequest" - } - }, - "classifyText": { - "id": "language.documents.classifyText", - "path": "v1/documents:classifyText", - "request": { - "$ref": "ClassifyTextRequest" - }, - "description": "Classifies a document into categories.", - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "ClassifyTextResponse" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/documents:classifyText" - }, "analyzeSentiment": { "httpMethod": "POST", "parameterOrder": [], @@ -1096,13 +1053,6 @@ "description": "Analyzes the sentiment of the provided text." }, "analyzeEntitySentiment": { - "flatPath": "v1/documents:analyzeEntitySentiment", - "path": "v1/documents:analyzeEntitySentiment", - "id": "language.documents.analyzeEntitySentiment", - "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.", - "request": { - "$ref": "AnalyzeEntitySentimentRequest" - }, "response": { "$ref": "AnalyzeEntitySentimentResponse" }, @@ -1112,13 +1062,16 @@ "https://www.googleapis.com/auth/cloud-language", "https://www.googleapis.com/auth/cloud-platform" ], - "parameters": {} + "parameters": {}, + "flatPath": "v1/documents:analyzeEntitySentiment", + "path": "v1/documents:analyzeEntitySentiment", + "id": "language.documents.analyzeEntitySentiment", + "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.", + "request": { + "$ref": "AnalyzeEntitySentimentRequest" + } }, "analyzeEntities": { - "request": { - "$ref": "AnalyzeEntitiesRequest" - }, - "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.", "httpMethod": "POST", "parameterOrder": [], "response": { @@ -1131,14 +1084,13 @@ ], "flatPath": "v1/documents:analyzeEntities", "id": "language.documents.analyzeEntities", - "path": "v1/documents:analyzeEntities" + "path": "v1/documents:analyzeEntities", + "request": { + "$ref": "AnalyzeEntitiesRequest" + }, + "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties." }, "analyzeSyntax": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "AnalyzeSyntaxResponse" - }, "scopes": [ "https://www.googleapis.com/auth/cloud-language", "https://www.googleapis.com/auth/cloud-platform" @@ -1150,26 +1102,80 @@ "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.", "request": { "$ref": "AnalyzeSyntaxRequest" + }, + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "AnalyzeSyntaxResponse" + } + }, + "annotateText": { + "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call.", + "request": { + "$ref": "AnnotateTextRequest" + }, + "response": { + "$ref": "AnnotateTextResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-language", + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v1/documents:annotateText", + "path": "v1/documents:annotateText", + "id": "language.documents.annotateText" + }, + "classifyText": { + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-language", + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/documents:classifyText", + "id": "language.documents.classifyText", + "path": "v1/documents:classifyText", + "request": { + "$ref": "ClassifyTextRequest" + }, + "description": "Classifies a document into categories.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "ClassifyTextResponse" } } } } }, "parameters": { - "uploadType": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "callback": { + "type": "string", "location": "query", - "description": "JSONP", - "type": "string" + "description": "JSONP" }, "$.xgafv": { "type": "string", @@ -1201,51 +1207,45 @@ "type": "string" }, "key": { - "type": "string", "location": "query", - "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." + "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.", + "type": "string" }, "access_token": { - "description": "OAuth access token.", "type": "string", - "location": "query" + "location": "query", + "description": "OAuth access token." }, "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.", "type": "string", - "location": "query" + "location": "query", + "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." }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "bearer_token": { + "description": "OAuth bearer token.", "type": "string", - "location": "query", - "description": "OAuth bearer token." + "location": "query" }, "oauth_token": { + "type": "string", "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" + "description": "OAuth 2.0 token for the current user." } }, "version": "v1", "baseUrl": "https://language.googleapis.com/", "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.", "kind": "discovery#restDescription", - "servicePath": "" + "servicePath": "", + "basePath": "", + "revision": "20171231", + "documentationLink": "https://cloud.google.com/natural-language/", + "id": "language:v1", + "discoveryVersion": "v1" }
diff --git a/language/v1beta1/language-api.json b/language/v1beta1/language-api.json index 1ffd8f8..55e1025 100644 --- a/language/v1beta1/language-api.json +++ b/language/v1beta1/language-api.json
@@ -1,9 +1,4 @@ { - "ownerDomain": "google.com", - "name": "language", - "batchPath": "batch", - "title": "Google Cloud Natural Language API", - "ownerName": "Google", "resources": { "documents": { "methods": { @@ -46,6 +41,10 @@ "description": "A convenience method that provides all the features that analyzeSentiment,\nanalyzeEntities, and analyzeSyntax provide in one call." }, "analyzeEntities": { + "request": { + "$ref": "AnalyzeEntitiesRequest" + }, + "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.", "response": { "$ref": "AnalyzeEntitiesResponse" }, @@ -58,13 +57,13 @@ ], "flatPath": "v1beta1/documents:analyzeEntities", "path": "v1beta1/documents:analyzeEntities", - "id": "language.documents.analyzeEntities", - "request": { - "$ref": "AnalyzeEntitiesRequest" - }, - "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties." + "id": "language.documents.analyzeEntities" }, "analyzeSyntax": { + "request": { + "$ref": "AnalyzeSyntaxRequest" + }, + "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.", "response": { "$ref": "AnalyzeSyntaxResponse" }, @@ -77,26 +76,59 @@ ], "flatPath": "v1beta1/documents:analyzeSyntax", "path": "v1beta1/documents:analyzeSyntax", - "id": "language.documents.analyzeSyntax", - "request": { - "$ref": "AnalyzeSyntaxRequest" - }, - "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties." + "id": "language.documents.analyzeSyntax" } } } }, "parameters": { - "bearer_token": { - "description": "OAuth bearer token.", + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", "type": "string", "location": "query" }, - "oauth_token": { + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { "location": "query", - "description": "OAuth 2.0 token for the current user.", + "description": "OAuth bearer token.", "type": "string" }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", @@ -109,14 +141,14 @@ "default": "true" }, "fields": { + "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" + "type": "string" }, "uploadType": { - "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "callback": { "location": "query", @@ -135,43 +167,6 @@ "v2 error format" ], "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "key": { - "location": "query", - "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.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" } }, "version": "v1beta1", @@ -186,6 +181,46 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { + "AnalyzeSentimentResponse": { + "properties": { + "documentSentiment": { + "$ref": "Sentiment", + "description": "The overall sentiment of the input document." + }, + "language": { + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", + "type": "string" + }, + "sentences": { + "description": "The sentiment for all the sentences in the document.", + "type": "array", + "items": { + "$ref": "Sentence" + } + } + }, + "id": "AnalyzeSentimentResponse", + "description": "The sentiment analysis response message.", + "type": "object" + }, + "AnalyzeEntitiesResponse": { + "properties": { + "entities": { + "description": "The recognized entities in the input document.", + "type": "array", + "items": { + "$ref": "Entity" + } + }, + "language": { + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", + "type": "string" + } + }, + "id": "AnalyzeEntitiesResponse", + "description": "The entity analysis response message.", + "type": "object" + }, "Entity": { "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.", "type": "object", @@ -202,16 +237,6 @@ "type": "string" }, "type": { - "enumDescriptions": [ - "Unknown", - "Person", - "Location", - "Organization", - "Event", - "Work of art", - "Consumer goods", - "Other types" - ], "enum": [ "UNKNOWN", "PERSON", @@ -223,7 +248,17 @@ "OTHER" ], "description": "The entity type.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown", + "Person", + "Location", + "Organization", + "Event", + "Work of art", + "Consumer goods", + "Other types" + ] }, "metadata": { "additionalProperties": { @@ -288,8 +323,8 @@ "description": "Input document." }, "features": { - "description": "The enabled features.", - "$ref": "Features" + "$ref": "Features", + "description": "The enabled features." } }, "id": "AnnotateTextRequest", @@ -297,14 +332,10 @@ "type": "object" }, "AnalyzeSentimentRequest": { + "description": "The sentiment analysis request message.", + "type": "object", "properties": { "encodingType": { - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ], "enum": [ "NONE", "UTF8", @@ -312,16 +343,20 @@ "UTF32" ], "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ] }, "document": { "description": "Input document.", "$ref": "Document" } }, - "id": "AnalyzeSentimentRequest", - "description": "The sentiment analysis request message.", - "type": "object" + "id": "AnalyzeSentimentRequest" }, "AnnotateTextResponse": { "description": "The text annotations response message.", @@ -335,8 +370,8 @@ } }, "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment." + "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.", + "$ref": "Sentiment" }, "language": { "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", @@ -360,8 +395,6 @@ "id": "AnnotateTextResponse" }, "DependencyEdge": { - "description": "Represents dependency parse tree information for a token.", - "type": "object", "properties": { "headTokenIndex": { "description": "Represents the head of this token in the dependency tree.\nThis is the index of the token which has an arc going to this token.\nThe index is the position of the token in the array of tokens returned\nby the API method. If this token is a root token, then the\n`head_token_index` is its own index.", @@ -543,7 +576,9 @@ ] } }, - "id": "DependencyEdge" + "id": "DependencyEdge", + "description": "Represents dependency parse tree information for a token.", + "type": "object" }, "TextSpan": { "description": "Represents an output piece of text.", @@ -570,8 +605,8 @@ "$ref": "PartOfSpeech" }, "text": { - "$ref": "TextSpan", - "description": "The token text." + "description": "The token text.", + "$ref": "TextSpan" }, "dependencyEdge": { "$ref": "DependencyEdge", @@ -588,6 +623,10 @@ "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.", "type": "object", "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 is a common set of\nmessage types for APIs to use.", "type": "array", @@ -603,10 +642,6 @@ "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" } }, "id": "Status" @@ -614,22 +649,22 @@ "EntityMention": { "properties": { "text": { - "$ref": "TextSpan", - "description": "The mention text." + "description": "The mention text.", + "$ref": "TextSpan" }, "type": { - "enumDescriptions": [ - "Unknown", - "Proper name", - "Common noun (or noun compound)" - ], "enum": [ "TYPE_UNKNOWN", "PROPER", "COMMON" ], "description": "The type of the entity mention.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown", + "Proper name", + "Common noun (or noun compound)" + ] } }, "id": "EntityMention", @@ -656,45 +691,45 @@ "type": "object" }, "Document": { + "description": "################################################################ #\n\nRepresents the input to API methods.", + "type": "object", "properties": { - "gcsContentUri": { - "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.", - "type": "string" - }, "language": { "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.", "type": "string" }, "type": { - "enumDescriptions": [ - "The content type is not specified.", - "Plain text", - "HTML" - ], "enum": [ "TYPE_UNSPECIFIED", "PLAIN_TEXT", "HTML" ], "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "The content type is not specified.", + "Plain text", + "HTML" + ] }, "content": { "description": "The content of the input in string format.", "type": "string" + }, + "gcsContentUri": { + "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.", + "type": "string" } }, - "id": "Document", - "description": "################################################################ #\n\nRepresents the input to API methods.", - "type": "object" + "id": "Document" }, "Sentence": { "description": "Represents a sentence in the input document.", "type": "object", "properties": { "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence." + "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.", + "$ref": "Sentiment" }, "text": { "description": "The sentence text.", @@ -704,8 +739,6 @@ "id": "Sentence" }, "Sentiment": { - "description": "Represents the feeling associated with the entire text or entities in\nthe text.", - "type": "object", "properties": { "magnitude": { "description": "A non-negative number in the [0, +inf) range, which represents\nthe absolute magnitude of sentiment regardless of score (positive or\nnegative).", @@ -723,11 +756,11 @@ "type": "number" } }, - "id": "Sentiment" + "id": "Sentiment", + "description": "Represents the feeling associated with the entire text or entities in\nthe text.", + "type": "object" }, "AnalyzeEntitiesRequest": { - "description": "The entity analysis request message.", - "type": "object", "properties": { "encodingType": { "enum": [ @@ -746,32 +779,49 @@ ] }, "document": { - "description": "Input document.", - "$ref": "Document" + "$ref": "Document", + "description": "Input document." } }, - "id": "AnalyzeEntitiesRequest" + "id": "AnalyzeEntitiesRequest", + "description": "The entity analysis request message.", + "type": "object" }, "PartOfSpeech": { "properties": { - "case": { - "enumDescriptions": [ - "Case is not applicable in the analyzed language or is not predicted.", - "Accusative", - "Adverbial", - "Complementive", - "Dative", - "Genitive", - "Instrumental", - "Locative", - "Nominative", - "Oblique", - "Partitive", - "Prepositional", - "Reflexive", - "Relative", - "Vocative" + "person": { + "enum": [ + "PERSON_UNKNOWN", + "FIRST", + "SECOND", + "THIRD", + "REFLEXIVE_PERSON" ], + "description": "The grammatical person.", + "type": "string", + "enumDescriptions": [ + "Person is not applicable in the analyzed language or is not predicted.", + "First", + "Second", + "Third", + "Reflexive" + ] + }, + "proper": { + "enum": [ + "PROPER_UNKNOWN", + "PROPER", + "NOT_PROPER" + ], + "description": "The grammatical properness.", + "type": "string", + "enumDescriptions": [ + "Proper is not applicable in the analyzed language or is not predicted.", + "Proper", + "Not proper" + ] + }, + "case": { "enum": [ "CASE_UNKNOWN", "ACCUSATIVE", @@ -790,18 +840,26 @@ "VOCATIVE" ], "description": "The grammatical case.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Case is not applicable in the analyzed language or is not predicted.", + "Accusative", + "Adverbial", + "Complementive", + "Dative", + "Genitive", + "Instrumental", + "Locative", + "Nominative", + "Oblique", + "Partitive", + "Prepositional", + "Reflexive", + "Relative", + "Vocative" + ] }, "tense": { - "enumDescriptions": [ - "Tense is not applicable in the analyzed language or is not predicted.", - "Conditional", - "Future", - "Past", - "Present", - "Imperfect", - "Pluperfect" - ], "enum": [ "TENSE_UNKNOWN", "CONDITIONAL_TENSE", @@ -812,21 +870,30 @@ "PLUPERFECT" ], "description": "The grammatical tense.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Tense is not applicable in the analyzed language or is not predicted.", + "Conditional", + "Future", + "Past", + "Present", + "Imperfect", + "Pluperfect" + ] }, "reciprocity": { + "enumDescriptions": [ + "Reciprocity is not applicable in the analyzed language or is not\npredicted.", + "Reciprocal", + "Non-reciprocal" + ], "enum": [ "RECIPROCITY_UNKNOWN", "RECIPROCAL", "NON_RECIPROCAL" ], "description": "The grammatical reciprocity.", - "type": "string", - "enumDescriptions": [ - "Reciprocity is not applicable in the analyzed language or is not\npredicted.", - "Reciprocal", - "Non-reciprocal" - ] + "type": "string" }, "form": { "enumDescriptions": [ @@ -861,12 +928,6 @@ "type": "string" }, "number": { - "enumDescriptions": [ - "Number is not applicable in the analyzed language or is not predicted.", - "Singular", - "Plural", - "Dual" - ], "enum": [ "NUMBER_UNKNOWN", "SINGULAR", @@ -874,9 +935,21 @@ "DUAL" ], "description": "The grammatical number.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Number is not applicable in the analyzed language or is not predicted.", + "Singular", + "Plural", + "Dual" + ] }, "voice": { + "enumDescriptions": [ + "Voice is not applicable in the analyzed language or is not predicted.", + "Active", + "Causative", + "Passive" + ], "enum": [ "VOICE_UNKNOWN", "ACTIVE", @@ -884,13 +957,7 @@ "PASSIVE" ], "description": "The grammatical voice.", - "type": "string", - "enumDescriptions": [ - "Voice is not applicable in the analyzed language or is not predicted.", - "Active", - "Causative", - "Passive" - ] + "type": "string" }, "aspect": { "enumDescriptions": [ @@ -931,22 +998,6 @@ "type": "string" }, "tag": { - "enumDescriptions": [ - "Unknown", - "Adjective", - "Adposition (preposition and postposition)", - "Adverb", - "Conjunction", - "Determiner", - "Noun (common and proper)", - "Cardinal number", - "Pronoun", - "Particle or other function word", - "Punctuation", - "Verb (all tenses and modes)", - "Other: foreign words, typos, abbreviations", - "Affix" - ], "enum": [ "UNKNOWN", "ADJ", @@ -964,7 +1015,23 @@ "AFFIX" ], "description": "The part of speech tag.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown", + "Adjective", + "Adposition (preposition and postposition)", + "Adverb", + "Conjunction", + "Determiner", + "Noun (common and proper)", + "Cardinal number", + "Pronoun", + "Particle or other function word", + "Punctuation", + "Verb (all tenses and modes)", + "Other: foreign words, typos, abbreviations", + "Affix" + ] }, "gender": { "enumDescriptions": [ @@ -981,38 +1048,6 @@ ], "description": "The grammatical gender.", "type": "string" - }, - "person": { - "enumDescriptions": [ - "Person is not applicable in the analyzed language or is not predicted.", - "First", - "Second", - "Third", - "Reflexive" - ], - "enum": [ - "PERSON_UNKNOWN", - "FIRST", - "SECOND", - "THIRD", - "REFLEXIVE_PERSON" - ], - "description": "The grammatical person.", - "type": "string" - }, - "proper": { - "enum": [ - "PROPER_UNKNOWN", - "PROPER", - "NOT_PROPER" - ], - "description": "The grammatical properness.", - "type": "string", - "enumDescriptions": [ - "Proper is not applicable in the analyzed language or is not predicted.", - "Proper", - "Not proper" - ] } }, "id": "PartOfSpeech", @@ -1020,8 +1055,16 @@ "type": "object" }, "AnalyzeSyntaxRequest": { + "description": "The syntax analysis request message.", + "type": "object", "properties": { "encodingType": { + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ], "enum": [ "NONE", "UTF8", @@ -1029,81 +1072,38 @@ "UTF32" ], "description": "The encoding type used by the API to calculate offsets.", - "type": "string", - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ] + "type": "string" }, "document": { "description": "Input document.", "$ref": "Document" } }, - "id": "AnalyzeSyntaxRequest", - "description": "The syntax analysis request message.", - "type": "object" - }, - "AnalyzeSentimentResponse": { - "description": "The sentiment analysis response message.", - "type": "object", - "properties": { - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "The sentiment for all the sentences in the document.", - "type": "array", - "items": { - "$ref": "Sentence" - } - }, - "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment of the input document." - } - }, - "id": "AnalyzeSentimentResponse" - }, - "AnalyzeEntitiesResponse": { - "description": "The entity analysis response message.", - "type": "object", - "properties": { - "entities": { - "description": "The recognized entities in the input document.", - "type": "array", - "items": { - "$ref": "Entity" - } - }, - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" - } - }, - "id": "AnalyzeEntitiesResponse" + "id": "AnalyzeSyntaxRequest" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "canonicalName": "Cloud Natural Language", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-language": { - "description": "Apply machine learning models to reveal the structure and meaning of text" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-language": { + "description": "Apply machine learning models to reveal the structure and meaning of text" } } } }, - "rootUrl": "https://language.googleapis.com/" + "rootUrl": "https://language.googleapis.com/", + "ownerDomain": "google.com", + "name": "language", + "batchPath": "batch", + "title": "Google Cloud Natural Language API", + "ownerName": "Google" }
diff --git a/language/v1beta2/language-api.json b/language/v1beta2/language-api.json index dfc6069..dcf254e 100644 --- a/language/v1beta2/language-api.json +++ b/language/v1beta2/language-api.json
@@ -1,216 +1,12 @@ { - "basePath": "", "id": "language:v1beta2", "documentationLink": "https://cloud.google.com/natural-language/", "revision": "20171231", "discoveryVersion": "v1", "version_module": true, "schemas": { - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "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" - } - }, - "id": "Status" - }, - "Features": { - "properties": { - "extractSyntax": { - "description": "Extract syntax information.", - "type": "boolean" - }, - "extractDocumentSentiment": { - "description": "Extract document-level sentiment.", - "type": "boolean" - }, - "extractEntitySentiment": { - "description": "Extract entities and their associated sentiment.", - "type": "boolean" - }, - "extractEntities": { - "description": "Extract entities.", - "type": "boolean" - }, - "classifyText": { - "description": "Classify the full document into categories. If this is true,\nthe API will use the default model which classifies into a\n[predefined taxonomy](/natural-language/docs/categories).", - "type": "boolean" - } - }, - "id": "Features", - "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.", - "type": "object" - }, - "Document": { - "description": "################################################################ #\n\nRepresents the input to API methods.", - "type": "object", - "properties": { - "language": { - "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.", - "type": "string" - }, - "type": { - "enumDescriptions": [ - "The content type is not specified.", - "Plain text", - "HTML" - ], - "enum": [ - "TYPE_UNSPECIFIED", - "PLAIN_TEXT", - "HTML" - ], - "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", - "type": "string" - }, - "content": { - "description": "The content of the input in string format.", - "type": "string" - }, - "gcsContentUri": { - "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported.", - "type": "string" - } - }, - "id": "Document" - }, - "AnalyzeEntitiesRequest": { - "description": "The entity analysis request message.", - "type": "object", - "properties": { - "encodingType": { - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "description": "The encoding type used by the API to calculate offsets.", - "type": "string", - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ] - }, - "document": { - "description": "Input document.", - "$ref": "Document" - } - }, - "id": "AnalyzeEntitiesRequest" - }, - "ClassifyTextRequest": { - "properties": { - "document": { - "$ref": "Document", - "description": "Input document." - } - }, - "id": "ClassifyTextRequest", - "description": "The document classification request message.", - "type": "object" - }, - "AnalyzeEntitySentimentResponse": { - "properties": { - "entities": { - "description": "The recognized entities in the input document with associated sentiments.", - "type": "array", - "items": { - "$ref": "Entity" - } - }, - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" - } - }, - "id": "AnalyzeEntitySentimentResponse", - "description": "The entity-level sentiment analysis response message.", - "type": "object" - }, - "AnalyzeSentimentResponse": { - "properties": { - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "The sentiment for all the sentences in the document.", - "type": "array", - "items": { - "$ref": "Sentence" - } - }, - "documentSentiment": { - "description": "The overall sentiment of the input document.", - "$ref": "Sentiment" - } - }, - "id": "AnalyzeSentimentResponse", - "description": "The sentiment analysis response message.", - "type": "object" - }, - "AnalyzeSyntaxResponse": { - "description": "The syntax analysis response message.", - "type": "object", - "properties": { - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" - }, - "sentences": { - "description": "Sentences in the input document.", - "type": "array", - "items": { - "$ref": "Sentence" - } - }, - "tokens": { - "description": "Tokens, along with their syntactic information, in the input document.", - "type": "array", - "items": { - "$ref": "Token" - } - } - }, - "id": "AnalyzeSyntaxResponse" - }, "AnnotateTextResponse": { - "description": "The text annotations response message.", - "type": "object", "properties": { - "language": { - "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", - "type": "string" - }, - "entities": { - "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.", - "type": "array", - "items": { - "$ref": "Entity" - } - }, "sentences": { "description": "Sentences in the input document. Populated if the user enables\nAnnotateTextRequest.Features.extract_syntax.", "type": "array", @@ -226,8 +22,8 @@ } }, "documentSentiment": { - "$ref": "Sentiment", - "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment." + "description": "The overall sentiment for the document. Populated if the user enables\nAnnotateTextRequest.Features.extract_document_sentiment.", + "$ref": "Sentiment" }, "categories": { "description": "Categories identified in the input document.", @@ -235,9 +31,22 @@ "items": { "$ref": "ClassificationCategory" } + }, + "language": { + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", + "type": "string" + }, + "entities": { + "description": "Entities, along with their semantic information, in the input document.\nPopulated if the user enables\nAnnotateTextRequest.Features.extract_entities.", + "type": "array", + "items": { + "$ref": "Entity" + } } }, - "id": "AnnotateTextResponse" + "id": "AnnotateTextResponse", + "description": "The text annotations response message.", + "type": "object" }, "DependencyEdge": { "description": "Represents dependency parse tree information for a token.", @@ -426,68 +235,68 @@ "id": "DependencyEdge" }, "TextSpan": { + "description": "Represents an output piece of text.", + "type": "object", "properties": { "beginOffset": { + "type": "integer", "description": "The API calculates the beginning offset of the content in the original\ndocument according to the EncodingType specified in the API request.", - "format": "int32", - "type": "integer" + "format": "int32" }, "content": { "description": "The content of the output text.", "type": "string" } }, - "id": "TextSpan", - "description": "Represents an output piece of text.", - "type": "object" + "id": "TextSpan" }, "Token": { + "description": "Represents the smallest syntactic building block of the text.", + "type": "object", "properties": { "partOfSpeech": { - "$ref": "PartOfSpeech", - "description": "Parts of speech tag for this token." + "description": "Parts of speech tag for this token.", + "$ref": "PartOfSpeech" }, "text": { - "$ref": "TextSpan", - "description": "The token text." + "description": "The token text.", + "$ref": "TextSpan" }, "dependencyEdge": { - "$ref": "DependencyEdge", - "description": "Dependency tree parse for this token." + "description": "Dependency tree parse for this token.", + "$ref": "DependencyEdge" }, "lemma": { "description": "[Lemma](https://en.wikipedia.org/wiki/Lemma_%28morphology%29) of the token.", "type": "string" } }, - "id": "Token", - "description": "Represents the smallest syntactic building block of the text.", - "type": "object" + "id": "Token" }, "EntityMention": { "description": "Represents a mention for an entity in the text. Currently, proper noun\nmentions are supported.", "type": "object", "properties": { "sentiment": { - "$ref": "Sentiment", - "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document." + "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the sentiment expressed for this mention of\nthe entity in the provided document.", + "$ref": "Sentiment" }, "text": { "$ref": "TextSpan", "description": "The mention text." }, "type": { - "enum": [ - "TYPE_UNKNOWN", - "PROPER", - "COMMON" - ], "description": "The type of the entity mention.", "type": "string", "enumDescriptions": [ "Unknown", "Proper name", "Common noun (or noun compound)" + ], + "enum": [ + "TYPE_UNKNOWN", + "PROPER", + "COMMON" ] } }, @@ -512,17 +321,19 @@ "type": "object", "properties": { "text": { - "description": "The sentence text.", - "$ref": "TextSpan" + "$ref": "TextSpan", + "description": "The sentence text." }, "sentiment": { - "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence.", - "$ref": "Sentiment" + "$ref": "Sentiment", + "description": "For calls to AnalyzeSentiment or if\nAnnotateTextRequest.Features.extract_document_sentiment is set to\ntrue, this field will contain the sentiment for the sentence." } }, "id": "Sentence" }, "Sentiment": { + "description": "Represents the feeling associated with the entire text or entities in\nthe text.", + "type": "object", "properties": { "score": { "description": "Sentiment score between -1.0 (negative sentiment) and 1.0\n(positive sentiment).", @@ -535,19 +346,11 @@ "type": "number" } }, - "id": "Sentiment", - "description": "Represents the feeling associated with the entire text or entities in\nthe text.", - "type": "object" + "id": "Sentiment" }, "AnalyzeEntitySentimentRequest": { "properties": { "encodingType": { - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], "description": "The encoding type used by the API to calculate offsets.", "type": "string", "enumDescriptions": [ @@ -555,6 +358,12 @@ "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ], + "enum": [ + "NONE", + "UTF8", + "UTF16", + "UTF32" ] }, "document": { @@ -571,6 +380,8 @@ "type": "object", "properties": { "form": { + "description": "The grammatical form.", + "type": "string", "enumDescriptions": [ "Form is not applicable in the analyzed language or is not predicted.", "Adnomial", @@ -598,11 +409,11 @@ "LONG", "ORDER", "SPECIFIC" - ], - "description": "The grammatical form.", - "type": "string" + ] }, "number": { + "description": "The grammatical number.", + "type": "string", "enumDescriptions": [ "Number is not applicable in the analyzed language or is not predicted.", "Singular", @@ -614,9 +425,7 @@ "SINGULAR", "PLURAL", "DUAL" - ], - "description": "The grammatical number.", - "type": "string" + ] }, "voice": { "enum": [ @@ -635,6 +444,12 @@ ] }, "aspect": { + "enumDescriptions": [ + "Aspect is not applicable in the analyzed language or is not predicted.", + "Perfective", + "Imperfective", + "Progressive" + ], "enum": [ "ASPECT_UNKNOWN", "PERFECTIVE", @@ -642,24 +457,9 @@ "PROGRESSIVE" ], "description": "The grammatical aspect.", - "type": "string", - "enumDescriptions": [ - "Aspect is not applicable in the analyzed language or is not predicted.", - "Perfective", - "Imperfective", - "Progressive" - ] + "type": "string" }, "mood": { - "enum": [ - "MOOD_UNKNOWN", - "CONDITIONAL_MOOD", - "IMPERATIVE", - "INDICATIVE", - "INTERROGATIVE", - "JUSSIVE", - "SUBJUNCTIVE" - ], "description": "The grammatical mood.", "type": "string", "enumDescriptions": [ @@ -670,9 +470,20 @@ "Interrogative", "Jussive", "Subjunctive" + ], + "enum": [ + "MOOD_UNKNOWN", + "CONDITIONAL_MOOD", + "IMPERATIVE", + "INDICATIVE", + "INTERROGATIVE", + "JUSSIVE", + "SUBJUNCTIVE" ] }, "tag": { + "description": "The part of speech tag.", + "type": "string", "enumDescriptions": [ "Unknown", "Adjective", @@ -704,9 +515,7 @@ "VERB", "X", "AFFIX" - ], - "description": "The part of speech tag.", - "type": "string" + ] }, "gender": { "enumDescriptions": [ @@ -725,6 +534,8 @@ "type": "string" }, "person": { + "description": "The grammatical person.", + "type": "string", "enumDescriptions": [ "Person is not applicable in the analyzed language or is not predicted.", "First", @@ -738,23 +549,21 @@ "SECOND", "THIRD", "REFLEXIVE_PERSON" - ], - "description": "The grammatical person.", - "type": "string" + ] }, "proper": { - "enum": [ - "PROPER_UNKNOWN", - "PROPER", - "NOT_PROPER" - ], - "description": "The grammatical properness.", "type": "string", "enumDescriptions": [ "Proper is not applicable in the analyzed language or is not predicted.", "Proper", "Not proper" - ] + ], + "enum": [ + "PROPER_UNKNOWN", + "PROPER", + "NOT_PROPER" + ], + "description": "The grammatical properness." }, "case": { "enumDescriptions": [ @@ -795,6 +604,8 @@ "type": "string" }, "tense": { + "description": "The grammatical tense.", + "type": "string", "enumDescriptions": [ "Tense is not applicable in the analyzed language or is not predicted.", "Conditional", @@ -812,28 +623,28 @@ "PRESENT", "IMPERFECT", "PLUPERFECT" - ], - "description": "The grammatical tense.", - "type": "string" + ] }, "reciprocity": { - "enum": [ - "RECIPROCITY_UNKNOWN", - "RECIPROCAL", - "NON_RECIPROCAL" - ], "description": "The grammatical reciprocity.", "type": "string", "enumDescriptions": [ "Reciprocity is not applicable in the analyzed language or is not\npredicted.", "Reciprocal", "Non-reciprocal" + ], + "enum": [ + "RECIPROCITY_UNKNOWN", + "RECIPROCAL", + "NON_RECIPROCAL" ] } }, "id": "PartOfSpeech" }, "ClassificationCategory": { + "description": "Represents a category returned from the text classifier.", + "type": "object", "properties": { "confidence": { "description": "The classifier's confidence of the category. Number represents how certain\nthe classifier is that this category represents the given text.", @@ -845,9 +656,7 @@ "type": "string" } }, - "id": "ClassificationCategory", - "description": "Represents a category returned from the text classifier.", - "type": "object" + "id": "ClassificationCategory" }, "AnalyzeSyntaxRequest": { "properties": { @@ -868,8 +677,8 @@ ] }, "document": { - "$ref": "Document", - "description": "Input document." + "description": "Input document.", + "$ref": "Document" } }, "id": "AnalyzeSyntaxRequest", @@ -895,7 +704,16 @@ "type": "object" }, "Entity": { + "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.", + "type": "object", "properties": { + "mentions": { + "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.", + "type": "array", + "items": { + "$ref": "EntityMention" + } + }, "name": { "description": "The representative name for the entity.", "type": "string" @@ -937,23 +755,159 @@ "type": "number" }, "sentiment": { - "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document.", - "$ref": "Sentiment" + "$ref": "Sentiment", + "description": "For calls to AnalyzeEntitySentiment or if\nAnnotateTextRequest.Features.extract_entity_sentiment is set to\ntrue, this field will contain the aggregate sentiment expressed for this\nentity in the provided document." + } + }, + "id": "Entity" + }, + "AnnotateTextRequest": { + "type": "object", + "properties": { + "encodingType": { + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ], + "enum": [ + "NONE", + "UTF8", + "UTF16", + "UTF32" + ], + "description": "The encoding type used by the API to calculate offsets.", + "type": "string" }, - "mentions": { - "description": "The mentions of this entity in the input document. The API currently\nsupports proper noun mentions.", + "document": { + "$ref": "Document", + "description": "Input document." + }, + "features": { + "description": "The enabled features.", + "$ref": "Features" + } + }, + "id": "AnnotateTextRequest", + "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call." + }, + "AnalyzeSentimentRequest": { + "description": "The sentiment analysis request message.", + "type": "object", + "properties": { + "document": { + "description": "Input document.", + "$ref": "Document" + }, + "encodingType": { + "enumDescriptions": [ + "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", + "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." + ], + "enum": [ + "NONE", + "UTF8", + "UTF16", + "UTF32" + ], + "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.", + "type": "string" + } + }, + "id": "AnalyzeSentimentRequest" + }, + "Status": { + "type": "object", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, + "message": { + "type": "string", + "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." + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "$ref": "EntityMention" + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } } } }, - "id": "Entity", - "description": "Represents a phrase in the text that is a known entity, such as\na person, an organization, or location. The API associates information, such\nas salience and mentions, with entities.", + "id": "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." + }, + "Features": { + "properties": { + "extractSyntax": { + "description": "Extract syntax information.", + "type": "boolean" + }, + "extractDocumentSentiment": { + "description": "Extract document-level sentiment.", + "type": "boolean" + }, + "extractEntitySentiment": { + "description": "Extract entities and their associated sentiment.", + "type": "boolean" + }, + "extractEntities": { + "description": "Extract entities.", + "type": "boolean" + }, + "classifyText": { + "description": "Classify the full document into categories. If this is true,\nthe API will use the default model which classifies into a\n[predefined taxonomy](/natural-language/docs/categories).", + "type": "boolean" + } + }, + "id": "Features", + "description": "All available features for sentiment, syntax, and semantic analysis.\nSetting each one to true will enable that specific analysis for the input.", "type": "object" }, - "AnnotateTextRequest": { - "description": "The request message for the text annotation API, which can perform multiple\nanalysis types (sentiment, entities, and syntax) in one call.", + "Document": { + "description": "################################################################ #\n\nRepresents the input to API methods.", + "type": "object", + "properties": { + "language": { + "description": "The language of the document (if not specified, the language is\nautomatically detected). Both ISO and BCP-47 language codes are\naccepted.\u003cbr\u003e\n[Language Support](/natural-language/docs/languages)\nlists currently supported languages for each API method.\nIf the language (either specified by the caller or automatically detected)\nis not supported by the called API method, an `INVALID_ARGUMENT` error\nis returned.", + "type": "string" + }, + "type": { + "enumDescriptions": [ + "The content type is not specified.", + "Plain text", + "HTML" + ], + "enum": [ + "TYPE_UNSPECIFIED", + "PLAIN_TEXT", + "HTML" + ], + "description": "Required. If the type is not set or is `TYPE_UNSPECIFIED`,\nreturns an `INVALID_ARGUMENT` error.", + "type": "string" + }, + "content": { + "description": "The content of the input in string format.", + "type": "string" + }, + "gcsContentUri": { + "type": "string", + "description": "The Google Cloud Storage URI where the file content is located.\nThis URI must be of the form: gs://bucket_name/object_name. For more\ndetails, see https://cloud.google.com/storage/docs/reference-uris.\nNOTE: Cloud Storage object versioning is not supported." + } + }, + "id": "Document" + }, + "AnalyzeEntitiesRequest": { + "description": "The entity analysis request message.", "type": "object", "properties": { "encodingType": { @@ -975,40 +929,85 @@ "document": { "$ref": "Document", "description": "Input document." - }, - "features": { - "description": "The enabled features.", - "$ref": "Features" } }, - "id": "AnnotateTextRequest" + "id": "AnalyzeEntitiesRequest" }, - "AnalyzeSentimentRequest": { - "description": "The sentiment analysis request message.", + "ClassifyTextRequest": { + "description": "The document classification request message.", "type": "object", "properties": { - "encodingType": { - "enum": [ - "NONE", - "UTF8", - "UTF16", - "UTF32" - ], - "description": "The encoding type used by the API to calculate sentence offsets for the\nsentence sentiment.", - "type": "string", - "enumDescriptions": [ - "If `EncodingType` is not specified, encoding-dependent information (such as\n`begin_offset`) will be set at `-1`.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-8 encoding of the input. C++ and Go are examples of languages\nthat use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-16 encoding of the input. Java and Javascript are examples of\nlanguages that use this encoding natively.", - "Encoding-dependent information (such as `begin_offset`) is calculated based\non the UTF-32 encoding of the input. Python is an example of a language\nthat uses this encoding natively." - ] - }, "document": { "$ref": "Document", "description": "Input document." } }, - "id": "AnalyzeSentimentRequest" + "id": "ClassifyTextRequest" + }, + "AnalyzeEntitySentimentResponse": { + "properties": { + "entities": { + "description": "The recognized entities in the input document with associated sentiments.", + "type": "array", + "items": { + "$ref": "Entity" + } + }, + "language": { + "type": "string", + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details." + } + }, + "id": "AnalyzeEntitySentimentResponse", + "description": "The entity-level sentiment analysis response message.", + "type": "object" + }, + "AnalyzeSentimentResponse": { + "id": "AnalyzeSentimentResponse", + "description": "The sentiment analysis response message.", + "type": "object", + "properties": { + "documentSentiment": { + "description": "The overall sentiment of the input document.", + "$ref": "Sentiment" + }, + "language": { + "type": "string", + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details." + }, + "sentences": { + "description": "The sentiment for all the sentences in the document.", + "type": "array", + "items": { + "$ref": "Sentence" + } + } + } + }, + "AnalyzeSyntaxResponse": { + "properties": { + "language": { + "description": "The language of the text, which will be the same as the language specified\nin the request or, if not specified, the automatically-detected language.\nSee Document.language field for more details.", + "type": "string" + }, + "sentences": { + "description": "Sentences in the input document.", + "type": "array", + "items": { + "$ref": "Sentence" + } + }, + "tokens": { + "type": "array", + "items": { + "$ref": "Token" + }, + "description": "Tokens, along with their syntactic information, in the input document." + } + }, + "id": "AnalyzeSyntaxResponse", + "description": "The syntax analysis response message.", + "type": "object" } }, "icons": { @@ -1020,11 +1019,11 @@ "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-language": { - "description": "Apply machine learning models to reveal the structure and meaning of text" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-language": { + "description": "Apply machine learning models to reveal the structure and meaning of text" } } } @@ -1038,30 +1037,7 @@ "resources": { "documents": { "methods": { - "analyzeSentiment": { - "response": { - "$ref": "AnalyzeSentimentResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-language", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": {}, - "flatPath": "v1beta2/documents:analyzeSentiment", - "path": "v1beta2/documents:analyzeSentiment", - "id": "language.documents.analyzeSentiment", - "description": "Analyzes the sentiment of the provided text.", - "request": { - "$ref": "AnalyzeSentimentRequest" - } - }, "analyzeEntitySentiment": { - "request": { - "$ref": "AnalyzeEntitySentimentRequest" - }, - "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions.", "response": { "$ref": "AnalyzeEntitySentimentResponse" }, @@ -1074,9 +1050,20 @@ ], "flatPath": "v1beta2/documents:analyzeEntitySentiment", "path": "v1beta2/documents:analyzeEntitySentiment", - "id": "language.documents.analyzeEntitySentiment" + "id": "language.documents.analyzeEntitySentiment", + "request": { + "$ref": "AnalyzeEntitySentimentRequest" + }, + "description": "Finds entities, similar to AnalyzeEntities in the text and analyzes\nsentiment associated with each entity and its mentions." }, "analyzeEntities": { + "flatPath": "v1beta2/documents:analyzeEntities", + "path": "v1beta2/documents:analyzeEntities", + "id": "language.documents.analyzeEntities", + "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.", + "request": { + "$ref": "AnalyzeEntitiesRequest" + }, "response": { "$ref": "AnalyzeEntitiesResponse" }, @@ -1086,16 +1073,13 @@ "https://www.googleapis.com/auth/cloud-language", "https://www.googleapis.com/auth/cloud-platform" ], - "parameters": {}, - "flatPath": "v1beta2/documents:analyzeEntities", - "path": "v1beta2/documents:analyzeEntities", - "id": "language.documents.analyzeEntities", - "description": "Finds named entities (currently proper names and common nouns) in the text\nalong with entity types, salience, mentions for each entity, and\nother properties.", - "request": { - "$ref": "AnalyzeEntitiesRequest" - } + "parameters": {} }, "analyzeSyntax": { + "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.", + "request": { + "$ref": "AnalyzeSyntaxRequest" + }, "response": { "$ref": "AnalyzeSyntaxResponse" }, @@ -1108,11 +1092,7 @@ "parameters": {}, "flatPath": "v1beta2/documents:analyzeSyntax", "path": "v1beta2/documents:analyzeSyntax", - "id": "language.documents.analyzeSyntax", - "description": "Analyzes the syntax of the text and provides sentence boundaries and\ntokenization along with part of speech tags, dependency trees, and other\nproperties.", - "request": { - "$ref": "AnalyzeSyntaxRequest" - } + "id": "language.documents.analyzeSyntax" }, "annotateText": { "request": { @@ -1151,57 +1131,70 @@ "$ref": "ClassifyTextRequest" }, "description": "Classifies a document into categories." + }, + "analyzeSentiment": { + "flatPath": "v1beta2/documents:analyzeSentiment", + "path": "v1beta2/documents:analyzeSentiment", + "id": "language.documents.analyzeSentiment", + "description": "Analyzes the sentiment of the provided text.", + "request": { + "$ref": "AnalyzeSentimentRequest" + }, + "response": { + "$ref": "AnalyzeSentimentResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-language", + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {} } } } }, "parameters": { "upload_protocol": { - "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "prettyPrint": { - "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" }, "uploadType": { - "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "fields": { + "type": "string", "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "description": "Selector specifying which fields to include in a partial response." }, "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" + "type": "string" }, "callback": { + "location": "query", "description": "JSONP", - "type": "string", - "location": "query" + "type": "string" }, "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -1209,12 +1202,18 @@ ], "location": "query", "description": "Data format for response.", - "default": "json" + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" }, "access_token": { - "location": "query", "description": "OAuth access token.", - "type": "string" + "type": "string", + "location": "query" }, "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.", @@ -1222,20 +1221,20 @@ "location": "query" }, "quotaUser": { + "location": "query", "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.", - "type": "string", - "location": "query" + "type": "string" }, "pp": { - "description": "Pretty-print response.", "type": "boolean", "default": "true", - "location": "query" + "location": "query", + "description": "Pretty-print response." }, "oauth_token": { - "location": "query", "description": "OAuth 2.0 token for the current user.", - "type": "string" + "type": "string", + "location": "query" }, "bearer_token": { "location": "query", @@ -1247,5 +1246,6 @@ "baseUrl": "https://language.googleapis.com/", "servicePath": "", "kind": "discovery#restDescription", - "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations." + "description": "Provides natural language understanding technologies to developers. Examples include sentiment analysis, entity recognition, entity sentiment analysis, and text annotations.", + "basePath": "" }
diff --git a/logging/v2/logging-api.json b/logging/v2/logging-api.json index a13b507..25a2418 100644 --- a/logging/v2/logging-api.json +++ b/logging/v2/logging-api.json
@@ -1,69 +1,24 @@ { + "revision": "20171229", + "documentationLink": "https://cloud.google.com/logging/docs/", + "id": "logging:v2", "discoveryVersion": "v1", "version_module": true, "schemas": { - "LabelDescriptor": { - "description": "A description of a label.", - "type": "object", - "properties": { - "key": { - "description": "The label key.", - "type": "string" - }, - "description": { - "description": "A human-readable description for the label.", - "type": "string" - }, - "valueType": { - "enumDescriptions": [ - "A variable-length string. This is the default.", - "Boolean; true or false.", - "A 64-bit signed integer." - ], - "enum": [ - "STRING", - "BOOL", - "INT64" - ], - "description": "The type of data that can be assigned to the label.", - "type": "string" - } - }, - "id": "LabelDescriptor" - }, - "BucketOptions": { - "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", - "type": "object", - "properties": { - "exponentialBuckets": { - "description": "The exponential buckets.", - "$ref": "Exponential" - }, - "linearBuckets": { - "$ref": "Linear", - "description": "The linear bucket." - }, - "explicitBuckets": { - "description": "The explicit buckets.", - "$ref": "Explicit" - } - }, - "id": "BucketOptions" - }, "ListLogMetricsResponse": { "description": "Result returned from ListLogMetrics.", "type": "object", "properties": { - "nextPageToken": { - "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", - "type": "string" - }, "metrics": { "description": "A list of logs-based metrics.", "type": "array", "items": { "$ref": "LogMetric" } + }, + "nextPageToken": { + "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", + "type": "string" } }, "id": "ListLogMetricsResponse" @@ -72,14 +27,6 @@ "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.", "type": "object", "properties": { - "displayName": { - "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.", - "type": "string" - }, - "description": { - "description": "A detailed description of the metric, which can be used in documentation.", - "type": "string" - }, "unit": { "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.", "type": "string" @@ -136,25 +83,31 @@ ], "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.", "type": "string" + }, + "description": { + "description": "A detailed description of the metric, which can be used in documentation.", + "type": "string" + }, + "displayName": { + "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.", + "type": "string" } }, "id": "MetricDescriptor" }, "LogEntry": { - "description": "An individual entry in a log.", - "type": "object", "properties": { "logName": { "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.", "type": "string" }, "httpRequest": { - "description": "Optional. Information about the HTTP request associated with this log entry, if applicable.", - "$ref": "HttpRequest" + "$ref": "HttpRequest", + "description": "Optional. Information about the HTTP request associated with this log entry, if applicable." }, "resource": { - "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.", - "$ref": "MonitoredResource" + "$ref": "MonitoredResource", + "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error." }, "jsonPayload": { "additionalProperties": { @@ -164,14 +117,14 @@ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", "type": "object" }, + "operation": { + "$ref": "LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if applicable." + }, "insertId": { "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value.", "type": "string" }, - "operation": { - "description": "Optional. Information about an operation associated with the log entry, if applicable.", - "$ref": "LogEntryOperation" - }, "textPayload": { "description": "The log entry payload, represented as a Unicode string (UTF-8).", "type": "string" @@ -240,77 +193,14 @@ "type": "string" } }, - "id": "LogEntry" + "id": "LogEntry", + "description": "An individual entry in a log.", + "type": "object" }, "RequestLog": { "description": "Complete log information about a single HTTP request to an App Engine application.", "type": "object", "properties": { - "wasLoadingRequest": { - "description": "Whether this was a loading request for the instance.", - "type": "boolean" - }, - "sourceReference": { - "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.", - "type": "array", - "items": { - "$ref": "SourceReference" - } - }, - "responseSize": { - "description": "Size in bytes sent back to client by request.", - "format": "int64", - "type": "string" - }, - "traceId": { - "description": "Stackdriver Trace identifier for this request.", - "type": "string" - }, - "line": { - "description": "A list of log lines emitted by the application while serving this request.", - "type": "array", - "items": { - "$ref": "LogLine" - } - }, - "taskQueueName": { - "description": "Queue name of the request, in the case of an offline request.", - "type": "string" - }, - "referrer": { - "description": "Referrer URL of request.", - "type": "string" - }, - "requestId": { - "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.", - "type": "string" - }, - "nickname": { - "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.", - "type": "string" - }, - "pendingTime": { - "description": "Time this request spent in the pending request queue.", - "format": "google-duration", - "type": "string" - }, - "resource": { - "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.", - "type": "string" - }, - "status": { - "description": "HTTP response status code. Example: 200, 404.", - "format": "int32", - "type": "integer" - }, - "taskName": { - "description": "Task name of the request, in the case of an offline request.", - "type": "string" - }, - "urlMapEntry": { - "description": "File or class that handled the request.", - "type": "string" - }, "instanceIndex": { "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.", "format": "int32", @@ -388,11 +278,78 @@ "userAgent": { "description": "User agent that made the request.", "type": "string" + }, + "wasLoadingRequest": { + "description": "Whether this was a loading request for the instance.", + "type": "boolean" + }, + "sourceReference": { + "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.", + "type": "array", + "items": { + "$ref": "SourceReference" + } + }, + "responseSize": { + "description": "Size in bytes sent back to client by request.", + "format": "int64", + "type": "string" + }, + "traceId": { + "description": "Stackdriver Trace identifier for this request.", + "type": "string" + }, + "line": { + "description": "A list of log lines emitted by the application while serving this request.", + "type": "array", + "items": { + "$ref": "LogLine" + } + }, + "taskQueueName": { + "description": "Queue name of the request, in the case of an offline request.", + "type": "string" + }, + "referrer": { + "description": "Referrer URL of request.", + "type": "string" + }, + "requestId": { + "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.", + "type": "string" + }, + "nickname": { + "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.", + "type": "string" + }, + "resource": { + "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.", + "type": "string" + }, + "pendingTime": { + "description": "Time this request spent in the pending request queue.", + "format": "google-duration", + "type": "string" + }, + "status": { + "description": "HTTP response status code. Example: 200, 404.", + "format": "int32", + "type": "integer" + }, + "taskName": { + "description": "Task name of the request, in the case of an offline request.", + "type": "string" + }, + "urlMapEntry": { + "description": "File or class that handled the request.", + "type": "string" } }, "id": "RequestLog" }, "LogExclusion": { + "description": "Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.", + "type": "object", "properties": { "name": { "description": "Required. A client-assigned identifier, such as \"load-balancer-exclusion\". Identifiers are limited to 100 characters and can include only letters, digits, underscores, hyphens, and periods.", @@ -411,9 +368,7 @@ "type": "boolean" } }, - "id": "LogExclusion", - "description": "Specifies a set of log entries that are not to be stored in Stackdriver Logging. If your project receives a large volume of logs, you might be able to use exclusions to reduce your chargeable logs. Exclusions are processed after log sinks, so you can export log entries before they are excluded. Audit log entries and log entries from Amazon Web Services are never excluded.", - "type": "object" + "id": "LogExclusion" }, "ListMonitoredResourceDescriptorsResponse": { "description": "Result returned from ListMonitoredResourceDescriptors.", @@ -434,6 +389,8 @@ "id": "ListMonitoredResourceDescriptorsResponse" }, "ListExclusionsResponse": { + "description": "Result returned from ListExclusions.", + "type": "object", "properties": { "exclusions": { "description": "A list of exclusions.", @@ -447,26 +404,12 @@ "type": "string" } }, - "id": "ListExclusionsResponse", - "description": "Result returned from ListExclusions.", - "type": "object" + "id": "ListExclusionsResponse" }, "LogMetric": { "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.", "type": "object", "properties": { - "description": { - "description": "Optional. A description of this metric, which is used in documentation.", - "type": "string" - }, - "valueExtractor": { - "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")", - "type": "string" - }, - "bucketOptions": { - "$ref": "BucketOptions", - "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values." - }, "name": { "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".", "type": "string" @@ -478,6 +421,10 @@ "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.", "type": "object" }, + "metricDescriptor": { + "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.", + "$ref": "MetricDescriptor" + }, "version": { "enum": [ "V2", @@ -490,20 +437,26 @@ "Stackdriver Logging API v1." ] }, - "metricDescriptor": { - "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.", - "$ref": "MetricDescriptor" - }, "filter": { "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.", "type": "string" + }, + "description": { + "description": "Optional. A description of this metric, which is used in documentation.", + "type": "string" + }, + "bucketOptions": { + "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values.", + "$ref": "BucketOptions" + }, + "valueExtractor": { + "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")", + "type": "string" } }, "id": "LogMetric" }, "LogEntryOperation": { - "description": "Additional information about a potentially long-running operation with which a log entry is associated.", - "type": "object", "properties": { "last": { "description": "Optional. Set this to True if this is the last log entry in the operation.", @@ -522,7 +475,9 @@ "type": "boolean" } }, - "id": "LogEntryOperation" + "id": "LogEntryOperation", + "description": "Additional information about a potentially long-running operation with which a log entry is associated.", + "type": "object" }, "MonitoredResource": { "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n", @@ -611,20 +566,72 @@ }, "id": "ListLogsResponse" }, - "HttpRequest": { + "ListSinksResponse": { + "description": "Result returned from ListSinks.", + "type": "object", "properties": { + "sinks": { + "description": "A list of sinks.", + "type": "array", + "items": { + "$ref": "LogSink" + } + }, + "nextPageToken": { + "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", + "type": "string" + } + }, + "id": "ListSinksResponse" + }, + "HttpRequest": { + "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", + "type": "object", + "properties": { + "userAgent": { + "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".", + "type": "string" + }, + "latency": { + "description": "The request processing latency on the server, from the time the request was received until the response was sent.", + "format": "google-duration", + "type": "string" + }, + "cacheFillBytes": { + "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", + "format": "int64", + "type": "string" + }, + "requestMethod": { + "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".", + "type": "string" + }, + "requestSize": { + "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", + "format": "int64", + "type": "string" + }, + "responseSize": { + "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", + "format": "int64", + "type": "string" + }, + "protocol": { + "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", + "type": "string" + }, "requestUrl": { "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".", "type": "string" }, - "remoteIp": { - "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".", - "type": "string" - }, "serverIp": { "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", "type": "string" }, + "remoteIp": { + "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".", + "type": "string" + }, "cacheLookup": { "description": "Whether or not a cache lookup was attempted.", "type": "boolean" @@ -645,65 +652,11 @@ "referer": { "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", "type": "string" - }, - "latency": { - "description": "The request processing latency on the server, from the time the request was received until the response was sent.", - "format": "google-duration", - "type": "string" - }, - "userAgent": { - "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".", - "type": "string" - }, - "cacheFillBytes": { - "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", - "format": "int64", - "type": "string" - }, - "requestMethod": { - "description": "The request method. Examples: \"GET\", \"HEAD\", \"PUT\", \"POST\".", - "type": "string" - }, - "protocol": { - "description": "Protocol used for the request. Examples: \"HTTP/1.1\", \"HTTP/2\", \"websocket\"", - "type": "string" - }, - "responseSize": { - "description": "The size of the HTTP response message sent back to the client, in bytes, including the response headers and the response body.", - "format": "int64", - "type": "string" - }, - "requestSize": { - "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", - "format": "int64", - "type": "string" } }, - "id": "HttpRequest", - "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", - "type": "object" - }, - "ListSinksResponse": { - "description": "Result returned from ListSinks.", - "type": "object", - "properties": { - "sinks": { - "description": "A list of sinks.", - "type": "array", - "items": { - "$ref": "LogSink" - } - }, - "nextPageToken": { - "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", - "type": "string" - } - }, - "id": "ListSinksResponse" + "id": "HttpRequest" }, "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.", - "type": "object", "properties": { "labels": { "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".", @@ -729,11 +682,11 @@ "type": "string" } }, - "id": "MonitoredResourceDescriptor" + "id": "MonitoredResourceDescriptor", + "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.", + "type": "object" }, "LogEntrySourceLocation": { - "description": "Additional information about the source code location that produced the log entry.", - "type": "object", "properties": { "file": { "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", @@ -749,11 +702,11 @@ "type": "string" } }, - "id": "LogEntrySourceLocation" + "id": "LogEntrySourceLocation", + "description": "Additional information about the source code location that produced the log entry.", + "type": "object" }, "ListLogEntriesResponse": { - "description": "Result returned from ListLogEntries.", - "type": "object", "properties": { "nextPageToken": { "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.", @@ -767,11 +720,26 @@ } } }, - "id": "ListLogEntriesResponse" + "id": "ListLogEntriesResponse", + "description": "Result returned from ListLogEntries.", + "type": "object" }, "LogLine": { + "description": "Application log line emitted while processing a request.", + "type": "object", "properties": { "severity": { + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or a configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ], "enum": [ "DEFAULT", "DEBUG", @@ -784,18 +752,7 @@ "EMERGENCY" ], "description": "Severity of this log entry.", - "type": "string", - "enumDescriptions": [ - "(0) The log entry has no assigned severity level.", - "(100) Debug or trace information.", - "(200) Routine information, such as ongoing status or performance.", - "(300) Normal but significant events, such as start up, shut down, or a configuration change.", - "(400) Warning events might cause problems.", - "(500) Error events are likely to cause problems.", - "(600) Critical events cause more severe problems or outages.", - "(700) A person must take an action immediately.", - "(800) One or more systems are unusable." - ] + "type": "string" }, "logMessage": { "description": "App-provided log message.", @@ -811,14 +768,15 @@ "type": "string" } }, - "id": "LogLine", - "description": "Application log line emitted while processing a request.", - "type": "object" + "id": "LogLine" }, "Linear": { - "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).", - "type": "object", "properties": { + "width": { + "description": "Must be greater than 0.", + "format": "double", + "type": "number" + }, "offset": { "description": "Lower bound of the first bucket.", "format": "double", @@ -828,29 +786,22 @@ "description": "Must be greater than 0.", "format": "int32", "type": "integer" - }, - "width": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" } }, - "id": "Linear" + "id": "Linear", + "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).", + "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", - "type": "object", "properties": {}, - "id": "Empty" + "id": "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:\nservice Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n}\nThe JSON representation for Empty is empty JSON object {}.", + "type": "object" }, "SourceLocation": { "description": "Specifies a location in a source code file.", "type": "object", "properties": { - "file": { - "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", - "type": "string" - }, "functionName": { "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).", "type": "string" @@ -859,6 +810,10 @@ "description": "Line within the source file.", "format": "int64", "type": "string" + }, + "file": { + "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", + "type": "string" } }, "id": "SourceLocation" @@ -917,8 +872,6 @@ "id": "Explicit" }, "SourceReference": { - "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", - "type": "object", "properties": { "revisionId": { "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"", @@ -929,7 +882,9 @@ "type": "string" } }, - "id": "SourceReference" + "id": "SourceReference", + "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", + "type": "object" }, "WriteLogEntriesResponse": { "description": "Result returned from WriteLogEntries. empty", @@ -963,6 +918,10 @@ "description": "The parameters to WriteLogEntries.", "type": "object", "properties": { + "partialSuccess": { + "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.", + "type": "boolean" + }, "labels": { "additionalProperties": { "type": "string" @@ -984,19 +943,63 @@ "items": { "$ref": "LogEntry" } - }, - "partialSuccess": { - "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.", - "type": "boolean" } }, "id": "WriteLogEntriesRequest" + }, + "LabelDescriptor": { + "description": "A description of a label.", + "type": "object", + "properties": { + "key": { + "description": "The label key.", + "type": "string" + }, + "description": { + "description": "A human-readable description for the label.", + "type": "string" + }, + "valueType": { + "enum": [ + "STRING", + "BOOL", + "INT64" + ], + "description": "The type of data that can be assigned to the label.", + "type": "string", + "enumDescriptions": [ + "A variable-length string. This is the default.", + "Boolean; true or false.", + "A 64-bit signed integer." + ] + } + }, + "id": "LabelDescriptor" + }, + "BucketOptions": { + "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", + "type": "object", + "properties": { + "exponentialBuckets": { + "$ref": "Exponential", + "description": "The exponential buckets." + }, + "linearBuckets": { + "description": "The linear bucket.", + "$ref": "Linear" + }, + "explicitBuckets": { + "description": "The explicit buckets.", + "$ref": "Explicit" + } + }, + "id": "BucketOptions" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Logging", "auth": { @@ -1028,111 +1031,514 @@ "title": "Stackdriver Logging API", "ownerName": "Google", "resources": { - "sinks": { - "methods": { - "update": { - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PUT", - "parameters": { - "sinkName": { - "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", - "location": "path", - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string" + "folders": { + "resources": { + "logs": { + "methods": { + "delete": { + "path": "v2/{+logName}", + "id": "logging.folders.logs.delete", + "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "logName" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "logName": { + "pattern": "^folders/[^/]+/logs/[^/]+$", + "location": "path", + "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/folders/{foldersId}/logs/{logsId}" }, - "uniqueWriterIdentity": { - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean", - "location": "query" - }, - "updateMask": { - "location": "query", - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string" + "list": { + "path": "v2/{+parent}/logs", + "id": "logging.folders.logs.list", + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", + "response": { + "$ref": "ListLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + }, + "parent": { + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/folders/{foldersId}/logs" } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.sinks.update" + } }, + "sinks": { + "methods": { + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "DELETE", + "parameters": { + "sinkName": { + "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+/sinks/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.folders.sinks.delete", + "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted." + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListSinksResponse" + }, + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/folders/{foldersId}/sinks", + "id": "logging.folders.sinks.list", + "path": "v2/{+parent}/sinks", + "description": "Lists sinks." + }, + "create": { + "request": { + "$ref": "LogSink" + }, + "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", + "type": "boolean" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/folders/{foldersId}/sinks", + "path": "v2/{+parent}/sinks", + "id": "logging.folders.sinks.create" + }, + "get": { + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "sinkName": { + "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+/sinks/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.folders.sinks.get", + "description": "Gets a sink." + }, + "patch": { + "path": "v2/{+sinkName}", + "id": "logging.folders.sinks.patch", + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "request": { + "$ref": "LogSink" + }, + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "sinkName": { + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+/sinks/[^/]+$", + "location": "path" + }, + "uniqueWriterIdentity": { + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean", + "location": "query" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}" + }, + "update": { + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "PUT", + "parameters": { + "sinkName": { + "pattern": "^folders/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean" + }, + "updateMask": { + "location": "query", + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.folders.sinks.update", + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field." + } + } + }, + "exclusions": { + "methods": { + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "pattern": "^folders/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", + "id": "logging.folders.exclusions.delete", + "path": "v2/{+name}", + "description": "Deletes an exclusion." + }, + "list": { + "response": { + "$ref": "ListExclusionsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^folders/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2/folders/{foldersId}/exclusions", + "path": "v2/{+parent}/exclusions", + "id": "logging.folders.exclusions.list", + "description": "Lists all the exclusions in a parent resource." + }, + "get": { + "description": "Gets the description of an exclusion.", + "response": { + "$ref": "LogExclusion" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "name": { + "pattern": "^folders/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", + "path": "v2/{+name}", + "id": "logging.folders.exclusions.get" + }, + "patch": { + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "LogExclusion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "updateMask": { + "location": "query", + "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "pattern": "^folders/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", + "id": "logging.folders.exclusions.patch", + "path": "v2/{+name}", + "description": "Changes one or more properties of an existing exclusion.", + "request": { + "$ref": "LogExclusion" + } + }, + "create": { + "request": { + "$ref": "LogExclusion" + }, + "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "LogExclusion" + }, + "parameters": { + "parent": { + "pattern": "^folders/[^/]+$", + "location": "path", + "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/folders/{foldersId}/exclusions", + "id": "logging.folders.exclusions.create", + "path": "v2/{+parent}/exclusions" + } + } + } + } + }, + "exclusions": { + "methods": { "create": { - "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", + "id": "logging.exclusions.create", + "path": "v2/{+parent}/exclusions", "request": { - "$ref": "LogSink" + "$ref": "LogExclusion" }, - "response": { - "$ref": "LogSink" - }, + "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", + "httpMethod": "POST", "parameterOrder": [ "parent" ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], + "response": { + "$ref": "LogExclusion" + }, "parameters": { "parent": { "pattern": "^[^/]+/[^/]+$", "location": "path", - "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "type": "string" - }, - "uniqueWriterIdentity": { - "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", - "type": "boolean", - "location": "query" } }, - "flatPath": "v2/{v2Id}/{v2Id1}/sinks", - "path": "v2/{+parent}/sinks", - "id": "logging.sinks.create" - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" ], + "flatPath": "v2/{v2Id}/{v2Id1}/exclusions" + }, + "delete": { + "path": "v2/{+name}", + "id": "logging.exclusions.delete", + "description": "Deletes an exclusion.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", "parameters": { - "sinkName": { - "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "name": { + "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", - "location": "path" + "type": "string" } }, - "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.sinks.delete", - "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}" }, "list": { + "path": "v2/{+parent}/exclusions", + "id": "logging.exclusions.list", + "description": "Lists all the exclusions in a parent resource.", "response": { - "$ref": "ListSinksResponse" + "$ref": "ListExclusionsResponse" }, "parameterOrder": [ "parent" @@ -1140,7 +1546,7 @@ "httpMethod": "GET", "parameters": { "parent": { - "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", "required": true, "type": "string", "pattern": "^[^/]+/[^/]+$", @@ -1164,19 +1570,82 @@ "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], - "flatPath": "v2/{v2Id}/{v2Id1}/sinks", - "path": "v2/{+parent}/sinks", - "id": "logging.sinks.list", - "description": "Lists sinks." + "flatPath": "v2/{v2Id}/{v2Id1}/exclusions" }, "get": { + "description": "Gets the description of an exclusion.", "response": { - "$ref": "LogSink" + "$ref": "LogExclusion" }, "parameterOrder": [ - "sinkName" + "name" ], "httpMethod": "GET", + "parameters": { + "name": { + "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", + "path": "v2/{+name}", + "id": "logging.exclusions.get" + }, + "patch": { + "request": { + "$ref": "LogExclusion" + }, + "description": "Changes one or more properties of an existing exclusion.", + "response": { + "$ref": "LogExclusion" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "updateMask": { + "location": "query", + "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string", + "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", + "path": "v2/{+name}", + "id": "logging.exclusions.patch" + } + } + }, + "monitoredResourceDescriptors": { + "methods": { + "list": { + "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.", + "response": { + "$ref": "ListMonitoredResourceDescriptorsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", @@ -1184,62 +1653,516 @@ "https://www.googleapis.com/auth/logging.read" ], "parameters": { - "sinkName": { - "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", - "location": "path" + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" } }, - "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.sinks.get", - "description": "Gets a sink." + "flatPath": "v2/monitoredResourceDescriptors", + "path": "v2/monitoredResourceDescriptors", + "id": "logging.monitoredResourceDescriptors.list" + } + } + }, + "organizations": { + "resources": { + "logs": { + "methods": { + "delete": { + "path": "v2/{+logName}", + "id": "logging.organizations.logs.delete", + "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "logName" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "logName": { + "pattern": "^organizations/[^/]+/logs/[^/]+$", + "location": "path", + "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}" + }, + "list": { + "response": { + "$ref": "ListLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "parent": { + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2/organizations/{organizationsId}/logs", + "path": "v2/{+parent}/logs", + "id": "logging.organizations.logs.list", + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." + } + } + }, + "sinks": { + "methods": { + "delete": { + "path": "v2/{+sinkName}", + "id": "logging.organizations.sinks.delete", + "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "DELETE", + "parameters": { + "sinkName": { + "pattern": "^organizations/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}" + }, + "list": { + "id": "logging.organizations.sinks.list", + "path": "v2/{+parent}/sinks", + "description": "Lists sinks.", + "httpMethod": "GET", + "response": { + "$ref": "ListSinksResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/organizations/{organizationsId}/sinks" + }, + "create": { + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", + "type": "boolean" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/organizations/{organizationsId}/sinks", + "path": "v2/{+parent}/sinks", + "id": "logging.organizations.sinks.create", + "request": { + "$ref": "LogSink" + }, + "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink." + }, + "get": { + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "sinkName": { + "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/sinks/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.organizations.sinks.get", + "description": "Gets a sink." + }, + "patch": { + "id": "logging.organizations.sinks.patch", + "path": "v2/{+sinkName}", + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "request": { + "$ref": "LogSink" + }, + "httpMethod": "PATCH", + "parameterOrder": [ + "sinkName" + ], + "response": { + "$ref": "LogSink" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "sinkName": { + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/sinks/[^/]+$", + "location": "path" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean" + }, + "updateMask": { + "location": "query", + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string" + } + }, + "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}" + }, + "update": { + "path": "v2/{+sinkName}", + "id": "logging.organizations.sinks.update", + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "PUT", + "parameters": { + "sinkName": { + "pattern": "^organizations/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}" + } + } + }, + "exclusions": { + "methods": { + "create": { + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "LogExclusion" + }, + "parameters": { + "parent": { + "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/organizations/{organizationsId}/exclusions", + "id": "logging.organizations.exclusions.create", + "path": "v2/{+parent}/exclusions", + "request": { + "$ref": "LogExclusion" + }, + "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource." + }, + "delete": { + "description": "Deletes an exclusion.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/exclusions/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}", + "path": "v2/{+name}", + "id": "logging.organizations.exclusions.delete" + }, + "list": { + "id": "logging.organizations.exclusions.list", + "path": "v2/{+parent}/exclusions", + "description": "Lists all the exclusions in a parent resource.", + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListExclusionsResponse" + }, + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/organizations/{organizationsId}/exclusions" + }, + "get": { + "id": "logging.organizations.exclusions.get", + "path": "v2/{+name}", + "description": "Gets the description of an exclusion.", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "LogExclusion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "name": { + "pattern": "^organizations/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}" + }, + "patch": { + "id": "logging.organizations.exclusions.patch", + "path": "v2/{+name}", + "description": "Changes one or more properties of an existing exclusion.", + "request": { + "$ref": "LogExclusion" + }, + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "LogExclusion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "updateMask": { + "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "name": { + "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/exclusions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}" + } + } + } + } + }, + "entries": { + "methods": { + "write": { + "path": "v2/entries:write", + "id": "logging.entries.write", + "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.", + "request": { + "$ref": "WriteLogEntriesRequest" + }, + "response": { + "$ref": "WriteLogEntriesResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.write" + ], + "parameters": {}, + "flatPath": "v2/entries:write" + }, + "list": { + "id": "logging.entries.list", + "path": "v2/entries:list", + "request": { + "$ref": "ListLogEntriesRequest" + }, + "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "ListLogEntriesResponse" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/entries:list" } } }, "logs": { "methods": { - "list": { - "httpMethod": "GET", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ListLogsResponse" - }, - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "location": "path", - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/logs", - "id": "logging.logs.list", - "path": "v2/{+parent}/logs", - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." - }, "delete": { "response": { "$ref": "Empty" @@ -1265,6 +2188,216 @@ "path": "v2/{+logName}", "id": "logging.logs.delete", "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted." + }, + "list": { + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", + "response": { + "$ref": "ListLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "pattern": "^[^/]+/[^/]+$", + "location": "path", + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/{v2Id}/{v2Id1}/logs", + "path": "v2/{+parent}/logs", + "id": "logging.logs.list" + } + } + }, + "sinks": { + "methods": { + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "DELETE", + "parameters": { + "sinkName": { + "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.sinks.delete", + "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted." + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListSinksResponse" + }, + "parameters": { + "parent": { + "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^[^/]+/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/sinks", + "id": "logging.sinks.list", + "path": "v2/{+parent}/sinks", + "description": "Lists sinks." + }, + "get": { + "description": "Gets a sink.", + "httpMethod": "GET", + "parameterOrder": [ + "sinkName" + ], + "response": { + "$ref": "LogSink" + }, + "parameters": { + "sinkName": { + "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", + "id": "logging.sinks.get", + "path": "v2/{+sinkName}" + }, + "update": { + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "PUT", + "parameters": { + "sinkName": { + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^[^/]+/[^/]+/sinks/[^/]+$", + "location": "path" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean" + }, + "updateMask": { + "location": "query", + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/{v2Id}/{v2Id1}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.sinks.update", + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field." + }, + "create": { + "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", + "request": { + "$ref": "LogSink" + }, + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "LogSink" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "parent": { + "pattern": "^[^/]+/[^/]+$", + "location": "path", + "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", + "type": "boolean" + } + }, + "flatPath": "v2/{v2Id}/{v2Id1}/sinks", + "id": "logging.sinks.create", + "path": "v2/{+parent}/sinks" } } }, @@ -1299,48 +2432,82 @@ "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted." }, "list": { - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", + "httpMethod": "GET", "response": { "$ref": "ListLogsResponse" }, "parameterOrder": [ "parent" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], "parameters": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, "parent": { "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", "required": true, "type": "string", "pattern": "^projects/[^/]+$", "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], "flatPath": "v2/projects/{projectsId}/logs", + "id": "logging.projects.logs.list", "path": "v2/{+parent}/logs", - "id": "logging.projects.logs.list" + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." } } }, "sinks": { "methods": { + "create": { + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", + "type": "boolean", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/projects/{projectsId}/sinks", + "path": "v2/{+parent}/sinks", + "id": "logging.projects.sinks.create", + "request": { + "$ref": "LogSink" + }, + "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink." + }, "get": { "path": "v2/{+sinkName}", "id": "logging.projects.sinks.get", @@ -1352,87 +2519,43 @@ "sinkName" ], "httpMethod": "GET", - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/sinks/[^/]+$" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], + "parameters": { + "sinkName": { + "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/sinks/[^/]+$", + "location": "path" + } + }, "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}" }, "patch": { - "request": { + "response": { "$ref": "LogSink" }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "parameterOrder": [ + "sinkName" + ], "httpMethod": "PATCH", - "parameterOrder": [ - "sinkName" - ], - "response": { - "$ref": "LogSink" - }, "parameters": { "sinkName": { + "pattern": "^projects/[^/]+/sinks/[^/]+$", + "location": "path", "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/sinks/[^/]+$", - "location": "path" + "type": "string" }, "uniqueWriterIdentity": { - "location": "query", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" - }, - "updateMask": { - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string", + "type": "boolean", "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", - "id": "logging.projects.sinks.patch", - "path": "v2/{+sinkName}" - }, - "update": { - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PUT", - "parameters": { - "sinkName": { - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/sinks/[^/]+$", - "location": "path" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" }, "updateMask": { "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", @@ -1447,7 +2570,51 @@ ], "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}", "path": "v2/{+sinkName}", - "id": "logging.projects.sinks.update" + "id": "logging.projects.sinks.patch", + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field." + }, + "update": { + "id": "logging.projects.sinks.update", + "path": "v2/{+sinkName}", + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "httpMethod": "PUT", + "parameterOrder": [ + "sinkName" + ], + "response": { + "$ref": "LogSink" + }, + "parameters": { + "sinkName": { + "pattern": "^projects/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean" + }, + "updateMask": { + "location": "query", + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/projects/{projectsId}/sinks/{sinksId}" }, "delete": { "response": { @@ -1490,207 +2657,72 @@ "https://www.googleapis.com/auth/logging.read" ], "parameters": { - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "location": "path", - "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, "pageToken": { "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" } }, "flatPath": "v2/projects/{projectsId}/sinks", "path": "v2/{+parent}/sinks", "id": "logging.projects.sinks.list", "description": "Lists sinks." - }, - "create": { - "flatPath": "v2/projects/{projectsId}/sinks", - "id": "logging.projects.sinks.create", - "path": "v2/{+parent}/sinks", - "request": { - "$ref": "LogSink" - }, - "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "LogSink" - }, - "parameters": { - "parent": { - "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "uniqueWriterIdentity": { - "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", - "type": "boolean", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ] } } }, "exclusions": { "methods": { - "list": { - "httpMethod": "GET", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ListExclusionsResponse" - }, - "parameters": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/projects/{projectsId}/exclusions", - "id": "logging.projects.exclusions.list", - "path": "v2/{+parent}/exclusions", - "description": "Lists all the exclusions in a parent resource." - }, - "get": { - "description": "Gets the description of an exclusion.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "LogExclusion" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+/exclusions/[^/]+$", - "location": "path", - "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", - "id": "logging.projects.exclusions.get", - "path": "v2/{+name}" - }, - "patch": { - "description": "Changes one or more properties of an existing exclusion.", - "request": { - "$ref": "LogExclusion" - }, - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "updateMask": { - "location": "query", - "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", - "format": "google-fieldmask", - "type": "string" - }, - "name": { - "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/exclusions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", - "path": "v2/{+name}", - "id": "logging.projects.exclusions.patch" - }, "create": { - "flatPath": "v2/projects/{projectsId}/exclusions", - "path": "v2/{+parent}/exclusions", - "id": "logging.projects.exclusions.create", "request": { "$ref": "LogExclusion" }, "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", - "response": { - "$ref": "LogExclusion" - }, + "httpMethod": "POST", "parameterOrder": [ "parent" ], - "httpMethod": "POST", + "response": { + "$ref": "LogExclusion" + }, "parameters": { "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/logging.admin" - ] + ], + "flatPath": "v2/projects/{projectsId}/exclusions", + "id": "logging.projects.exclusions.create", + "path": "v2/{+parent}/exclusions" }, "delete": { + "description": "Deletes an exclusion.", + "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], - "httpMethod": "DELETE", "parameters": { "name": { "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", @@ -1705,33 +2737,130 @@ "https://www.googleapis.com/auth/logging.admin" ], "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", - "path": "v2/{+name}", "id": "logging.projects.exclusions.delete", - "description": "Deletes an exclusion." + "path": "v2/{+name}" + }, + "list": { + "path": "v2/{+parent}/exclusions", + "id": "logging.projects.exclusions.list", + "description": "Lists all the exclusions in a parent resource.", + "response": { + "$ref": "ListExclusionsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/projects/{projectsId}/exclusions" + }, + "get": { + "description": "Gets the description of an exclusion.", + "response": { + "$ref": "LogExclusion" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", + "path": "v2/{+name}", + "id": "logging.projects.exclusions.get" + }, + "patch": { + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "LogExclusion" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + }, + "updateMask": { + "location": "query", + "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", + "format": "google-fieldmask", + "type": "string" + } + }, + "flatPath": "v2/projects/{projectsId}/exclusions/{exclusionsId}", + "id": "logging.projects.exclusions.patch", + "path": "v2/{+name}", + "description": "Changes one or more properties of an existing exclusion.", + "request": { + "$ref": "LogExclusion" + } } } }, "metrics": { "methods": { "update": { - "request": { - "$ref": "LogMetric" - }, - "description": "Creates or updates a logs-based metric.", - "httpMethod": "PUT", - "parameterOrder": [ - "metricName" - ], "response": { "$ref": "LogMetric" }, + "parameterOrder": [ + "metricName" + ], + "httpMethod": "PUT", "parameters": { "metricName": { - "location": "path", "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/metrics/[^/]+$" + "pattern": "^projects/[^/]+/metrics/[^/]+$", + "location": "path" } }, "scopes": [ @@ -1740,8 +2869,12 @@ "https://www.googleapis.com/auth/logging.write" ], "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}", + "path": "v2/{+metricName}", "id": "logging.projects.metrics.update", - "path": "v2/{+metricName}" + "request": { + "$ref": "LogMetric" + }, + "description": "Creates or updates a logs-based metric." }, "create": { "description": "Creates a logs-based metric.", @@ -1762,11 +2895,11 @@ ], "parameters": { "parent": { - "location": "path", "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.", "required": true, "type": "string", - "pattern": "^projects/[^/]+$" + "pattern": "^projects/[^/]+$", + "location": "path" } }, "flatPath": "v2/projects/{projectsId}/metrics", @@ -1801,7 +2934,6 @@ "description": "Deletes a logs-based metric." }, "list": { - "flatPath": "v2/projects/{projectsId}/metrics", "path": "v2/{+parent}/metrics", "id": "logging.projects.metrics.list", "description": "Lists logs-based metrics.", @@ -1812,60 +2944,61 @@ "parent" ], "httpMethod": "GET", + "parameters": { + "parent": { + "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], - "parameters": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n", - "required": true, - "type": "string" - } - } + "flatPath": "v2/projects/{projectsId}/metrics" }, "get": { + "description": "Gets a logs-based metric.", + "httpMethod": "GET", "response": { "$ref": "LogMetric" }, "parameterOrder": [ "metricName" ], - "httpMethod": "GET", + "parameters": { + "metricName": { + "pattern": "^projects/[^/]+/metrics/[^/]+$", + "location": "path", + "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], - "parameters": { - "metricName": { - "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/metrics/[^/]+$", - "location": "path" - } - }, "flatPath": "v2/projects/{projectsId}/metrics/{metricsId}", - "path": "v2/{+metricName}", "id": "logging.projects.metrics.get", - "description": "Gets a logs-based metric." + "path": "v2/{+metricName}" } } } @@ -1876,7 +3009,6 @@ "logs": { "methods": { "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", "response": { "$ref": "Empty" }, @@ -1886,11 +3018,11 @@ "httpMethod": "DELETE", "parameters": { "logName": { - "location": "path", "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", "required": true, "type": "string", - "pattern": "^billingAccounts/[^/]+/logs/[^/]+$" + "pattern": "^billingAccounts/[^/]+/logs/[^/]+$", + "location": "path" } }, "scopes": [ @@ -1899,9 +3031,12 @@ ], "flatPath": "v2/billingAccounts/{billingAccountsId}/logs/{logsId}", "path": "v2/{+logName}", - "id": "logging.billingAccounts.logs.delete" + "id": "logging.billingAccounts.logs.delete", + "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted." }, "list": { + "path": "v2/{+parent}/logs", + "id": "logging.billingAccounts.logs.list", "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", "response": { "$ref": "ListLogsResponse" @@ -1911,23 +3046,23 @@ ], "httpMethod": "GET", "parameters": { + "parent": { + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^billingAccounts/[^/]+$", + "location": "path" + }, "pageToken": { - "location": "query", "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", "type": "integer" - }, - "parent": { - "location": "path", - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+$" } }, "scopes": [ @@ -1936,82 +3071,12 @@ "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], - "flatPath": "v2/billingAccounts/{billingAccountsId}/logs", - "path": "v2/{+parent}/logs", - "id": "logging.billingAccounts.logs.list" + "flatPath": "v2/billingAccounts/{billingAccountsId}/logs" } } }, "sinks": { "methods": { - "get": { - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "sinkName": { - "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", - "location": "path", - "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string" - } - }, - "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.billingAccounts.sinks.get", - "description": "Gets a sink." - }, - "patch": { - "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.billingAccounts.sinks.patch", - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "sinkName": { - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", - "location": "path" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" - }, - "updateMask": { - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - } - }, "update": { "path": "v2/{+sinkName}", "id": "logging.billingAccounts.sinks.update", @@ -2039,9 +3104,9 @@ "location": "path" }, "uniqueWriterIdentity": { - "location": "query", "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" + "type": "boolean", + "location": "query" }, "updateMask": { "location": "query", @@ -2053,10 +3118,6 @@ "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}" }, "delete": { - "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.billingAccounts.sinks.delete", - "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.", "response": { "$ref": "Empty" }, @@ -2076,10 +3137,13 @@ "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", "location": "path" } - } + }, + "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.billingAccounts.sinks.delete", + "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted." }, "list": { - "description": "Lists sinks.", "response": { "$ref": "ListSinksResponse" }, @@ -2087,41 +3151,38 @@ "parent" ], "httpMethod": "GET", - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "location": "path", - "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+$" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloud-platform.read-only", "https://www.googleapis.com/auth/logging.admin", "https://www.googleapis.com/auth/logging.read" ], + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "pattern": "^billingAccounts/[^/]+$", + "location": "path", + "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string" + } + }, "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks", "path": "v2/{+parent}/sinks", - "id": "logging.billingAccounts.sinks.list" + "id": "logging.billingAccounts.sinks.list", + "description": "Lists sinks." }, "create": { - "request": { - "$ref": "LogSink" - }, - "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", "httpMethod": "POST", "parameterOrder": [ "parent" @@ -2130,17 +3191,17 @@ "$ref": "LogSink" }, "parameters": { - "uniqueWriterIdentity": { - "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", - "type": "boolean", - "location": "query" - }, "parent": { "pattern": "^billingAccounts/[^/]+$", "location": "path", "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, "type": "string" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", + "type": "boolean" } }, "scopes": [ @@ -2149,7 +3210,79 @@ ], "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks", "id": "logging.billingAccounts.sinks.create", - "path": "v2/{+parent}/sinks" + "path": "v2/{+parent}/sinks", + "request": { + "$ref": "LogSink" + }, + "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink." + }, + "get": { + "description": "Gets a sink.", + "httpMethod": "GET", + "parameterOrder": [ + "sinkName" + ], + "response": { + "$ref": "LogSink" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "sinkName": { + "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", + "id": "logging.billingAccounts.sinks.get", + "path": "v2/{+sinkName}" + }, + "patch": { + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "PATCH", + "parameters": { + "sinkName": { + "pattern": "^billingAccounts/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string" + }, + "uniqueWriterIdentity": { + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean", + "location": "query" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2/billingAccounts/{billingAccountsId}/sinks/{sinksId}", + "path": "v2/{+sinkName}", + "id": "logging.billingAccounts.sinks.patch" } } }, @@ -2165,11 +3298,11 @@ "httpMethod": "POST", "parameters": { "parent": { + "pattern": "^billingAccounts/[^/]+$", + "location": "path", "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ @@ -2185,9 +3318,6 @@ "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource." }, "delete": { - "path": "v2/{+name}", - "id": "logging.billingAccounts.exclusions.delete", - "description": "Deletes an exclusion.", "response": { "$ref": "Empty" }, @@ -2201,14 +3331,17 @@ ], "parameters": { "name": { + "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$", + "location": "path", "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$", - "location": "path" + "type": "string" } }, - "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}" + "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}", + "path": "v2/{+name}", + "id": "logging.billingAccounts.exclusions.delete", + "description": "Deletes an exclusion." }, "list": { "response": { @@ -2218,32 +3351,32 @@ "parent" ], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], "parameters": { + "parent": { + "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^billingAccounts/[^/]+$", + "location": "path" + }, "pageToken": { "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", "type": "string", "location": "query" }, "pageSize": { - "location": "query", "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^billingAccounts/[^/]+$", - "location": "path", - "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string" + "type": "integer", + "location": "query" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions", "path": "v2/{+parent}/exclusions", "id": "logging.billingAccounts.exclusions.list", @@ -2258,6 +3391,12 @@ "name" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], "parameters": { "name": { "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$", @@ -2267,1198 +3406,70 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}", "path": "v2/{+name}", "id": "logging.billingAccounts.exclusions.get" }, "patch": { + "response": { + "$ref": "LogExclusion" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "name": { + "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$", + "location": "path", + "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", + "required": true, + "type": "string" + }, + "updateMask": { + "location": "query", + "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], "flatPath": "v2/billingAccounts/{billingAccountsId}/exclusions/{exclusionsId}", "path": "v2/{+name}", "id": "logging.billingAccounts.exclusions.patch", - "description": "Changes one or more properties of an existing exclusion.", - "request": { - "$ref": "LogExclusion" - }, - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "updateMask": { - "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "location": "path", - "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+/exclusions/[^/]+$" - } - } - } - } - } - } - }, - "folders": { - "resources": { - "exclusions": { - "methods": { - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "LogExclusion" - }, - "parameters": { - "parent": { - "pattern": "^folders/[^/]+$", - "location": "path", - "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/exclusions", - "id": "logging.folders.exclusions.create", - "path": "v2/{+parent}/exclusions", - "request": { - "$ref": "LogExclusion" - }, - "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource." - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/exclusions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", - "path": "v2/{+name}", - "id": "logging.folders.exclusions.delete", - "description": "Deletes an exclusion." - }, - "list": { - "response": { - "$ref": "ListExclusionsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "parent": { - "pattern": "^folders/[^/]+$", - "location": "path", - "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v2/folders/{foldersId}/exclusions", - "path": "v2/{+parent}/exclusions", - "id": "logging.folders.exclusions.list", - "description": "Lists all the exclusions in a parent resource." - }, - "get": { - "description": "Gets the description of an exclusion.", - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/exclusions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}", - "path": "v2/{+name}", - "id": "logging.folders.exclusions.get" - }, - "patch": { - "path": "v2/{+name}", - "id": "logging.folders.exclusions.patch", - "request": { - "$ref": "LogExclusion" - }, - "description": "Changes one or more properties of an existing exclusion.", - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "location": "query", - "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", - "format": "google-fieldmask", - "type": "string" - }, - "name": { - "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/exclusions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/exclusions/{exclusionsId}" - } - } - }, - "logs": { - "methods": { - "list": { - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", - "response": { - "$ref": "ListLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/folders/{foldersId}/logs", - "path": "v2/{+parent}/logs", - "id": "logging.folders.logs.list" - }, - "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "logName" - ], - "httpMethod": "DELETE", - "parameters": { - "logName": { - "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/logs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/logs/{logsId}", - "path": "v2/{+logName}", - "id": "logging.folders.logs.delete" - } - } - }, - "sinks": { - "methods": { - "get": { - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "GET", - "parameters": { - "sinkName": { - "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/sinks/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.folders.sinks.get", - "description": "Gets a sink." - }, - "patch": { - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PATCH", - "parameters": { - "sinkName": { - "pattern": "^folders/[^/]+/sinks/[^/]+$", - "location": "path", - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" - }, - "updateMask": { - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.folders.sinks.patch" - }, - "update": { - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PUT", - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/sinks/[^/]+$" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" - }, - "updateMask": { - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.folders.sinks.update" - }, - "delete": { - "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "sinkName" - ], - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^folders/[^/]+/sinks/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/folders/{foldersId}/sinks/{sinksId}", - "id": "logging.folders.sinks.delete", - "path": "v2/{+sinkName}" - }, - "list": { - "response": { - "$ref": "ListSinksResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^folders/[^/]+$", - "location": "path", - "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string" - } - }, - "flatPath": "v2/folders/{foldersId}/sinks", - "path": "v2/{+parent}/sinks", - "id": "logging.folders.sinks.list", - "description": "Lists sinks." - }, - "create": { - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "parent": { - "pattern": "^folders/[^/]+$", - "location": "path", - "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", - "type": "boolean" - } - }, - "flatPath": "v2/folders/{foldersId}/sinks", - "path": "v2/{+parent}/sinks", - "id": "logging.folders.sinks.create", - "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", - "request": { - "$ref": "LogSink" - } - } - } - } - } - }, - "exclusions": { - "methods": { - "delete": { - "description": "Deletes an exclusion.", - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", - "location": "path", - "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", - "id": "logging.exclusions.delete", - "path": "v2/{+name}" - }, - "list": { - "path": "v2/{+parent}/exclusions", - "id": "logging.exclusions.list", - "description": "Lists all the exclusions in a parent resource.", - "response": { - "$ref": "ListExclusionsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/exclusions" - }, - "get": { - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", - "path": "v2/{+name}", - "id": "logging.exclusions.get", - "description": "Gets the description of an exclusion." - }, - "patch": { - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+/exclusions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/exclusions/{exclusionsId}", - "path": "v2/{+name}", - "id": "logging.exclusions.patch", - "request": { - "$ref": "LogExclusion" - }, - "description": "Changes one or more properties of an existing exclusion." - }, - "create": { - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "LogExclusion" - }, - "parameters": { - "parent": { - "location": "path", - "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string", - "pattern": "^[^/]+/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/{v2Id}/{v2Id1}/exclusions", - "id": "logging.exclusions.create", - "path": "v2/{+parent}/exclusions", - "request": { - "$ref": "LogExclusion" - }, - "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource." - } - } - }, - "monitoredResourceDescriptors": { - "methods": { - "list": { - "path": "v2/monitoredResourceDescriptors", - "id": "logging.monitoredResourceDescriptors.list", - "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.", - "response": { - "$ref": "ListMonitoredResourceDescriptorsResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/monitoredResourceDescriptors" - } - } - }, - "organizations": { - "resources": { - "logs": { - "methods": { - "list": { - "path": "v2/{+parent}/logs", - "id": "logging.organizations.logs.list", - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", - "response": { - "$ref": "ListLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2/organizations/{organizationsId}/logs" - }, - "delete": { - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "logName" - ], - "httpMethod": "DELETE", - "parameters": { - "logName": { - "location": "path", - "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/logs/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/organizations/{organizationsId}/logs/{logsId}", - "path": "v2/{+logName}", - "id": "logging.organizations.logs.delete" - } - } - }, - "sinks": { - "methods": { - "get": { - "description": "Gets a sink.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/sinks/[^/]+$" - } - }, - "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.organizations.sinks.get" - }, - "patch": { - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PATCH", - "parameters": { - "sinkName": { - "pattern": "^organizations/[^/]+/sinks/[^/]+$", - "location": "path", - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean" - }, - "updateMask": { - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.organizations.sinks.patch" - }, - "update": { - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "PUT", - "parameters": { - "sinkName": { - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/sinks/[^/]+$", - "location": "path" - }, - "uniqueWriterIdentity": { - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean", - "location": "query" - }, - "updateMask": { - "location": "query", - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.organizations.sinks.update" - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "DELETE", - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/sinks/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/organizations/{organizationsId}/sinks/{sinksId}", - "path": "v2/{+sinkName}", - "id": "logging.organizations.sinks.delete", - "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted." - }, - "list": { - "description": "Lists sinks.", - "response": { - "$ref": "ListSinksResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "parent": { - "pattern": "^organizations/[^/]+$", - "location": "path", - "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v2/organizations/{organizationsId}/sinks", - "path": "v2/{+parent}/sinks", - "id": "logging.organizations.sinks.list" - }, - "create": { - "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", - "request": { - "$ref": "LogSink" - }, - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "parent": { - "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - }, - "uniqueWriterIdentity": { - "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", - "type": "boolean", - "location": "query" - } - }, - "flatPath": "v2/organizations/{organizationsId}/sinks", - "path": "v2/{+parent}/sinks", - "id": "logging.organizations.sinks.create" - } - } - }, - "exclusions": { - "methods": { - "delete": { - "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}", - "path": "v2/{+name}", - "id": "logging.organizations.exclusions.delete", - "description": "Deletes an exclusion.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "name": { - "location": "path", - "description": "Required. The resource name of an existing exclusion to delete:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/exclusions/[^/]+$" - } - } - }, - "list": { - "response": { - "$ref": "ListExclusionsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "parent": { - "location": "path", - "description": "Required. The parent resource whose exclusions are to be listed.\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$" - }, - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v2/organizations/{organizationsId}/exclusions", - "path": "v2/{+parent}/exclusions", - "id": "logging.organizations.exclusions.list", - "description": "Lists all the exclusions in a parent resource." - }, - "get": { - "path": "v2/{+name}", - "id": "logging.organizations.exclusions.get", - "description": "Gets the description of an exclusion.", - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "Required. The resource name of an existing exclusion:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/exclusions/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}" - }, - "patch": { - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "LogExclusion" - }, - "parameters": { - "updateMask": { - "description": "Required. A nonempty list of fields to change in the existing exclusion. New values for the fields are taken from the corresponding fields in the LogExclusion included in this request. Fields not mentioned in update_mask are not changed and are ignored in the request.For example, to change the filter and description of an exclusion, specify an update_mask of \"filter,description\".", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "pattern": "^organizations/[^/]+/exclusions/[^/]+$", - "location": "path", - "description": "Required. The resource name of the exclusion to update:\n\"projects/[PROJECT_ID]/exclusions/[EXCLUSION_ID]\"\n\"organizations/[ORGANIZATION_ID]/exclusions/[EXCLUSION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/exclusions/[EXCLUSION_ID]\"\n\"folders/[FOLDER_ID]/exclusions/[EXCLUSION_ID]\"\nExample: \"projects/my-project-id/exclusions/my-exclusion-id\".", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2/organizations/{organizationsId}/exclusions/{exclusionsId}", - "id": "logging.organizations.exclusions.patch", - "path": "v2/{+name}", "request": { "$ref": "LogExclusion" }, "description": "Changes one or more properties of an existing exclusion." - }, - "create": { - "response": { - "$ref": "LogExclusion" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "parameters": { - "parent": { - "pattern": "^organizations/[^/]+$", - "location": "path", - "description": "Required. The parent resource in which to create the exclusion:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string" - } - }, - "flatPath": "v2/organizations/{organizationsId}/exclusions", - "path": "v2/{+parent}/exclusions", - "id": "logging.organizations.exclusions.create", - "description": "Creates a new exclusion in a specified parent resource. Only log entries belonging to that resource can be excluded. You can have up to 10 exclusions in a resource.", - "request": { - "$ref": "LogExclusion" - } } } } } - }, - "entries": { - "methods": { - "write": { - "path": "v2/entries:write", - "id": "logging.entries.write", - "request": { - "$ref": "WriteLogEntriesRequest" - }, - "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.", - "response": { - "$ref": "WriteLogEntriesResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.write" - ], - "flatPath": "v2/entries:write" - }, - "list": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "ListLogEntriesResponse" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2/entries:list", - "id": "logging.entries.list", - "path": "v2/entries:list", - "request": { - "$ref": "ListLogEntriesRequest" - }, - "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs." - } - } } }, "parameters": { - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], + "upload_protocol": { "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "callback": { @@ -3466,21 +3477,34 @@ "description": "JSONP", "type": "string" }, - "alt": { + "$.xgafv": { "enum": [ - "json", - "media", - "proto" + "1", + "2" ], + "description": "V1 error format.", "type": "string", "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "alt": { + "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", "description": "Data format for response.", - "default": "json" + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "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.", @@ -3493,55 +3517,31 @@ "location": "query" }, "quotaUser": { - "location": "query", "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", + "pp": { + "description": "Pretty-print response.", "type": "boolean", "default": "true", "location": "query" }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "bearer_token": { + "description": "OAuth bearer token.", "type": "string", "location": "query" }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" } }, "version": "v2", "baseUrl": "https://logging.googleapis.com/", - "servicePath": "", - "description": "Writes log entries and manages your Stackdriver Logging configuration.", "kind": "discovery#restDescription", - "basePath": "", - "id": "logging:v2", - "documentationLink": "https://cloud.google.com/logging/docs/", - "revision": "20171229" + "description": "Writes log entries and manages your Stackdriver Logging configuration.", + "servicePath": "", + "basePath": "" }
diff --git a/logging/v2beta1/logging-api.json b/logging/v2beta1/logging-api.json index c4b6a74..276d447 100644 --- a/logging/v2beta1/logging-api.json +++ b/logging/v2beta1/logging-api.json
@@ -1,738 +1,145 @@ { - "fullyEncodeReservedExpansion": true, - "title": "Stackdriver Logging API", - "ownerName": "Google", - "resources": { - "entries": { - "methods": { - "list": { - "request": { - "$ref": "ListLogEntriesRequest" - }, - "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.", - "response": { - "$ref": "ListLogEntriesResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2beta1/entries:list", - "path": "v2beta1/entries:list", - "id": "logging.entries.list" - }, - "write": { - "response": { - "$ref": "WriteLogEntriesResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.write" - ], - "parameters": {}, - "flatPath": "v2beta1/entries:write", - "path": "v2beta1/entries:write", - "id": "logging.entries.write", - "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.", - "request": { - "$ref": "WriteLogEntriesRequest" - } - } - } - }, - "projects": { - "resources": { - "logs": { - "methods": { - "delete": { - "path": "v2beta1/{+logName}", - "id": "logging.projects.logs.delete", - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "logName" - ], - "httpMethod": "DELETE", - "parameters": { - "logName": { - "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/logs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}" - }, - "list": { - "response": { - "$ref": "ListLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/logs", - "path": "v2beta1/{+parent}/logs", - "id": "logging.projects.logs.list", - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." - } - } - }, - "sinks": { - "methods": { - "list": { - "description": "Lists sinks.", - "response": { - "$ref": "ListSinksResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2beta1/projects/{projectsId}/sinks", - "path": "v2beta1/{+parent}/sinks", - "id": "logging.projects.sinks.list" - }, - "get": { - "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}", - "path": "v2beta1/{+sinkName}", - "id": "logging.projects.sinks.get", - "description": "Gets a sink.", - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "sinkName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/sinks/[^/]+$" - } - } - }, - "update": { - "httpMethod": "PUT", - "parameterOrder": [ - "sinkName" - ], - "response": { - "$ref": "LogSink" - }, - "parameters": { - "sinkName": { - "location": "path", - "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/sinks/[^/]+$" - }, - "uniqueWriterIdentity": { - "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", - "type": "boolean", - "location": "query" - }, - "updateMask": { - "location": "query", - "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", - "format": "google-fieldmask", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}", - "id": "logging.projects.sinks.update", - "path": "v2beta1/{+sinkName}", - "request": { - "$ref": "LogSink" - }, - "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field." - }, - "create": { - "response": { - "$ref": "LogSink" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "location": "path", - "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "uniqueWriterIdentity": { - "location": "query", - "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", - "type": "boolean" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2beta1/projects/{projectsId}/sinks", - "path": "v2beta1/{+parent}/sinks", - "id": "logging.projects.sinks.create", - "request": { - "$ref": "LogSink" - }, - "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink." - }, - "delete": { - "parameters": { - "sinkName": { - "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/sinks/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}", - "id": "logging.projects.sinks.delete", - "path": "v2beta1/{+sinkName}", - "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "sinkName" - ] - } - } - }, - "metrics": { - "methods": { - "list": { - "httpMethod": "GET", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "ListLogMetricsResponse" - }, - "parameters": { - "parent": { - "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2beta1/projects/{projectsId}/metrics", - "id": "logging.projects.metrics.list", - "path": "v2beta1/{+parent}/metrics", - "description": "Lists logs-based metrics." - }, - "get": { - "id": "logging.projects.metrics.get", - "path": "v2beta1/{+metricName}", - "description": "Gets a logs-based metric.", - "httpMethod": "GET", - "parameterOrder": [ - "metricName" - ], - "response": { - "$ref": "LogMetric" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "metricName": { - "location": "path", - "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/metrics/[^/]+$" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}" - }, - "update": { - "response": { - "$ref": "LogMetric" - }, - "parameterOrder": [ - "metricName" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.write" - ], - "parameters": { - "metricName": { - "location": "path", - "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/metrics/[^/]+$" - } - }, - "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}", - "path": "v2beta1/{+metricName}", - "id": "logging.projects.metrics.update", - "description": "Creates or updates a logs-based metric.", - "request": { - "$ref": "LogMetric" - } - }, - "create": { - "request": { - "$ref": "LogMetric" - }, - "description": "Creates a logs-based metric.", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "LogMetric" - }, - "parameters": { - "parent": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.write" - ], - "flatPath": "v2beta1/projects/{projectsId}/metrics", - "id": "logging.projects.metrics.create", - "path": "v2beta1/{+parent}/metrics" - }, - "delete": { - "description": "Deletes a logs-based metric.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "metricName" - ], - "parameters": { - "metricName": { - "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/metrics/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.write" - ], - "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}", - "id": "logging.projects.metrics.delete", - "path": "v2beta1/{+metricName}" - } - } - } - } - }, - "billingAccounts": { - "resources": { - "logs": { - "methods": { - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "logName" - ], - "httpMethod": "DELETE", - "parameters": { - "logName": { - "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+/logs/[^/]+$", - "location": "path", - "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}", - "path": "v2beta1/{+logName}", - "id": "logging.billingAccounts.logs.delete", - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted." - }, - "list": { - "response": { - "$ref": "ListLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, - "parent": { - "required": true, - "type": "string", - "pattern": "^billingAccounts/[^/]+$", - "location": "path", - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n" - } - }, - "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs", - "path": "v2beta1/{+parent}/logs", - "id": "logging.billingAccounts.logs.list", - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." - } - } - } - } - }, - "monitoredResourceDescriptors": { - "methods": { - "list": { - "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging.", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListMonitoredResourceDescriptorsResponse" - }, - "parameters": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "flatPath": "v2beta1/monitoredResourceDescriptors", - "id": "logging.monitoredResourceDescriptors.list", - "path": "v2beta1/monitoredResourceDescriptors" - } - } - }, - "organizations": { - "resources": { - "logs": { - "methods": { - "delete": { - "path": "v2beta1/{+logName}", - "id": "logging.organizations.logs.delete", - "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "logName" - ], - "httpMethod": "DELETE", - "parameters": { - "logName": { - "location": "path", - "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+/logs/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/logging.admin" - ], - "flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}" - }, - "list": { - "response": { - "$ref": "ListLogsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/logging.admin", - "https://www.googleapis.com/auth/logging.read" - ], - "parameters": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", - "format": "int32" - }, - "parent": { - "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", - "required": true, - "type": "string", - "pattern": "^organizations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v2beta1/organizations/{organizationsId}/logs", - "path": "v2beta1/{+parent}/logs", - "id": "logging.organizations.logs.list", - "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." - } - } - } - } - } - }, - "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "location": "query", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "enumDescriptions": [ - "Responses with Content-Type of application/json", - "Media download with context-dependent Content-Type", - "Responses with Content-Type of application/x-protobuf" - ] - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - } - }, - "version": "v2beta1", - "baseUrl": "https://logging.googleapis.com/", - "servicePath": "", - "kind": "discovery#restDescription", - "description": "Writes log entries and manages your Stackdriver Logging configuration.", - "basePath": "", "id": "logging:v2beta1", "documentationLink": "https://cloud.google.com/logging/docs/", "revision": "20171229", "discoveryVersion": "v1", "version_module": true, "schemas": { - "LogEntry": { + "BucketOptions": { + "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", + "type": "object", "properties": { + "exponentialBuckets": { + "$ref": "Exponential", + "description": "The exponential buckets." + }, + "linearBuckets": { + "$ref": "Linear", + "description": "The linear bucket." + }, + "explicitBuckets": { + "$ref": "Explicit", + "description": "The explicit buckets." + } + }, + "id": "BucketOptions" + }, + "ListLogMetricsResponse": { + "type": "object", + "properties": { + "metrics": { + "description": "A list of logs-based metrics.", + "type": "array", + "items": { + "$ref": "LogMetric" + } + }, + "nextPageToken": { + "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", + "type": "string" + } + }, + "id": "ListLogMetricsResponse", + "description": "Result returned from ListLogMetrics." + }, + "MetricDescriptor": { + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.", + "type": "object", + "properties": { + "labels": { + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + }, + "name": { + "description": "The resource name of the metric descriptor.", + "type": "string" + }, + "type": { + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n", + "type": "string" + }, + "valueType": { + "enumDescriptions": [ + "Do not use this default value.", + "The value is a boolean. This value type can be used only if the metric kind is GAUGE.", + "The value is a signed 64-bit integer.", + "The value is a double precision floating point number.", + "The value is a text string. This value type can be used only if the metric kind is GAUGE.", + "The value is a Distribution.", + "The value is money." + ], + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "BOOL", + "INT64", + "DOUBLE", + "STRING", + "DISTRIBUTION", + "MONEY" + ], + "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.", + "type": "string" + }, + "metricKind": { + "type": "string", + "enumDescriptions": [ + "Do not use this default value.", + "An instantaneous measurement of a value.", + "The change in a value during a time interval.", + "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points." + ], + "enum": [ + "METRIC_KIND_UNSPECIFIED", + "GAUGE", + "DELTA", + "CUMULATIVE" + ], + "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported." + }, + "description": { + "description": "A detailed description of the metric, which can be used in documentation.", + "type": "string" + }, + "displayName": { + "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.", + "type": "string" + }, + "unit": { + "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.", + "type": "string" + } + }, + "id": "MetricDescriptor" + }, + "LogEntry": { + "description": "An individual entry in a log.", + "type": "object", + "properties": { + "sourceLocation": { + "$ref": "LogEntrySourceLocation", + "description": "Optional. Source code location information associated with the log entry, if any." + }, + "spanId": { + "description": "Optional. The span ID within the trace associated with the log entry. For Stackdriver Trace spans, this is the same format that the Stackdriver Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as \u003ccode\u003e\"000000000000004a\"\u003c/code\u003e.", + "type": "string" + }, + "timestamp": { + "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.", + "format": "google-datetime", + "type": "string" + }, + "receiveTimestamp": { + "description": "Output only. The time the log entry was received by Stackdriver Logging.", + "format": "google-datetime", + "type": "string" + }, + "logName": { + "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.", + "type": "string" + }, "resource": { "description": "Required. The monitored resource associated with this log entry. Example: a log entry that reports a database error would be associated with the monitored resource designating the particular database that reported the error.", "$ref": "MonitoredResource" @@ -749,40 +156,38 @@ "description": "The log entry payload, represented as a structure that is expressed as a JSON object.", "type": "object" }, - "operation": { - "$ref": "LogEntryOperation", - "description": "Optional. Information about an operation associated with the log entry, if applicable." - }, "insertId": { "description": "Optional. A unique identifier for the log entry. If you provide a value, then Stackdriver Logging considers other log entries in the same project, with the same timestamp, and with the same insert_id to be duplicates which can be removed. If omitted in new log entries, then Stackdriver Logging assigns its own unique identifier. The insert_id is also used to order log entries that have the same timestamp value.", "type": "string" }, + "operation": { + "$ref": "LogEntryOperation", + "description": "Optional. Information about an operation associated with the log entry, if applicable." + }, "textPayload": { - "description": "The log entry payload, represented as a Unicode string (UTF-8).", - "type": "string" + "type": "string", + "description": "The log entry payload, represented as a Unicode string (UTF-8)." }, "protoPayload": { - "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.", - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "description": "The log entry payload, represented as a protocol buffer. Some Google Cloud Platform services use this field for their log entry payloads.", + "type": "object" }, "labels": { + "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.", + "type": "object", "additionalProperties": { "type": "string" - }, - "description": "Optional. A set of user-defined (key, value) data that provides additional information about the log entry.", - "type": "object" + } }, "trace": { "description": "Optional. Resource name of the trace associated with the log entry, if any. If it contains a relative resource name, the name is assumed to be relative to //tracing.googleapis.com. Example: projects/my-projectid/traces/06796866738c859f2f19b7cfb3214824", "type": "string" }, "severity": { - "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.", - "type": "string", "enumDescriptions": [ "(0) The log entry has no assigned severity level.", "(100) Debug or trace information.", @@ -804,39 +209,99 @@ "CRITICAL", "ALERT", "EMERGENCY" - ] - }, - "sourceLocation": { - "description": "Optional. Source code location information associated with the log entry, if any.", - "$ref": "LogEntrySourceLocation" - }, - "spanId": { - "type": "string", - "description": "Optional. The span ID within the trace associated with the log entry. For Stackdriver Trace spans, this is the same format that the Stackdriver Trace API v2 uses: a 16-character hexadecimal encoding of an 8-byte array, such as \u003ccode\u003e\"000000000000004a\"\u003c/code\u003e." - }, - "receiveTimestamp": { - "description": "Output only. The time the log entry was received by Stackdriver Logging.", - "format": "google-datetime", - "type": "string" - }, - "timestamp": { - "description": "Optional. The time the event described by the log entry occurred. This time is used to compute the log entry's age and to enforce the logs retention period. If this field is omitted in a new log entry, then Stackdriver Logging assigns it the current time.Incoming log entries should have timestamps that are no more than the logs retention period in the past, and no more than 24 hours in the future. Log entries outside those time boundaries will not be available when calling entries.list, but those log entries can still be exported with LogSinks.", - "format": "google-datetime", - "type": "string" - }, - "logName": { - "description": "Required. The resource name of the log to which this log entry belongs:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\nA project number may optionally be used in place of PROJECT_ID. The project number is translated to its corresponding PROJECT_ID internally and the log_name field will contain PROJECT_ID in queries and exports.[LOG_ID] must be URL-encoded within log_name. Example: \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". [LOG_ID] must be less than 512 characters long and can only include the following characters: upper and lower case alphanumeric characters, forward-slash, underscore, hyphen, and period.For backward compatibility, if log_name begins with a forward-slash, such as /projects/..., then the log entry is ingested as usual but the forward-slash is removed. Listing the log entry will not show the leading slash and filtering for a log name with a leading slash will never return any results.", + ], + "description": "Optional. The severity of the log entry. The default value is LogSeverity.DEFAULT.", "type": "string" } }, - "id": "LogEntry", - "description": "An individual entry in a log.", - "type": "object" + "id": "LogEntry" }, "RequestLog": { "description": "Complete log information about a single HTTP request to an App Engine application.", "type": "object", "properties": { + "instanceIndex": { + "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.", + "format": "int32", + "type": "integer" + }, + "finished": { + "type": "boolean", + "description": "Whether this request is finished or active." + }, + "host": { + "description": "Internet host and port number of the resource being requested.", + "type": "string" + }, + "httpVersion": { + "description": "HTTP version of request. Example: \"HTTP/1.1\".", + "type": "string" + }, + "startTime": { + "description": "Time when the request started.", + "format": "google-datetime", + "type": "string" + }, + "latency": { + "description": "Latency of the request.", + "format": "google-duration", + "type": "string" + }, + "ip": { + "description": "Origin IP address.", + "type": "string" + }, + "appId": { + "type": "string", + "description": "Application that handled this request." + }, + "appEngineRelease": { + "description": "App Engine release version.", + "type": "string" + }, + "method": { + "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".", + "type": "string" + }, + "cost": { + "type": "number", + "description": "An indication of the relative cost of serving this request.", + "format": "double" + }, + "instanceId": { + "description": "An identifier for the instance that handled the request.", + "type": "string" + }, + "megaCycles": { + "description": "Number of CPU megacycles used to process request.", + "format": "int64", + "type": "string" + }, + "first": { + "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.", + "type": "boolean" + }, + "versionId": { + "description": "Version of the application that handled this request.", + "type": "string" + }, + "moduleId": { + "description": "Module of the application that handled this request.", + "type": "string" + }, + "endTime": { + "description": "Time when the request finished.", + "format": "google-datetime", + "type": "string" + }, + "userAgent": { + "description": "User agent that made the request.", + "type": "string" + }, + "wasLoadingRequest": { + "description": "Whether this was a loading request for the instance.", + "type": "boolean" + }, "sourceReference": { "description": "Source code for the application that handled this request. There can be more than one source reference per deployed application if source code is distributed among multiple repositories.", "type": "array", @@ -860,26 +325,21 @@ "$ref": "LogLine" } }, - "referrer": { - "description": "Referrer URL of request.", - "type": "string" - }, "taskQueueName": { "description": "Queue name of the request, in the case of an offline request.", "type": "string" }, - "requestId": { - "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier.", + "referrer": { + "description": "Referrer URL of request.", "type": "string" }, + "requestId": { + "type": "string", + "description": "Globally unique identifier for a request, which is based on the request start time. Request IDs for requests which started later will compare greater as strings than those for requests which started earlier." + }, "nickname": { - "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21.", - "type": "string" - }, - "status": { - "description": "HTTP response status code. Example: 200, 404.", - "format": "int32", - "type": "integer" + "type": "string", + "description": "The logged-in user who made the request.Most likely, this is the part of the user's email before the @ sign. The field value is the same for different requests from the same user, but different users can have similar names. This information is also available to the application via the App Engine Users API.This field will be populated starting with App Engine 1.9.21." }, "pendingTime": { "description": "Time this request spent in the pending request queue.", @@ -890,6 +350,11 @@ "description": "Contains the path and query portion of the URL that was requested. For example, if the URL was \"http://example.com/app?name=val\", the resource would be \"/app?name=val\". The fragment identifier, which is identified by the # character, is not included.", "type": "string" }, + "status": { + "description": "HTTP response status code. Example: 200, 404.", + "format": "int32", + "type": "integer" + }, "taskName": { "description": "Task name of the request, in the case of an offline request.", "type": "string" @@ -897,109 +362,77 @@ "urlMapEntry": { "description": "File or class that handled the request.", "type": "string" - }, - "instanceIndex": { - "type": "integer", - "description": "If the instance processing this request belongs to a manually scaled module, then this is the 0-based index of the instance. Otherwise, this value is -1.", - "format": "int32" - }, - "host": { - "description": "Internet host and port number of the resource being requested.", - "type": "string" - }, - "finished": { - "description": "Whether this request is finished or active.", - "type": "boolean" - }, - "httpVersion": { - "type": "string", - "description": "HTTP version of request. Example: \"HTTP/1.1\"." - }, - "startTime": { - "type": "string", - "description": "Time when the request started.", - "format": "google-datetime" - }, - "latency": { - "description": "Latency of the request.", - "format": "google-duration", - "type": "string" - }, - "ip": { - "description": "Origin IP address.", - "type": "string" - }, - "appId": { - "description": "Application that handled this request.", - "type": "string" - }, - "appEngineRelease": { - "description": "App Engine release version.", - "type": "string" - }, - "method": { - "description": "Request method. Example: \"GET\", \"HEAD\", \"PUT\", \"POST\", \"DELETE\".", - "type": "string" - }, - "cost": { - "description": "An indication of the relative cost of serving this request.", - "format": "double", - "type": "number" - }, - "instanceId": { - "description": "An identifier for the instance that handled the request.", - "type": "string" - }, - "megaCycles": { - "description": "Number of CPU megacycles used to process request.", - "format": "int64", - "type": "string" - }, - "first": { - "description": "Whether this is the first RequestLog entry for this request. If an active request has several RequestLog entries written to Stackdriver Logging, then this field will be set for one of them.", - "type": "boolean" - }, - "versionId": { - "type": "string", - "description": "Version of the application that handled this request." - }, - "moduleId": { - "type": "string", - "description": "Module of the application that handled this request." - }, - "endTime": { - "description": "Time when the request finished.", - "format": "google-datetime", - "type": "string" - }, - "userAgent": { - "description": "User agent that made the request.", - "type": "string" - }, - "wasLoadingRequest": { - "description": "Whether this was a loading request for the instance.", - "type": "boolean" } }, "id": "RequestLog" }, "ListMonitoredResourceDescriptorsResponse": { - "id": "ListMonitoredResourceDescriptorsResponse", "description": "Result returned from ListMonitoredResourceDescriptors.", "type": "object", "properties": { + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", + "type": "string" + }, "resourceDescriptors": { "description": "A list of resource descriptors.", "type": "array", "items": { "$ref": "MonitoredResourceDescriptor" } - }, - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", - "type": "string" } - } + }, + "id": "ListMonitoredResourceDescriptorsResponse" + }, + "LogMetric": { + "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.", + "type": "object", + "properties": { + "name": { + "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".", + "type": "string" + }, + "labelExtractors": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.", + "type": "object" + }, + "version": { + "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.", + "type": "string", + "enumDescriptions": [ + "Stackdriver Logging API v2.", + "Stackdriver Logging API v1." + ], + "enum": [ + "V2", + "V1" + ] + }, + "metricDescriptor": { + "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description.", + "$ref": "MetricDescriptor" + }, + "filter": { + "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.", + "type": "string" + }, + "description": { + "description": "Optional. A description of this metric, which is used in documentation.", + "type": "string" + }, + "valueExtractor": { + "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")", + "type": "string" + }, + "bucketOptions": { + "$ref": "BucketOptions", + "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values." + } + }, + "id": "LogMetric" }, "LogEntryOperation": { "description": "Additional information about a potentially long-running operation with which a log entry is associated.", @@ -1024,102 +457,28 @@ }, "id": "LogEntryOperation" }, - "LogMetric": { - "description": "Describes a logs-based metric. The value of the metric is the number of log entries that match a logs filter in a given time interval.Logs-based metric can also be used to extract values from logs and create a a distribution of the values. The distribution records the statistics of the extracted values along with an optional histogram of the values as specified by the bucket options.", - "type": "object", - "properties": { - "labelExtractors": { - "description": "Optional. A map from a label key string to an extractor expression which is used to extract data from a log entry field and assign as the label value. Each label key specified in the LabelDescriptor must have an associated extractor expression in this map. The syntax of the extractor expression is the same as for the value_extractor field.The extracted value is converted to the type defined in the label descriptor. If the either the extraction or the type conversion fails, the label will have a default value. The default value for a string label is an empty string, for an integer label its 0, and for a boolean label its false.Note that there are upper bounds on the maximum number of labels and the number of active time series that are allowed in a project.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "version": { - "enum": [ - "V2", - "V1" - ], - "description": "Deprecated. The API version that created or updated this metric. The v2 format is used by default and cannot be changed.", - "type": "string", - "enumDescriptions": [ - "Stackdriver Logging API v2.", - "Stackdriver Logging API v1." - ] - }, - "metricDescriptor": { - "$ref": "MetricDescriptor", - "description": "Optional. The metric descriptor associated with the logs-based metric. If unspecified, it uses a default metric descriptor with a DELTA metric kind, INT64 value type, with no labels and a unit of \"1\". Such a metric counts the number of log entries matching the filter expression.The name, type, and description fields in the metric_descriptor are output only, and is constructed using the name and description field in the LogMetric.To create a logs-based metric that records a distribution of log values, a DELTA metric kind with a DISTRIBUTION value type must be used along with a value_extractor expression in the LogMetric.Each label in the metric descriptor must have a matching label name as the key and an extractor expression as the value in the label_extractors map.The metric_kind and value_type fields in the metric_descriptor cannot be updated once initially configured. New labels can be added in the metric_descriptor, but existing labels cannot be modified except for their description." - }, - "filter": { - "description": "Required. An advanced logs filter which is used to match log entries. Example:\n\"resource.type=gae_app AND severity\u003e=ERROR\"\nThe maximum length of the filter is 20000 characters.", - "type": "string" - }, - "description": { - "description": "Optional. A description of this metric, which is used in documentation.", - "type": "string" - }, - "valueExtractor": { - "description": "Optional. A value_extractor is required when using a distribution logs-based metric to extract the values to record from a log entry. Two functions are supported for value extraction: EXTRACT(field) or REGEXP_EXTRACT(field, regex). The argument are: 1. field: The name of the log entry field from which the value is to be extracted. 2. regex: A regular expression using the Google RE2 syntax (https://github.com/google/re2/wiki/Syntax) with a single capture group to extract data from the specified log entry field. The value of the field is converted to a string before applying the regex. It is an error to specify a regex that does not include exactly one capture group.The result of the extraction must be convertible to a double type, as the distribution always records double values. If either the extraction or the conversion to double fails, then those values are not recorded in the distribution.Example: REGEXP_EXTRACT(jsonPayload.request, \".*quantity=(\\d+).*\")", - "type": "string" - }, - "bucketOptions": { - "$ref": "BucketOptions", - "description": "Optional. The bucket_options are required when the logs-based metric is using a DISTRIBUTION value type and it describes the bucket boundaries used to create a histogram of the extracted values." - }, - "name": { - "description": "Required. The client-assigned metric identifier. Examples: \"error_count\", \"nginx/requests\".Metric identifiers are limited to 100 characters and can include only the following characters: A-Z, a-z, 0-9, and the special characters _-.,+!*',()%/. The forward-slash character (/) denotes a hierarchy of name pieces, and it cannot be the first character of the name.The metric identifier in this field must not be URL-encoded (https://en.wikipedia.org/wiki/Percent-encoding). However, when the metric identifier appears as the [METRIC_ID] part of a metric_name API parameter, then the metric identifier must be URL-encoded. Example: \"projects/my-project/metrics/nginx%2Frequests\".", - "type": "string" - } - }, - "id": "LogMetric" - }, "MonitoredResource": { "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n", "type": "object", "properties": { + "type": { + "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.", + "type": "string" + }, "labels": { "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".", "type": "object", "additionalProperties": { "type": "string" } - }, - "type": { - "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.", - "type": "string" } }, "id": "MonitoredResource" }, "LogSink": { - "id": "LogSink", "description": "Describes a sink used to export log entries to one of the following destinations in any project: a Cloud Storage bucket, a BigQuery dataset, or a Cloud Pub/Sub topic. A logs filter controls which log entries are exported. The sink must be created within a project, organization, billing account, or folder.", "type": "object", "properties": { - "writerIdentity": { - "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.", - "type": "string" - }, - "startTime": { - "description": "Deprecated. This field is ignored when creating or updating sinks.", - "format": "google-datetime", - "type": "string" - }, - "outputVersionFormat": { - "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.", - "type": "string", - "enumDescriptions": [ - "An unspecified format version that will default to V2.", - "LogEntry version 2 format.", - "LogEntry version 1 format." - ], - "enum": [ - "VERSION_FORMAT_UNSPECIFIED", - "V2", - "V1" - ] - }, "name": { "description": "Required. The client-assigned sink identifier, unique within the project. Example: \"my-syslog-errors-to-pubsub\". Sink identifiers are limited to 100 characters and can include only the following characters: upper and lower-case alphanumeric characters, underscores, hyphens, and periods.", "type": "string" @@ -1140,8 +499,32 @@ "description": "Deprecated. This field is ignored when creating or updating sinks.", "format": "google-datetime", "type": "string" + }, + "writerIdentity": { + "description": "Output only. An IAM identity—a service account or group—under which Stackdriver Logging writes the exported log entries to the sink's destination. This field is set by sinks.create and sinks.update, based on the setting of unique_writer_identity in those methods.Until you grant this identity write-access to the destination, log entry exports from this sink will fail. For more information, see Granting access for a resource. Consult the destination service's documentation to determine the appropriate IAM roles to assign to the identity.", + "type": "string" + }, + "startTime": { + "description": "Deprecated. This field is ignored when creating or updating sinks.", + "format": "google-datetime", + "type": "string" + }, + "outputVersionFormat": { + "enum": [ + "VERSION_FORMAT_UNSPECIFIED", + "V2", + "V1" + ], + "description": "Deprecated. The log entry format to use for this sink's exported log entries. The v2 format is used by default and cannot be changed.", + "type": "string", + "enumDescriptions": [ + "An unspecified format version that will default to V2.", + "LogEntry version 2 format.", + "LogEntry version 1 format." + ] } - } + }, + "id": "LogSink" }, "ListLogsResponse": { "description": "Result returned from ListLogs.", @@ -1161,50 +544,18 @@ }, "id": "ListLogsResponse" }, - "ListSinksResponse": { - "id": "ListSinksResponse", - "description": "Result returned from ListSinks.", - "type": "object", - "properties": { - "sinks": { - "description": "A list of sinks.", - "type": "array", - "items": { - "$ref": "LogSink" - } - }, - "nextPageToken": { - "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", - "type": "string" - } - } - }, "HttpRequest": { - "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message.", "type": "object", "properties": { - "cacheValidatedWithOriginServer": { - "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.", - "type": "boolean" - }, - "status": { - "description": "The response code indicating the status of response. Examples: 200, 404.", - "format": "int32", - "type": "integer" - }, - "referer": { - "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", - "type": "string" - }, - "userAgent": { - "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\".", - "type": "string" - }, "latency": { "description": "The request processing latency on the server, from the time the request was received until the response was sent.", "format": "google-duration", "type": "string" }, + "userAgent": { + "type": "string", + "description": "The user agent sent by the client. Example: \"Mozilla/4.0 (compatible; MSIE 6.0; Windows 98; Q312461; .NET CLR 1.0.3705)\"." + }, "cacheFillBytes": { "description": "The number of HTTP response bytes inserted into cache. Set only when a cache fill was attempted.", "format": "int64", @@ -1224,22 +575,22 @@ "type": "string" }, "requestSize": { - "type": "string", "description": "The size of the HTTP request message in bytes, including the request headers and the request body.", - "format": "int64" + "format": "int64", + "type": "string" }, "requestUrl": { "description": "The scheme (http, https), the host name, the path and the query portion of the URL that was requested. Example: \"http://example.com/some/info?color=red\".", "type": "string" }, - "serverIp": { - "type": "string", - "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to." - }, "remoteIp": { "description": "The IP address (IPv4 or IPv6) of the client that issued the HTTP request. Examples: \"192.168.1.1\", \"FE80::0202:B3FF:FE1E:8329\".", "type": "string" }, + "serverIp": { + "description": "The IP address (IPv4 or IPv6) of the origin server that the request was sent to.", + "type": "string" + }, "cacheLookup": { "description": "Whether or not a cache lookup was attempted.", "type": "boolean" @@ -1247,18 +598,46 @@ "cacheHit": { "description": "Whether or not an entity was served from cache (with or without validation).", "type": "boolean" + }, + "cacheValidatedWithOriginServer": { + "description": "Whether or not the response was validated with the origin server before being served from cache. This field is only meaningful if cache_hit is True.", + "type": "boolean" + }, + "status": { + "description": "The response code indicating the status of response. Examples: 200, 404.", + "format": "int32", + "type": "integer" + }, + "referer": { + "description": "The referer URL of the request, as defined in HTTP/1.1 Header Field Definitions (http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).", + "type": "string" } }, - "id": "HttpRequest" + "id": "HttpRequest", + "description": "A common proto for logging HTTP requests. Only contains semantics defined by the HTTP specification. Product-specific logging information MUST be defined in a separate message." + }, + "ListSinksResponse": { + "description": "Result returned from ListSinks.", + "type": "object", + "properties": { + "sinks": { + "description": "A list of sinks.", + "type": "array", + "items": { + "$ref": "LogSink" + } + }, + "nextPageToken": { + "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call the same method again using the value of nextPageToken as pageToken.", + "type": "string" + } + }, + "id": "ListSinksResponse" }, "MonitoredResourceDescriptor": { "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.", "type": "object", "properties": { - "type": { - "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.", - "type": "string" - }, "labels": { "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".", "type": "array", @@ -1277,14 +656,22 @@ "description": { "description": "Optional. A detailed description of the monitored resource type that might be used in documentation.", "type": "string" + }, + "type": { + "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.", + "type": "string" } }, "id": "MonitoredResourceDescriptor" }, "LogEntrySourceLocation": { - "description": "Additional information about the source code location that produced the log entry.", "type": "object", "properties": { + "line": { + "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", + "format": "int64", + "type": "string" + }, "file": { "description": "Optional. Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", "type": "string" @@ -1292,43 +679,38 @@ "function": { "description": "Optional. Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information may be used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).", "type": "string" - }, - "line": { - "description": "Optional. Line within the source file. 1-based; 0 indicates no line number available.", - "format": "int64", - "type": "string" } }, - "id": "LogEntrySourceLocation" + "id": "LogEntrySourceLocation", + "description": "Additional information about the source code location that produced the log entry." }, "ListLogEntriesResponse": { "description": "Result returned from ListLogEntries.", "type": "object", "properties": { - "nextPageToken": { - "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.", - "type": "string" - }, "entries": { "description": "A list of log entries. If entries is empty, nextPageToken may still be returned, indicating that more entries may exist. See nextPageToken for more information.", "type": "array", "items": { "$ref": "LogEntry" } + }, + "nextPageToken": { + "description": "If there might be more results than those appearing in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.If a value for next_page_token appears and the entries field is empty, it means that the search found no log entries so far but it did not have time to search all the possible log entries. Retry the method with this value for page_token to continue the search. Alternatively, consider speeding up the search by changing your filter to specify a single log name or resource type, or to narrow the time range of the search.", + "type": "string" } }, "id": "ListLogEntriesResponse" }, "LogLine": { + "id": "LogLine", + "description": "Application log line emitted while processing a request.", + "type": "object", "properties": { - "sourceLocation": { - "$ref": "SourceLocation", - "description": "Where in the source code this log message was written." - }, "time": { - "type": "string", "description": "Approximate time when this log entry was made.", - "format": "google-datetime" + "format": "google-datetime", + "type": "string" }, "severity": { "type": "string", @@ -1359,30 +741,31 @@ "logMessage": { "description": "App-provided log message.", "type": "string" + }, + "sourceLocation": { + "description": "Where in the source code this log message was written.", + "$ref": "SourceLocation" } - }, - "id": "LogLine", - "description": "Application log line emitted while processing a request.", - "type": "object" + } }, "Linear": { "description": "Specifies a linear sequence of buckets that all have the same width (except overflow and underflow). Each bucket represents a constant absolute uncertainty on the specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): offset + (width * i). Lower bound (1 \u003c= i \u003c N): offset + (width * (i - 1)).", "type": "object", "properties": { + "offset": { + "description": "Lower bound of the first bucket.", + "format": "double", + "type": "number" + }, "numFiniteBuckets": { "description": "Must be greater than 0.", "format": "int32", "type": "integer" }, "width": { + "type": "number", "description": "Must be greater than 0.", - "format": "double", - "type": "number" - }, - "offset": { - "description": "Lower bound of the first bucket.", - "format": "double", - "type": "number" + "format": "double" } }, "id": "Linear" @@ -1394,9 +777,12 @@ "id": "Empty" }, "SourceLocation": { - "description": "Specifies a location in a source code file.", - "type": "object", "properties": { + "line": { + "description": "Line within the source file.", + "format": "int64", + "type": "string" + }, "file": { "description": "Source file name. Depending on the runtime environment, this might be a simple name or a fully-qualified name.", "type": "string" @@ -1404,29 +790,16 @@ "functionName": { "description": "Human-readable name of the function or method being invoked, with optional context such as the class or package name. This information is used in contexts such as the logs viewer, where a file and line number are less meaningful. The format can vary by language. For example: qual.if.ied.Class.method (Java), dir/package.func (Go), function (Python).", "type": "string" - }, - "line": { - "description": "Line within the source file.", - "format": "int64", - "type": "string" } }, - "id": "SourceLocation" + "id": "SourceLocation", + "description": "Specifies a location in a source code file.", + "type": "object" }, "ListLogEntriesRequest": { - "id": "ListLogEntriesRequest", "description": "The parameters to ListLogEntries.", "type": "object", "properties": { - "pageToken": { - "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.", - "type": "string" - }, - "pageSize": { - "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.", - "format": "int32", - "type": "integer" - }, "orderBy": { "description": "Optional. How the results should be sorted. Presently, the only permitted values are \"timestamp asc\" (default) and \"timestamp desc\". The first option returns entries in order of increasing values of LogEntry.timestamp (oldest first), and the second option returns entries in order of decreasing timestamps (newest first). Entries with equal timestamps are returned in order of their insert_id values.", "type": "string" @@ -1448,18 +821,28 @@ "filter": { "description": "Optional. A filter that chooses which log entries to return. See Advanced Logs Filters. Only log entries that match the filter are returned. An empty filter matches all log entries in the resources listed in resource_names. Referencing a parent resource that is not listed in resource_names will cause the filter to return no results. The maximum length of the filter is 20000 characters.", "type": "string" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. page_token must be the value of next_page_token from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of next_page_token in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" } - } + }, + "id": "ListLogEntriesRequest" }, "Explicit": { "properties": { "bounds": { - "description": "The values must be monotonically increasing.", "type": "array", "items": { "format": "double", "type": "number" - } + }, + "description": "The values must be monotonically increasing." } }, "id": "Explicit", @@ -1467,8 +850,6 @@ "type": "object" }, "SourceReference": { - "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", - "type": "object", "properties": { "revisionId": { "description": "The canonical and persistent identifier of the deployed revision. Example (git): \"0035781c50ec7aa23385dc841529ce8a4b70db1b\"", @@ -1479,7 +860,9 @@ "type": "string" } }, - "id": "SourceReference" + "id": "SourceReference", + "description": "A reference to a particular snapshot of the source tree used to build and deploy an application.", + "type": "object" }, "WriteLogEntriesResponse": { "description": "Result returned from WriteLogEntries. empty", @@ -1488,11 +871,13 @@ "id": "WriteLogEntriesResponse" }, "Exponential": { + "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).", + "type": "object", "properties": { "growthFactor": { - "type": "number", "description": "Must be greater than 1.", - "format": "double" + "format": "double", + "type": "number" }, "scale": { "description": "Must be greater than 0.", @@ -1505,15 +890,26 @@ "type": "integer" } }, - "id": "Exponential", - "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).", - "type": "object" + "id": "Exponential" }, "WriteLogEntriesRequest": { + "description": "The parameters to WriteLogEntries.", + "type": "object", "properties": { + "labels": { + "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "resource": { + "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.", + "$ref": "MonitoredResource" + }, "logName": { - "type": "string", - "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry." + "description": "Optional. A default log resource name that is assigned to all log entries in entries that do not specify a value for log_name:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\" or \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "type": "string" }, "entries": { "description": "Required. The log entries to send to Stackdriver Logging. The order of log entries in this list does not matter. Values supplied in this method's log_name, resource, and labels fields are copied into those log entries in this list that do not include values for their corresponding fields. For more information, see the LogEntry type.If the timestamp or insert_id fields are missing in log entries, then this method supplies the current time or a unique identifier, respectively. The supplied values are chosen so that, among the log entries that did not supply their own values, the entries earlier in the list will sort before the entries later in the list. See the entries.list method.Log entries with timestamps that are more than the logs retention period in the past or more than 24 hours in the future will not be available when calling entries.list. However, those log entries can still be exported with LogSinks.To improve throughput and to avoid exceeding the quota limit for calls to entries.write, you should try to include several log entries in this list, rather than calling this method for each individual log entry.", @@ -1525,22 +921,9 @@ "partialSuccess": { "description": "Optional. Whether valid entries should be written even if some other entries fail due to INVALID_ARGUMENT or PERMISSION_DENIED errors. If any entry is not written, then the response status is the error associated with one of the failed entries and the response includes error details keyed by the entries' zero-based index in the entries.write method.", "type": "boolean" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. Default labels that are added to the labels field of all log entries in entries. If a log entry already has a label with the same key as a label in this parameter, then the log entry's label is not changed. See LogEntry.", - "type": "object" - }, - "resource": { - "description": "Optional. A default monitored resource object that is assigned to all log entries in entries that do not specify a value for resource. Example:\n{ \"type\": \"gce_instance\",\n \"labels\": {\n \"zone\": \"us-central1-a\", \"instance_id\": \"00000000000000000000\" }}\nSee LogEntry.", - "$ref": "MonitoredResource" } }, - "id": "WriteLogEntriesRequest", - "description": "The parameters to WriteLogEntries.", - "type": "object" + "id": "WriteLogEntriesRequest" }, "LabelDescriptor": { "description": "A description of a label.", @@ -1570,120 +953,11 @@ } }, "id": "LabelDescriptor" - }, - "BucketOptions": { - "type": "object", - "properties": { - "exponentialBuckets": { - "$ref": "Exponential", - "description": "The exponential buckets." - }, - "linearBuckets": { - "$ref": "Linear", - "description": "The linear bucket." - }, - "explicitBuckets": { - "$ref": "Explicit", - "description": "The explicit buckets." - } - }, - "id": "BucketOptions", - "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite." - }, - "ListLogMetricsResponse": { - "description": "Result returned from ListLogMetrics.", - "type": "object", - "properties": { - "metrics": { - "type": "array", - "items": { - "$ref": "LogMetric" - }, - "description": "A list of logs-based metrics." - }, - "nextPageToken": { - "description": "If there might be more results than appear in this response, then nextPageToken is included. To get the next set of results, call this method again using the value of nextPageToken as pageToken.", - "type": "string" - } - }, - "id": "ListLogMetricsResponse" - }, - "MetricDescriptor": { - "properties": { - "name": { - "description": "The resource name of the metric descriptor.", - "type": "string" - }, - "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n", - "type": "string" - }, - "valueType": { - "type": "string", - "enumDescriptions": [ - "Do not use this default value.", - "The value is a boolean. This value type can be used only if the metric kind is GAUGE.", - "The value is a signed 64-bit integer.", - "The value is a double precision floating point number.", - "The value is a text string. This value type can be used only if the metric kind is GAUGE.", - "The value is a Distribution.", - "The value is money." - ], - "enum": [ - "VALUE_TYPE_UNSPECIFIED", - "BOOL", - "INT64", - "DOUBLE", - "STRING", - "DISTRIBUTION", - "MONEY" - ], - "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported." - }, - "metricKind": { - "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.", - "type": "string", - "enumDescriptions": [ - "Do not use this default value.", - "An instantaneous measurement of a value.", - "The change in a value during a time interval.", - "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points." - ], - "enum": [ - "METRIC_KIND_UNSPECIFIED", - "GAUGE", - "DELTA", - "CUMULATIVE" - ] - }, - "displayName": { - "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.", - "type": "string" - }, - "description": { - "description": "A detailed description of the metric, which can be used in documentation.", - "type": "string" - }, - "unit": { - "description": "The unit in which the metric value is reported. It is only applicable if the value_type is INT64, DOUBLE, or DISTRIBUTION. The supported units are a subset of The Unified Code for Units of Measure (http://unitsofmeasure.org/ucum.html) standard:Basic units (UNIT)\nbit bit\nBy byte\ns second\nmin minute\nh hour\nd dayPrefixes (PREFIX)\nk kilo (10**3)\nM mega (10**6)\nG giga (10**9)\nT tera (10**12)\nP peta (10**15)\nE exa (10**18)\nZ zetta (10**21)\nY yotta (10**24)\nm milli (10**-3)\nu micro (10**-6)\nn nano (10**-9)\np pico (10**-12)\nf femto (10**-15)\na atto (10**-18)\nz zepto (10**-21)\ny yocto (10**-24)\nKi kibi (2**10)\nMi mebi (2**20)\nGi gibi (2**30)\nTi tebi (2**40)GrammarThe grammar includes the dimensionless unit 1, such as 1/s.The grammar also includes these connectors:\n/ division (as an infix operator, e.g. 1/s).\n. multiplication (as an infix operator, e.g. GBy.d)The grammar for a unit is as follows:\nExpression = Component { \".\" Component } { \"/\" Component } ;\n\nComponent = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\nAnnotation = \"{\" NAME \"}\" ;\nNotes:\nAnnotation is just a comment if it follows a UNIT and is equivalent to 1 if it is used alone. For examples, {requests}/s == 1/s, By{transmitted}/s == By/s.\nNAME is a sequence of non-blank printable ASCII characters not containing '{' or '}'.", - "type": "string" - }, - "labels": { - "type": "array", - "items": { - "$ref": "LabelDescriptor" - }, - "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed." - } - }, - "id": "MetricDescriptor", - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.", - "type": "object" } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "canonicalName": "Logging", @@ -1711,5 +985,731 @@ "rootUrl": "https://logging.googleapis.com/", "ownerDomain": "google.com", "name": "logging", - "batchPath": "batch" + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Stackdriver Logging API", + "ownerName": "Google", + "resources": { + "monitoredResourceDescriptors": { + "methods": { + "list": { + "httpMethod": "GET", + "parameterOrder": [], + "response": { + "$ref": "ListMonitoredResourceDescriptorsResponse" + }, + "parameters": { + "pageToken": { + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2beta1/monitoredResourceDescriptors", + "id": "logging.monitoredResourceDescriptors.list", + "path": "v2beta1/monitoredResourceDescriptors", + "description": "Lists the descriptors for monitored resource types used by Stackdriver Logging." + } + } + }, + "organizations": { + "resources": { + "logs": { + "methods": { + "delete": { + "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", + "httpMethod": "DELETE", + "parameterOrder": [ + "logName" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "logName": { + "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "required": true, + "type": "string", + "pattern": "^organizations/[^/]+/logs/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/organizations/{organizationsId}/logs/{logsId}", + "id": "logging.organizations.logs.delete", + "path": "v2beta1/{+logName}" + }, + "list": { + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", + "response": { + "$ref": "ListLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "parent": { + "pattern": "^organizations/[^/]+$", + "location": "path", + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2beta1/organizations/{organizationsId}/logs", + "path": "v2beta1/{+parent}/logs", + "id": "logging.organizations.logs.list" + } + } + } + } + }, + "entries": { + "methods": { + "list": { + "request": { + "$ref": "ListLogEntriesRequest" + }, + "description": "Lists log entries. Use this method to retrieve log entries from Stackdriver Logging. For ways to export log entries, see Exporting Logs.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "ListLogEntriesResponse" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2beta1/entries:list", + "id": "logging.entries.list", + "path": "v2beta1/entries:list" + }, + "write": { + "request": { + "$ref": "WriteLogEntriesRequest" + }, + "description": "Log entry resourcesWrites log entries to Stackdriver Logging. This API method is the only way to send log entries to Stackdriver Logging. This method is used, directly or indirectly, by the Stackdriver Logging agent (fluentd) and all logging libraries configured to use Stackdriver Logging.", + "response": { + "$ref": "WriteLogEntriesResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.write" + ], + "flatPath": "v2beta1/entries:write", + "path": "v2beta1/entries:write", + "id": "logging.entries.write" + } + } + }, + "projects": { + "resources": { + "metrics": { + "methods": { + "delete": { + "description": "Deletes a logs-based metric.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "metricName" + ], + "httpMethod": "DELETE", + "parameters": { + "metricName": { + "pattern": "^projects/[^/]+/metrics/[^/]+$", + "location": "path", + "description": "The resource name of the metric to delete:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.write" + ], + "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}", + "path": "v2beta1/{+metricName}", + "id": "logging.projects.metrics.delete" + }, + "list": { + "response": { + "$ref": "ListLogMetricsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The name of the project containing the metrics:\n\"projects/[PROJECT_ID]\"\n" + }, + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2beta1/projects/{projectsId}/metrics", + "path": "v2beta1/{+parent}/metrics", + "id": "logging.projects.metrics.list", + "description": "Lists logs-based metrics." + }, + "get": { + "response": { + "$ref": "LogMetric" + }, + "parameterOrder": [ + "metricName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "metricName": { + "location": "path", + "description": "The resource name of the desired metric:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/metrics/[^/]+$" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}", + "path": "v2beta1/{+metricName}", + "id": "logging.projects.metrics.get", + "description": "Gets a logs-based metric." + }, + "update": { + "path": "v2beta1/{+metricName}", + "id": "logging.projects.metrics.update", + "request": { + "$ref": "LogMetric" + }, + "description": "Creates or updates a logs-based metric.", + "response": { + "$ref": "LogMetric" + }, + "parameterOrder": [ + "metricName" + ], + "httpMethod": "PUT", + "parameters": { + "metricName": { + "description": "The resource name of the metric to update:\n\"projects/[PROJECT_ID]/metrics/[METRIC_ID]\"\nThe updated metric must be provided in the request and it's name field must be the same as [METRIC_ID] If the metric does not exist in [PROJECT_ID], then a new metric is created.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/metrics/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.write" + ], + "flatPath": "v2beta1/projects/{projectsId}/metrics/{metricsId}" + }, + "create": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.write" + ], + "parameters": { + "parent": { + "description": "The resource name of the project in which to create the metric:\n\"projects/[PROJECT_ID]\"\nThe new metric must be provided in the request.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/metrics", + "path": "v2beta1/{+parent}/metrics", + "id": "logging.projects.metrics.create", + "description": "Creates a logs-based metric.", + "request": { + "$ref": "LogMetric" + }, + "response": { + "$ref": "LogMetric" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST" + } + } + }, + "logs": { + "methods": { + "list": { + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed.", + "response": { + "$ref": "ListLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "type": "integer", + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32" + }, + "parent": { + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "flatPath": "v2beta1/projects/{projectsId}/logs", + "path": "v2beta1/{+parent}/logs", + "id": "logging.projects.logs.list" + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "logName" + ], + "httpMethod": "DELETE", + "parameters": { + "logName": { + "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/logs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2beta1/projects/{projectsId}/logs/{logsId}", + "path": "v2beta1/{+logName}", + "id": "logging.projects.logs.delete", + "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted." + } + } + }, + "sinks": { + "methods": { + "delete": { + "description": "Deletes a sink. If the sink has a unique writer_identity, then that service account is also deleted.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "sinkName": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/sinks/[^/]+$", + "location": "path", + "description": "Required. The full resource name of the sink to delete, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\"." + } + }, + "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}", + "path": "v2beta1/{+sinkName}", + "id": "logging.projects.sinks.delete" + }, + "list": { + "description": "Lists sinks.", + "response": { + "$ref": "ListSinksResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "pageToken": { + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + }, + "parent": { + "description": "Required. The parent resource whose sinks are to be listed:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/sinks", + "path": "v2beta1/{+parent}/sinks", + "id": "logging.projects.sinks.list" + }, + "get": { + "description": "Gets a sink.", + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "sinkName": { + "location": "path", + "description": "Required. The resource name of the sink:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/sinks/[^/]+$" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}", + "path": "v2beta1/{+sinkName}", + "id": "logging.projects.sinks.get" + }, + "update": { + "request": { + "$ref": "LogSink" + }, + "description": "Updates a sink. This method replaces the following fields in the existing sink with values from the new sink: destination, and filter. The updated sink might also have a new writer_identity; see the unique_writer_identity field.", + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "sinkName" + ], + "httpMethod": "PUT", + "parameters": { + "sinkName": { + "location": "path", + "description": "Required. The full resource name of the sink to update, including the parent resource and the sink identifier:\n\"projects/[PROJECT_ID]/sinks/[SINK_ID]\"\n\"organizations/[ORGANIZATION_ID]/sinks/[SINK_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/sinks/[SINK_ID]\"\n\"folders/[FOLDER_ID]/sinks/[SINK_ID]\"\nExample: \"projects/my-project-id/sinks/my-sink-id\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/sinks/[^/]+$" + }, + "uniqueWriterIdentity": { + "description": "Optional. See sinks.create for a description of this field. When updating a sink, the effect of this field on the value of writer_identity in the updated sink depends on both the old and new values of this field:\nIf the old and new values of this field are both false or both true, then there is no change to the sink's writer_identity.\nIf the old value is false and the new value is true, then writer_identity is changed to a unique service account.\nIt is an error if the old value is true and the new value is set to false or defaulted to false.", + "type": "boolean", + "location": "query" + }, + "updateMask": { + "description": "Optional. Field mask that specifies the fields in sink that need an update. A sink field will be overwritten if, and only if, it is in the update mask. name and output only fields cannot be updated.An empty updateMask is temporarily treated as using the following mask for backwards compatibility purposes: destination,filter,includeChildren At some point in the future, behavior will be removed and specifying an empty updateMask will be an error.For a detailed FieldMask definition, see https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmaskExample: updateMask=filter.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "flatPath": "v2beta1/projects/{projectsId}/sinks/{sinksId}", + "path": "v2beta1/{+sinkName}", + "id": "logging.projects.sinks.update" + }, + "create": { + "path": "v2beta1/{+parent}/sinks", + "id": "logging.projects.sinks.create", + "description": "Creates a sink that exports specified log entries to a destination. The export of newly-ingested log entries begins immediately, unless the sink's writer_identity is not permitted to write to the destination. A sink can export log entries only from the resource owning the sink.", + "request": { + "$ref": "LogSink" + }, + "response": { + "$ref": "LogSink" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "parent": { + "description": "Required. The resource in which to create the sink:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\nExamples: \"projects/my-logging-project\", \"organizations/123456789\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "uniqueWriterIdentity": { + "location": "query", + "description": "Optional. Determines the kind of IAM identity returned as writer_identity in the new sink. If this value is omitted or set to false, and if the sink's parent is a project, then the value returned as writer_identity is the same group or service account used by Stackdriver Logging before the addition of writer identities to this API. The sink's destination must be in the same project as the sink itself.If this field is set to true, or if the sink is owned by a non-project resource such as an organization, then the value of writer_identity will be a unique service account used only for exports from the new sink. For more information, see writer_identity in LogSink.", + "type": "boolean" + } + }, + "flatPath": "v2beta1/projects/{projectsId}/sinks" + } + } + } + } + }, + "billingAccounts": { + "resources": { + "logs": { + "methods": { + "delete": { + "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs/{logsId}", + "path": "v2beta1/{+logName}", + "id": "logging.billingAccounts.logs.delete", + "description": "Deletes all the log entries in a log. The log reappears if it receives new entries. Log entries written shortly before the delete operation might not be deleted.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "logName" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/logging.admin" + ], + "parameters": { + "logName": { + "pattern": "^billingAccounts/[^/]+/logs/[^/]+$", + "location": "path", + "description": "Required. The resource name of the log to delete:\n\"projects/[PROJECT_ID]/logs/[LOG_ID]\"\n\"organizations/[ORGANIZATION_ID]/logs/[LOG_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]/logs/[LOG_ID]\"\n\"folders/[FOLDER_ID]/logs/[LOG_ID]\"\n[LOG_ID] must be URL-encoded. For example, \"projects/my-project-id/logs/syslog\", \"organizations/1234567890/logs/cloudresourcemanager.googleapis.com%2Factivity\". For more information about log names, see LogEntry.", + "required": true, + "type": "string" + } + } + }, + "list": { + "response": { + "$ref": "ListLogsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/logging.admin", + "https://www.googleapis.com/auth/logging.read" + ], + "parameters": { + "parent": { + "description": "Required. The resource name that owns the logs:\n\"projects/[PROJECT_ID]\"\n\"organizations/[ORGANIZATION_ID]\"\n\"billingAccounts/[BILLING_ACCOUNT_ID]\"\n\"folders/[FOLDER_ID]\"\n", + "required": true, + "type": "string", + "pattern": "^billingAccounts/[^/]+$", + "location": "path" + }, + "pageToken": { + "type": "string", + "location": "query", + "description": "Optional. If present, then retrieve the next batch of results from the preceding call to this method. pageToken must be the value of nextPageToken from the previous response. The values of other method parameters should be identical to those in the previous call." + }, + "pageSize": { + "location": "query", + "description": "Optional. The maximum number of results to return from this request. Non-positive values are ignored. The presence of nextPageToken in the response indicates that more results might be available.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v2beta1/billingAccounts/{billingAccountsId}/logs", + "path": "v2beta1/{+parent}/logs", + "id": "logging.billingAccounts.logs.list", + "description": "Lists the logs in projects, organizations, folders, or billing accounts. Only logs that have entries are listed." + } + } + } + } + } + }, + "parameters": { + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "type": "boolean", + "default": "true", + "location": "query", + "description": "Pretty-print response." + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "type": "boolean", + "default": "true", + "location": "query", + "description": "Returns response with indentations and line breaks." + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + } + }, + "version": "v2beta1", + "baseUrl": "https://logging.googleapis.com/", + "servicePath": "", + "description": "Writes log entries and manages your Stackdriver Logging configuration.", + "kind": "discovery#restDescription", + "basePath": "" }
diff --git a/manufacturers/v1/manufacturers-api.json b/manufacturers/v1/manufacturers-api.json index 99867e6..e7012a0 100644 --- a/manufacturers/v1/manufacturers-api.json +++ b/manufacturers/v1/manufacturers-api.json
@@ -1,8 +1,255 @@ { + "resources": { + "accounts": { + "resources": { + "products": { + "methods": { + "update": { + "response": { + "$ref": "Product" + }, + "parameterOrder": [ + "parent", + "name" + ], + "httpMethod": "PUT", + "parameters": { + "parent": { + "pattern": "^accounts/[^/]+$", + "location": "path", + "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "required": true, + "type": "string" + }, + "name": { + "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/manufacturercenter" + ], + "flatPath": "v1/accounts/{accountsId}/products/{productsId}", + "path": "v1/{+parent}/products/{+name}", + "id": "manufacturers.accounts.products.update", + "request": { + "$ref": "Product" + }, + "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product." + }, + "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "parent", + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "parent": { + "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "required": true, + "type": "string", + "pattern": "^accounts/[^/]+$", + "location": "path" + }, + "name": { + "pattern": "^[^/]+$", + "location": "path", + "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/manufacturercenter" + ], + "flatPath": "v1/accounts/{accountsId}/products/{productsId}", + "id": "manufacturers.accounts.products.delete", + "path": "v1/{+parent}/products/{+name}", + "description": "Deletes the product from a Manufacturer Center account." + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListProductsResponse" + }, + "parameters": { + "pageToken": { + "description": "The token returned by the previous request.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Maximum number of product statuses to return in the response, used for\npaging.", + "format": "int32", + "type": "integer" + }, + "parent": { + "pattern": "^accounts/[^/]+$", + "location": "path", + "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/manufacturercenter" + ], + "flatPath": "v1/accounts/{accountsId}/products", + "id": "manufacturers.accounts.products.list", + "path": "v1/{+parent}/products", + "description": "Lists all the products in a Manufacturer Center account." + }, + "get": { + "path": "v1/{+parent}/products/{+name}", + "id": "manufacturers.accounts.products.get", + "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear.", + "response": { + "$ref": "Product" + }, + "parameterOrder": [ + "parent", + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + }, + "parent": { + "pattern": "^accounts/[^/]+$", + "location": "path", + "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/manufacturercenter" + ], + "flatPath": "v1/accounts/{accountsId}/products/{productsId}" + } + } + } + } + } + }, + "parameters": { + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://manufacturers.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Public API for managing Manufacturer Center related data.", + "servicePath": "", + "basePath": "", + "id": "manufacturers:v1", + "documentationLink": "https://developers.google.com/manufacturers/", + "revision": "20171207", "discoveryVersion": "v1", "version_module": true, "schemas": { "Count": { + "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.", + "type": "object", "properties": { "value": { "description": "The numeric value of the number of products in a package.", @@ -14,14 +261,38 @@ "type": "string" } }, - "id": "Count", - "description": "The number of products in a single package. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#count.", - "type": "object" + "id": "Count" }, "Product": { - "description": "Product data.", - "type": "object", "properties": { + "productId": { + "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly", + "type": "string" + }, + "uploadedAttributes": { + "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.", + "$ref": "Attributes" + }, + "parent": { + "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly", + "type": "string" + }, + "manuallyProvidedAttributes": { + "$ref": "Attributes", + "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly" + }, + "contentLanguage": { + "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly", + "type": "string" + }, + "targetCountry": { + "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly", + "type": "string" + }, + "name": { + "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly", + "type": "string" + }, "issues": { "description": "A server-generated list of issues associated with the product.\n@OutputOnly", "type": "array", @@ -39,41 +310,13 @@ "finalAttributes": { "description": "Final attributes of the product. The final attributes are obtained by\noverriding the uploaded attributes with the manually provided and deleted\nattributes. Google systems only process, evaluate, review, and/or use final\nattributes.\n@OutputOnly", "$ref": "Attributes" - }, - "productId": { - "description": "The ID of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly", - "type": "string" - }, - "uploadedAttributes": { - "description": "Attributes of the product uploaded via the Manufacturer Center API or via\nfeeds.", - "$ref": "Attributes" - }, - "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.\n@OutputOnly", - "type": "string" - }, - "manuallyProvidedAttributes": { - "description": "Attributes of the product provided manually via the Manufacturer Center UI.\n@OutputOnly", - "$ref": "Attributes" - }, - "contentLanguage": { - "description": "The content language of the product as a two-letter ISO 639-1 language code\n(for example, en).\n@OutputOnly", - "type": "string" - }, - "targetCountry": { - "description": "The target country of the product as a CLDR territory code (for example,\nUS).\n@OutputOnly", - "type": "string" - }, - "name": { - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.\n@OutputOnly", - "type": "string" } }, - "id": "Product" + "id": "Product", + "description": "Product data.", + "type": "object" }, "Capacity": { - "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.", - "type": "object", "properties": { "value": { "description": "The numeric value of the capacity.", @@ -85,10 +328,11 @@ "type": "string" } }, - "id": "Capacity" + "id": "Capacity", + "description": "The capacity of a product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#capacity.", + "type": "object" }, "ListProductsResponse": { - "type": "object", "properties": { "products": { "description": "List of the products.", @@ -102,12 +346,17 @@ "type": "string" } }, - "id": "ListProductsResponse" + "id": "ListProductsResponse", + "type": "object" }, "ProductDetail": { "description": "A product detail of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.", "type": "object", "properties": { + "attributeValue": { + "description": "The value of the attribute.", + "type": "string" + }, "sectionName": { "description": "A short section name that can be reused between multiple product details.", "type": "string" @@ -115,20 +364,14 @@ "attributeName": { "description": "The name of the attribute.", "type": "string" - }, - "attributeValue": { - "description": "The value of the attribute.", - "type": "string" } }, "id": "ProductDetail" }, "FeatureDescription": { + "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.", + "type": "object", "properties": { - "text": { - "description": "A detailed description of the feature.", - "type": "string" - }, "image": { "description": "An optional image describing the feature.", "$ref": "Image" @@ -136,24 +379,26 @@ "headline": { "description": "A short description of the feature.", "type": "string" + }, + "text": { + "description": "A detailed description of the feature.", + "type": "string" } }, - "id": "FeatureDescription", - "description": "A feature description of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#featuredesc.", - "type": "object" + "id": "FeatureDescription" }, "Issue": { - "description": "Product issue.", - "type": "object", "properties": { + "attribute": { + "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.", + "type": "string" + }, "timestamp": { "description": "The timestamp when this issue appeared.", "format": "google-datetime", "type": "string" }, "severity": { - "description": "The severity of the issue.", - "type": "string", "enumDescriptions": [ "Unspecified severity, never used.", "Error severity. The issue prevents the usage of the whole item.", @@ -165,7 +410,9 @@ "ERROR", "WARNING", "INFO" - ] + ], + "description": "The severity of the issue.", + "type": "string" }, "description": { "description": "Description of the issue.", @@ -174,23 +421,13 @@ "type": { "description": "The server-generated type of the issue, for example,\n“INCORRECT_TEXT_FORMATTING”, “IMAGE_NOT_SERVEABLE”, etc.", "type": "string" - }, - "attribute": { - "description": "If present, the attribute that triggered the issue. For more information\nabout attributes, see\nhttps://support.google.com/manufacturers/answer/6124116.", - "type": "string" } }, - "id": "Issue" - }, - "Empty": { - "properties": {}, - "id": "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": "Issue", + "description": "Product issue.", "type": "object" }, "Price": { - "description": "A price.", - "type": "object", "properties": { "amount": { "description": "The numeric value of the price.", @@ -201,13 +438,38 @@ "type": "string" } }, - "id": "Price" + "id": "Price", + "description": "A price.", + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" }, "Image": { - "description": "An image.", - "type": "object", "properties": { + "imageUrl": { + "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.", + "type": "string" + }, "status": { + "enumDescriptions": [ + "The image status is unspecified. Should not be used.", + "The image was uploaded and is being processed.", + "The image crawl is still pending.", + "The image was processed and it meets the requirements.", + "The image URL is protected by robots.txt file and cannot be crawled.", + "The image URL is protected by X-Robots-Tag and cannot be crawled.", + "There was an error while crawling the image.", + "The image cannot be processed.", + "The image cannot be decoded.", + "The image is too big.", + "The image was manually overridden and will not be crawled.", + "The image crawl was postponed to avoid overloading the host.", + "The image URL returned a \"404 Not Found\" error." + ], "enum": [ "STATUS_UNSPECIFIED", "PENDING_PROCESSING", @@ -224,79 +486,35 @@ "HTTP_404" ], "description": "The status of the image.\n@OutputOnly", - "type": "string", - "enumDescriptions": [ - "The image status is unspecified. Should not be used.", - "The image was uploaded and is being processed.", - "The image crawl is still pending.", - "The image was processed and it meets the requirements.", - "The image URL is protected by robots.txt file and cannot be crawled.", - "The image URL is protected by X-Robots-Tag and cannot be crawled.", - "There was an error while crawling the image.", - "The image cannot be processed.", - "The image cannot be decoded.", - "The image is too big.", - "The image was manually overridden and will not be crawled.", - "The image crawl was postponed to avoid overloading the host.", - "The image URL returned a \"404 Not Found\" error." - ] + "type": "string" }, "type": { - "enumDescriptions": [ - "Type is unspecified. Should not be used.", - "The image was crawled from a provided URL.", - "The image was uploaded." - ], "enum": [ "TYPE_UNSPECIFIED", "CRAWLED", "UPLOADED" ], "description": "The type of the image, i.e., crawled or uploaded.\n@OutputOnly", - "type": "string" - }, - "imageUrl": { - "description": "The URL of the image. For crawled images, this is the provided URL. For\nuploaded images, this is a serving URL from Google if the image has been\nprocessed successfully.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Type is unspecified. Should not be used.", + "The image was crawled from a provided URL.", + "The image was uploaded." + ] } }, - "id": "Image" + "id": "Image", + "description": "An image.", + "type": "object" }, "Attributes": { "description": "Attributes of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116.", "type": "object", "properties": { - "ageGroup": { - "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.", - "type": "string" - }, - "productDetail": { - "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.", - "type": "array", - "items": { - "$ref": "ProductDetail" - } - }, - "flavor": { - "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.", - "type": "string" - }, - "mpn": { - "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.", - "type": "string" - }, - "productPageUrl": { - "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.", - "type": "string" - }, "releaseDate": { "description": "The release date of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#release.", "type": "string" }, - "itemGroupId": { - "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.", - "type": "string" - }, "gtin": { "description": "The Global Trade Item Number (GTIN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#gtin.", "type": "array", @@ -304,6 +522,10 @@ "type": "string" } }, + "itemGroupId": { + "description": "The item group id of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#itemgroupid.", + "type": "string" + }, "productLine": { "description": "The name of the group of products related to the product. For more\ninformation, see\nhttps://support.google.com/manufacturers/answer/6124116#productline.", "type": "string" @@ -337,8 +559,8 @@ "type": "string" }, "imageLink": { - "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image.", - "$ref": "Image" + "$ref": "Image", + "description": "The image of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#image." }, "productType": { "description": "The type or category of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#producttype.", @@ -415,14 +637,37 @@ "scent": { "description": "The scent of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#scent.", "type": "string" + }, + "ageGroup": { + "description": "The target age group of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#agegroup.", + "type": "string" + }, + "productDetail": { + "description": "The details of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productdetail.", + "type": "array", + "items": { + "$ref": "ProductDetail" + } + }, + "flavor": { + "description": "The flavor of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#flavor.", + "type": "string" + }, + "mpn": { + "description": "The Manufacturer Part Number (MPN) of the product. For more information,\nsee https://support.google.com/manufacturers/answer/6124116#mpn.", + "type": "string" + }, + "productPageUrl": { + "description": "The URL of the detail page of the product. For more information, see\nhttps://support.google.com/manufacturers/answer/6124116#productpage.", + "type": "string" } }, "id": "Attributes" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "canonicalName": "Manufacturer Center", @@ -440,250 +685,5 @@ "name": "manufacturers", "batchPath": "batch", "title": "Manufacturer Center API", - "ownerName": "Google", - "resources": { - "accounts": { - "resources": { - "products": { - "methods": { - "delete": { - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "parent", - "name" - ], - "parameters": { - "name": { - "pattern": "^[^/]+$", - "location": "path", - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", - "required": true, - "type": "string" - }, - "parent": { - "pattern": "^accounts/[^/]+$", - "location": "path", - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/manufacturercenter" - ], - "flatPath": "v1/accounts/{accountsId}/products/{productsId}", - "id": "manufacturers.accounts.products.delete", - "path": "v1/{+parent}/products/{+name}", - "description": "Deletes the product from a Manufacturer Center account." - }, - "list": { - "flatPath": "v1/accounts/{accountsId}/products", - "path": "v1/{+parent}/products", - "id": "manufacturers.accounts.products.list", - "description": "Lists all the products in a Manufacturer Center account.", - "response": { - "$ref": "ListProductsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "location": "query", - "description": "The token returned by the previous request.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Maximum number of product statuses to return in the response, used for\npaging.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", - "required": true, - "type": "string", - "pattern": "^accounts/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/manufacturercenter" - ] - }, - "get": { - "description": "Gets the product from a Manufacturer Center account, including product\nissues.\n\nA recently updated product takes around 15 minutes to process. Changes are\nonly visible after it has been processed. While some issues may be\navailable once the product has been processed, other issues may take days\nto appear.", - "response": { - "$ref": "Product" - }, - "parameterOrder": [ - "parent", - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/manufacturercenter" - ], - "parameters": { - "name": { - "pattern": "^[^/]+$", - "location": "path", - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", - "required": true, - "type": "string" - }, - "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", - "required": true, - "type": "string", - "pattern": "^accounts/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/accounts/{accountsId}/products/{productsId}", - "path": "v1/{+parent}/products/{+name}", - "id": "manufacturers.accounts.products.get" - }, - "update": { - "flatPath": "v1/accounts/{accountsId}/products/{productsId}", - "id": "manufacturers.accounts.products.update", - "path": "v1/{+parent}/products/{+name}", - "request": { - "$ref": "Product" - }, - "description": "Inserts or updates the product in a Manufacturer Center account.\n\nThe checks at upload time are minimal. All required attributes need to be\npresent for a product to be valid. Issues may show up later\nafter the API has accepted an update for a product and it is possible to\noverwrite an existing valid product with an invalid product. To detect\nthis, you should retrieve the product and check it for issues once the\nupdated version is available.\n\nInserted or updated products first need to be processed before they can be\nretrieved. Until then, new products will be unavailable, and retrieval\nof updated products will return the original state of the product.", - "httpMethod": "PUT", - "parameterOrder": [ - "parent", - "name" - ], - "response": { - "$ref": "Product" - }, - "parameters": { - "name": { - "description": "Name in the format `{target_country}:{content_language}:{product_id}`.\n\n`target_country` - The target country of the product as a CLDR territory\n code (for example, US).\n\n`content_language` - The content language of the product as a two-letter\n ISO 639-1 language code (for example, en).\n\n`product_id` - The ID of the product. For more information, see\n https://support.google.com/manufacturers/answer/6124116#id.", - "required": true, - "type": "string", - "pattern": "^[^/]+$", - "location": "path" - }, - "parent": { - "description": "Parent ID in the format `accounts/{account_id}`.\n\n`account_id` - The ID of the Manufacturer Center account.", - "required": true, - "type": "string", - "pattern": "^accounts/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/manufacturercenter" - ] - } - } - } - } - } - }, - "parameters": { - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - } - }, - "version": "v1", - "baseUrl": "https://manufacturers.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Public API for managing Manufacturer Center related data.", - "servicePath": "", - "basePath": "", - "id": "manufacturers:v1", - "documentationLink": "https://developers.google.com/manufacturers/", - "revision": "20171207" + "ownerName": "Google" }
diff --git a/ml/v1/ml-api.json b/ml/v1/ml-api.json index 146746e..f0242a1 100644 --- a/ml/v1/ml-api.json +++ b/ml/v1/ml-api.json
@@ -1,4 +1,7 @@ { + "kind": "discovery#restDescription", + "description": "An API to enable creating and using machine learning models.", + "servicePath": "", "basePath": "", "id": "ml:v1", "documentationLink": "https://cloud.google.com/ml/", @@ -6,82 +9,9 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { - "GoogleCloudMlV1__GetConfigResponse": { - "description": "Returns service account information associated with a project.", - "type": "object", - "properties": { - "serviceAccount": { - "description": "The service account Cloud ML uses to access resources in the project.", - "type": "string" - }, - "serviceAccountProject": { - "description": "The project number for `service_account`.", - "format": "int64", - "type": "string" - } - }, - "id": "GoogleCloudMlV1__GetConfigResponse" - }, - "GoogleIamV1__TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "GoogleIamV1__TestIamPermissionsResponse" - }, - "GoogleCloudMlV1__HyperparameterOutput": { - "properties": { - "allMetrics": { - "description": "All recorded object metrics for this trial. This field is not currently\npopulated.", - "type": "array", - "items": { - "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric" - } - }, - "finalMetric": { - "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric", - "description": "The final objective metric seen for this trial." - }, - "hyperparameters": { - "description": "The hyperparameters given to this trial.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "trialId": { - "description": "The trial id for these results.", - "type": "string" - } - }, - "id": "GoogleCloudMlV1__HyperparameterOutput", - "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.", - "type": "object" - }, - "GoogleIamV1__SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" - }, - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "GoogleIamV1__Policy" - } - }, - "id": "GoogleIamV1__SetIamPolicyRequest" - }, "GoogleCloudMlV1__PredictionOutput": { + "description": "Represents results of a prediction job.", + "type": "object", "properties": { "errorCount": { "description": "The number of data instances which resulted in errors.", @@ -103,14 +33,23 @@ "type": "string" } }, - "id": "GoogleCloudMlV1__PredictionOutput", - "description": "Represents results of a prediction job.", - "type": "object" + "id": "GoogleCloudMlV1__PredictionOutput" }, "GoogleIamV1__Policy": { + "id": "GoogleIamV1__Policy", "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", "type": "object", "properties": { + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32", + "type": "integer" + }, "auditConfigs": { "description": "Specifies cloud audit logging configuration for this policy.", "type": "array", @@ -127,34 +66,23 @@ }, "iamOwned": { "type": "boolean" - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - }, - "version": { - "description": "Version of the `Policy`. The default version is 0.", - "format": "int32", - "type": "integer" } - }, - "id": "GoogleIamV1__Policy" + } }, "GoogleLongrunning__ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "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.", "type": "array", "items": { "$ref": "GoogleLongrunning__Operation" } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" } }, "id": "GoogleLongrunning__ListOperationsResponse" @@ -172,9 +100,14 @@ "id": "GoogleCloudMlV1__ManualScaling" }, "GoogleIamV1__Binding": { + "id": "GoogleIamV1__Binding", "description": "Associates `members` with a `role`.", "type": "object", "properties": { + "condition": { + "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.", + "$ref": "GoogleType__Expr" + }, "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", "type": "array", @@ -185,24 +118,17 @@ "role": { "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", "type": "string" - }, - "condition": { - "$ref": "GoogleType__Expr", - "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL." } - }, - "id": "GoogleIamV1__Binding" + } }, "GoogleCloudMlV1__TrainingOutput": { - "description": "Represents results of a training job. Output only.", - "type": "object", "properties": { "trials": { - "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs.", "type": "array", "items": { "$ref": "GoogleCloudMlV1__HyperparameterOutput" - } + }, + "description": "Results for individual Hyperparameter trials.\nOnly set for hyperparameter tuning jobs." }, "completedTrialCount": { "description": "The number of hyperparameter tuning trials that completed successfully.\nOnly set for hyperparameter tuning jobs.", @@ -219,7 +145,9 @@ "type": "number" } }, - "id": "GoogleCloudMlV1__TrainingOutput" + "id": "GoogleCloudMlV1__TrainingOutput", + "description": "Represents results of a training job. Output only.", + "type": "object" }, "GoogleCloudMlV1__PredictRequest": { "description": "Request for predictions to be issued against a trained model.", @@ -233,51 +161,55 @@ "id": "GoogleCloudMlV1__PredictRequest" }, "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric": { + "description": "An observed value of a metric.", + "type": "object", "properties": { - "objectiveValue": { - "description": "The objective value at this training step.", - "format": "double", - "type": "number" - }, "trainingStep": { "description": "The global training step for this metric.", "format": "int64", "type": "string" + }, + "objectiveValue": { + "type": "number", + "description": "The objective value at this training step.", + "format": "double" } }, - "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric", - "description": "An observed value of a metric.", - "type": "object" + "id": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric" }, "GoogleCloudMlV1__Version": { "description": "Represents a version of the model.\n\nEach version is a trained model deployed in the cloud, ready to handle\nprediction requests. A model can have multiple versions. You can get\ninformation about all of the versions of a given model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).\n\nLINT.IfChange", "type": "object", "properties": { + "name": { + "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.", + "type": "string" + }, "lastUseTime": { "description": "Output only. The time the version was last used for prediction.", "format": "google-datetime", "type": "string" }, "deploymentUri": { - "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformation.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000.", - "type": "string" + "type": "string", + "description": "Required. The Google Cloud Storage location of the trained model used to\ncreate the version. See the\n[overview of model\ndeployment](/ml-engine/docs/concepts/deployment-overview) for more\ninformation.\n\nWhen passing Version to\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)\nthe model service uses the specified location as the source of the model.\nOnce deployed, the model version is hosted by the prediction service, so\nthis location is useful only as a historical record.\nThe total number of model files can't exceed 1000." }, "autoScaling": { - "$ref": "GoogleCloudMlV1__AutoScaling", - "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes." + "description": "Automatically scale the number of nodes used to serve the model in\nresponse to increases and decreases in traffic. Care should be\ntaken to ramp up traffic according to the model's ability to scale\nor you will start seeing increases in latency and 429 response codes.", + "$ref": "GoogleCloudMlV1__AutoScaling" + }, + "labels": { + "description": "Optional. One or more labels that you can add, to organize your model\nversions. Each label is a key-value pair, where both the key and the value\nare arbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.", + "type": "object", + "additionalProperties": { + "type": "string" + } }, "createTime": { "description": "Output only. The time the version was created.", "format": "google-datetime", "type": "string" }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional. One or more labels that you can add, to organize your model\nversions. Each label is a key-value pair, where both the key and the value\nare arbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.", - "type": "object" - }, "errorMessage": { "description": "Output only. The details of a failure or a cancellation.", "type": "string" @@ -299,10 +231,6 @@ "description": "Output only. If true, this version will be used to handle prediction\nrequests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).", "type": "boolean" }, - "manualScaling": { - "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes.", - "$ref": "GoogleCloudMlV1__ManualScaling" - }, "state": { "description": "Output only. The state of a version.", "type": "string", @@ -321,9 +249,9 @@ "DELETING" ] }, - "name": { - "description": "Required.The name specified for the version when it was created.\n\nThe version name must be unique within the model it is created in.", - "type": "string" + "manualScaling": { + "$ref": "GoogleCloudMlV1__ManualScaling", + "description": "Manually select the number of nodes to use for serving the\nmodel. You should generally use `auto_scaling` with an appropriate\n`min_nodes` instead, but this option is available if you want more\npredictable billing. Beware that latency and error rates will increase\nif the traffic exceeds that capability of the system to serve it based\non the selected number of nodes." } }, "id": "GoogleCloudMlV1__Version" @@ -346,6 +274,12 @@ } }, "scaleType": { + "enum": [ + "NONE", + "UNIT_LINEAR_SCALE", + "UNIT_LOG_SCALE", + "UNIT_REVERSE_LOG_SCALE" + ], "description": "Optional. How the parameter should be scaled to the hypercube.\nLeave unset for categorical parameters.\nSome kind of scaling is strongly recommended for real or integral\nparameters (e.g., `UNIT_LINEAR_SCALE`).", "type": "string", "enumDescriptions": [ @@ -353,12 +287,6 @@ "Scales the feasible space to (0, 1) linearly.", "Scales the feasible space logarithmically to (0, 1). The entire feasible\nspace must be strictly positive.", "Scales the feasible space \"reverse\" logarithmically to (0, 1). The result\nis that values close to the top of the feasible space are spread out more\nthan points near the bottom. The entire feasible space must be strictly\npositive." - ], - "enum": [ - "NONE", - "UNIT_LINEAR_SCALE", - "UNIT_LOG_SCALE", - "UNIT_REVERSE_LOG_SCALE" ] }, "maxValue": { @@ -367,6 +295,8 @@ "type": "number" }, "type": { + "description": "Required. The type of the parameter.", + "type": "string", "enumDescriptions": [ "You must specify a valid type. Using this unspecified type will result in\nan error.", "Type for real-valued parameters.", @@ -380,16 +310,14 @@ "INTEGER", "CATEGORICAL", "DISCRETE" - ], - "description": "Required. The type of the parameter.", - "type": "string" + ] }, "categoricalValues": { - "description": "Required if type is `CATEGORICAL`. The list of possible categories.", "type": "array", "items": { "type": "string" - } + }, + "description": "Required if type is `CATEGORICAL`. The list of possible categories." }, "parameterName": { "description": "Required. The parameter name must be unique amongst all ParameterConfigs in\na HyperparameterSpec message. E.g., \"learning_rate\".", @@ -398,17 +326,29 @@ }, "id": "GoogleCloudMlV1__ParameterSpec" }, + "GoogleCloudMlV1__Location": { + "properties": { + "name": { + "type": "string" + }, + "capabilities": { + "type": "array", + "items": { + "$ref": "GoogleCloudMlV1__Capability" + }, + "description": "Capabilities available in the location." + } + }, + "id": "GoogleCloudMlV1__Location", + "type": "object" + }, "GoogleCloudMlV1__PredictionInput": { "description": "Represents input parameters for a prediction job.", "type": "object", "properties": { - "region": { - "description": "Required. The Google Compute Engine region to run the prediction job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.", - "type": "string" - }, "versionName": { - "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`", - "type": "string" + "type": "string", + "description": "Use this field if you want to specify a version of the model to use. The\nstring is formatted the same way as `model_version`, with the addition\nof the version information:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003eYOUR_MODEL/versions/\u003cvar\u003e[YOUR_VERSION]\u003c/var\u003e\"`" }, "modelName": { "description": "Use this field if you want to use the default version for the specified\nmodel. The string must use the following format:\n\n`\"projects/\u003cvar\u003e[YOUR_PROJECT]\u003c/var\u003e/models/\u003cvar\u003e[YOUR_MODEL]\u003c/var\u003e\"`", @@ -418,22 +358,20 @@ "description": "Required. The output Google Cloud Storage location.", "type": "string" }, + "uri": { + "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.", + "type": "string" + }, "maxWorkerCount": { "description": "Optional. The maximum number of workers to be used for parallel processing.\nDefaults to 10 if not specified.", "format": "int64", "type": "string" }, - "uri": { - "description": "Use this field if you want to specify a Google Cloud Storage path for\nthe model to use.", - "type": "string" - }, "signatureName": { "description": "Optional. The name of the signature defined in the SavedModel to use for\nthis job. Please refer to\n[SavedModel](https://tensorflow.github.io/serving/serving_basic.html)\nfor information about how to use signatures.\n\nDefaults to\n[DEFAULT_SERVING_SIGNATURE_DEF_KEY](https://www.tensorflow.org/api_docs/python/tf/saved_model/signature_constants)\n, which is \"serving_default\".", "type": "string" }, "dataFormat": { - "description": "Required. The format of the input data files.", - "type": "string", "enumDescriptions": [ "Unspecified format.", "Each line of the file is a JSON dictionary representing one record.", @@ -447,16 +385,18 @@ "TEXT", "TF_RECORD", "TF_RECORD_GZIP" - ] + ], + "description": "Required. The format of the input data files.", + "type": "string" }, "runtimeVersion": { "description": "Optional. The Google Cloud ML runtime version to use for this batch\nprediction. If not set, Google Cloud ML will pick the runtime version used\nduring the CreateVersion request for this model version, or choose the\nlatest stable version when model version information is not available\nsuch as when the model is specified by uri.", "type": "string" }, "batchSize": { + "type": "string", "description": "Optional. Number of records per batch, defaults to 64.\nThe service will buffer batch_size number of records in memory before\ninvoking one Tensorflow prediction call internally. So take the record\nsize and memory available into consideration when setting this parameter.", - "format": "int64", - "type": "string" + "format": "int64" }, "inputPaths": { "description": "Required. The Google Cloud Storage location of the input data files.\nMay contain wildcards.", @@ -464,96 +404,15 @@ "items": { "type": "string" } + }, + "region": { + "description": "Required. The Google Compute Engine region to run the prediction job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.", + "type": "string" } }, "id": "GoogleCloudMlV1__PredictionInput" }, - "GoogleCloudMlV1__Location": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "capabilities": { - "description": "Capabilities available in the location.", - "type": "array", - "items": { - "$ref": "GoogleCloudMlV1__Capability" - } - } - }, - "id": "GoogleCloudMlV1__Location" - }, - "GoogleCloudMlV1__OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "type": "object", - "properties": { - "isCancellationRequested": { - "description": "Indicates whether a request to cancel this operation has been made.", - "type": "boolean" - }, - "projectNumber": { - "description": "Contains the project number associated with the operation.", - "format": "int64", - "type": "string" - }, - "createTime": { - "description": "The time the operation was submitted.", - "format": "google-datetime", - "type": "string" - }, - "labels": { - "description": "The user labels, inherited from the model or the model version being\noperated on.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "modelName": { - "description": "Contains the name of the model associated with the operation.", - "type": "string" - }, - "version": { - "description": "Contains the version associated with the operation.", - "$ref": "GoogleCloudMlV1__Version" - }, - "endTime": { - "description": "The time operation processing completed.", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "enumDescriptions": [ - "Unspecified operation type.", - "An operation to create a new version.", - "An operation to delete an existing version.", - "An operation to delete an existing model.", - "An operation to update an existing model.", - "An operation to update an existing version.", - "An operation to update project configuration." - ], - "enum": [ - "OPERATION_TYPE_UNSPECIFIED", - "CREATE_VERSION", - "DELETE_VERSION", - "DELETE_MODEL", - "UPDATE_MODEL", - "UPDATE_VERSION", - "UPDATE_CONFIG" - ], - "description": "The operation type.", - "type": "string" - }, - "startTime": { - "description": "The time operation processing started.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "GoogleCloudMlV1__OperationMetadata" - }, "GoogleIamV1__AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", "type": "object", "properties": { "exemptedMembers": { @@ -580,20 +439,81 @@ ] } }, - "id": "GoogleIamV1__AuditLogConfig" + "id": "GoogleIamV1__AuditLogConfig", + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging." + }, + "GoogleCloudMlV1__OperationMetadata": { + "description": "Represents the metadata of the long-running operation.", + "type": "object", + "properties": { + "createTime": { + "description": "The time the operation was submitted.", + "format": "google-datetime", + "type": "string" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The user labels, inherited from the model or the model version being\noperated on.", + "type": "object" + }, + "modelName": { + "description": "Contains the name of the model associated with the operation.", + "type": "string" + }, + "version": { + "$ref": "GoogleCloudMlV1__Version", + "description": "Contains the version associated with the operation." + }, + "endTime": { + "description": "The time operation processing completed.", + "format": "google-datetime", + "type": "string" + }, + "operationType": { + "type": "string", + "enumDescriptions": [ + "Unspecified operation type.", + "An operation to create a new version.", + "An operation to delete an existing version.", + "An operation to delete an existing model.", + "An operation to update an existing model.", + "An operation to update an existing version.", + "An operation to update project configuration." + ], + "enum": [ + "OPERATION_TYPE_UNSPECIFIED", + "CREATE_VERSION", + "DELETE_VERSION", + "DELETE_MODEL", + "UPDATE_MODEL", + "UPDATE_VERSION", + "UPDATE_CONFIG" + ], + "description": "The operation type." + }, + "startTime": { + "description": "The time operation processing started.", + "format": "google-datetime", + "type": "string" + }, + "isCancellationRequested": { + "description": "Indicates whether a request to cancel this operation has been made.", + "type": "boolean" + }, + "projectNumber": { + "description": "Contains the project number associated with the operation.", + "format": "int64", + "type": "string" + } + }, + "id": "GoogleCloudMlV1__OperationMetadata" }, "GoogleType__Expr": { "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", "type": "object", "properties": { - "description": { - "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", - "type": "string" - }, "title": { "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", "type": "string" @@ -601,6 +521,14 @@ "location": { "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", "type": "string" + }, + "description": { + "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", + "type": "string" + }, + "expression": { + "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", + "type": "string" } }, "id": "GoogleType__Expr" @@ -609,7 +537,14 @@ "description": "Represents a set of hyperparameters to optimize.", "type": "object", "properties": { + "maxParallelTrials": { + "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.", + "format": "int32", + "type": "integer" + }, "goal": { + "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.", + "type": "string", "enumDescriptions": [ "Goal Type will default to maximize.", "Maximize the goal metric.", @@ -619,9 +554,7 @@ "GOAL_TYPE_UNSPECIFIED", "MAXIMIZE", "MINIMIZE" - ], - "description": "Required. The type of goal to use for tuning. Available types are\n`MAXIMIZE` and `MINIMIZE`.\n\nDefaults to `MAXIMIZE`.", - "type": "string" + ] }, "hyperparameterMetricTag": { "description": "Optional. The Tensorflow summary tag name to use for optimizing trials. For\ncurrent versions of Tensorflow, this tag name should exactly match what is\nshown in Tensorboard, including all scopes. For versions of Tensorflow\nprior to 0.12, this should be only the tag passed to tf.Summary.\nBy default, \"training/hptuning/metric\" will be used.", @@ -638,11 +571,6 @@ "description": "Optional. How many training trials should be attempted to optimize\nthe specified hyperparameters.\n\nDefaults to one.", "format": "int32", "type": "integer" - }, - "maxParallelTrials": { - "description": "Optional. The number of training trials to run concurrently.\nYou can reduce the time it takes to perform hyperparameter tuning by adding\ntrials in parallel. However, each trail only benefits from the information\ngained in completed trials. That means that a trial does not get access to\nthe results of trials running at the same time, which could reduce the\nquality of the overall optimization.\n\nEach trial will use the same scale tier and machine types.\n\nDefaults to one.", - "format": "int32", - "type": "integer" } }, "id": "GoogleCloudMlV1__HyperparameterSpec" @@ -668,16 +596,16 @@ "description": "Response message for the ListJobs method.", "type": "object", "properties": { - "nextPageToken": { - "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", - "type": "string" - }, "jobs": { "description": "The list of jobs.", "type": "array", "items": { "$ref": "GoogleCloudMlV1__Job" } + }, + "nextPageToken": { + "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", + "type": "string" } }, "id": "GoogleCloudMlV1__ListJobsResponse" @@ -692,43 +620,64 @@ "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "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": { + "type": "object", "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" + "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`." }, "name": { "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", "type": "string" }, "error": { - "$ref": "GoogleRpc__Status", - "description": "The error result of the operation in case of failure or cancellation." + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "GoogleRpc__Status" }, "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "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" } }, "id": "GoogleLongrunning__Operation" }, - "GoogleCloudMlV1__Model": { + "GoogleIamV1__AuditConfig": { + "type": "object", "properties": { - "defaultVersion": { - "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).", - "$ref": "GoogleCloudMlV1__Version" + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" }, + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.\nNext ID: 4", + "type": "array", + "items": { + "$ref": "GoogleIamV1__AuditLogConfig" + } + }, + "exemptedMembers": { + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "GoogleIamV1__AuditConfig", + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging." + }, + "GoogleCloudMlV1__Model": { + "type": "object", + "properties": { "regions": { "description": "Optional. The list of regions where the model is going to be deployed.\nCurrently only one region per model is supported.\nDefaults to 'us-central1' if nothing is set.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.\nNote:\n* No matter where a model is deployed, it can always be accessed by\n users from anywhere, both for online and batch prediction.\n* The region for a batch prediction job is set by the region field when\n submitting the batch prediction job and does not take its value from\n this field.", "type": "array", @@ -750,56 +699,43 @@ "type": "string" }, "labels": { - "description": "Optional. One or more labels that you can add, to organize your models.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Optional. One or more labels that you can add, to organize your models.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.", + "type": "object" }, "name": { "description": "Required. The name specified for the model when it was created.\n\nThe model name must be unique within the project it is created in.", "type": "string" + }, + "defaultVersion": { + "$ref": "GoogleCloudMlV1__Version", + "description": "Output only. The default version of the model. This version will be used to\nhandle prediction requests that do not specify a version.\n\nYou can change the default version by calling\n[projects.methods.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)." } }, "id": "GoogleCloudMlV1__Model", - "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer.", - "type": "object" + "description": "Represents a machine learning solution.\n\nA model can have multiple versions, each of which is a deployed, trained\nmodel ready to receive prediction requests. The model itself is just a\ncontainer." }, - "GoogleIamV1__AuditConfig": { - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", + "GoogleProtobuf__Empty": { + "type": "object", + "properties": {}, + "id": "GoogleProtobuf__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 `{}`." + }, + "GoogleIamV1__TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.\nNext ID: 4", - "type": "array", - "items": { - "$ref": "GoogleIamV1__AuditLogConfig" - } - }, - "exemptedMembers": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", "type": "array", "items": { "type": "string" } - }, - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" } }, - "id": "GoogleIamV1__AuditConfig" - }, - "GoogleProtobuf__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 `{}`.", - "type": "object", - "properties": {}, - "id": "GoogleProtobuf__Empty" - }, - "GoogleCloudMlV1__CancelJobRequest": { - "description": "Request message for the CancelJob method.", - "type": "object", - "properties": {}, - "id": "GoogleCloudMlV1__CancelJobRequest" + "id": "GoogleIamV1__TestIamPermissionsRequest" }, "GoogleCloudMlV1__ListVersionsResponse": { "description": "Response message for the ListVersions method.", @@ -819,36 +755,36 @@ }, "id": "GoogleCloudMlV1__ListVersionsResponse" }, - "GoogleIamV1__TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", + "GoogleCloudMlV1__CancelJobRequest": { + "description": "Request message for the CancelJob method.", "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "GoogleIamV1__TestIamPermissionsRequest" + "properties": {}, + "id": "GoogleCloudMlV1__CancelJobRequest" }, "GoogleCloudMlV1__AutoScaling": { - "properties": { - "minNodes": { - "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.", - "format": "int32", - "type": "integer" - } - }, - "id": "GoogleCloudMlV1__AutoScaling", "description": "Options for automatically scaling a model.", - "type": "object" - }, - "GoogleRpc__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.", "type": "object", "properties": { + "minNodes": { + "type": "integer", + "description": "Optional. The minimum number of nodes to allocate for this model. These\nnodes are always up, starting from the time the model is deployed, so the\ncost of operating this model will be at least\n`rate` * `min_nodes` * number of hours since last billing cycle,\nwhere `rate` is the cost per node-hour as documented in\n[pricing](https://cloud.google.com/ml-engine/pricing#prediction_pricing),\neven if no predictions are performed. There is additional cost for each\nprediction performed.\n\nUnlike manual scaling, if the load gets too heavy for the nodes\nthat are up, the service will automatically add nodes to handle the\nincreased load as well as scale back as traffic drops, always maintaining\nat least `min_nodes`. You will be charged for the time in which additional\nnodes are used.\n\nIf not specified, `min_nodes` defaults to 0, in which case, when traffic\nto a model stops (and after a cool-down period), nodes will be shut down\nand no charges will be incurred until traffic to the model resumes.", + "format": "int32" + } + }, + "id": "GoogleCloudMlV1__AutoScaling" + }, + "GoogleRpc__Status": { + "type": "object", + "properties": { + "code": { + "type": "integer", + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32" + }, + "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 is a common set of\nmessage types for APIs to use.", "type": "array", @@ -859,48 +795,33 @@ }, "type": "object" } - }, - "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" } }, - "id": "GoogleRpc__Status" + "id": "GoogleRpc__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." }, "GoogleCloudMlV1__ListModelsResponse": { + "type": "object", "properties": { - "nextPageToken": { - "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", - "type": "string" - }, "models": { "description": "The list of models.", "type": "array", "items": { "$ref": "GoogleCloudMlV1__Model" } + }, + "nextPageToken": { + "description": "Optional. Pass this token as the `page_token` field of the request for a\nsubsequent call.", + "type": "string" } }, "id": "GoogleCloudMlV1__ListModelsResponse", - "description": "Response message for the ListModels method.", - "type": "object" + "description": "Response message for the ListModels method." }, "GoogleCloudMlV1__TrainingInput": { "description": "Represents input parameters for a training job. When using the\ngcloud command to submit your training job, you can specify\nthe input parameters as command-line arguments and/or in a YAML configuration\nfile referenced from the --config command-line argument. For\ndetails, see the guide to\n\u003ca href=\"/ml-engine/docs/training-jobs\"\u003esubmitting a training job\u003c/a\u003e.", "type": "object", "properties": { - "packageUris": { - "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100.", - "type": "array", - "items": { - "type": "string" - } - }, "workerCount": { "description": "Optional. The number of worker replicas to use for the training job. Each\nreplica in the cluster will be of the type specified in `worker_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`. If you\nset this value, you must also set `worker_type`.", "format": "int64", @@ -911,15 +832,15 @@ "type": "string" }, "runtimeVersion": { - "description": "Optional. The Google Cloud ML runtime version to use for training. If not\nset, Google Cloud ML will choose the latest stable version.", - "type": "string" + "type": "string", + "description": "Optional. The Google Cloud ML runtime version to use for training. If not\nset, Google Cloud ML will choose the latest stable version." }, "pythonModule": { "description": "Required. The Python module name to run after installing the packages.", "type": "string" }, - "region": { - "description": "Required. The Google Compute Engine region to run the training job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.", + "workerType": { + "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.", "type": "string" }, "args": { @@ -929,8 +850,8 @@ "type": "string" } }, - "workerType": { - "description": "Optional. Specifies the type of virtual machine to use for your training\njob's worker nodes.\n\nThe supported values are the same as those described in the entry for\n`masterType`.\n\nThis value must be present when `scaleTier` is set to `CUSTOM` and\n`workerCount` is greater than zero.", + "region": { + "description": "Required. The Google Compute Engine region to run the training job in.\nSee the \u003ca href=\"/ml-engine/docs/regions\"\u003eavailable regions\u003c/a\u003e for\nML Engine services.", "type": "string" }, "parameterServerType": { @@ -938,14 +859,6 @@ "type": "string" }, "scaleTier": { - "enumDescriptions": [ - "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.", - "Many workers and a few parameter servers.", - "A large number of workers with many parameter servers.", - "A single worker instance [with a\nGPU](/ml-engine/docs/how-tos/using-gpus).", - "A single worker instance with a [Cloud TPU](/tpu)", - "The CUSTOM tier is not a set tier, but rather enables you to use your\nown cluster specification. When you use this tier, set values to\nconfigure your processing cluster according to these guidelines:\n\n* You _must_ set `TrainingInput.masterType` to specify the type\n of machine to use for your master node. This is the only required\n setting.\n\n* You _may_ set `TrainingInput.workerCount` to specify the number of\n workers to use. If you specify one or more workers, you _must_ also\n set `TrainingInput.workerType` to specify the type of machine to use\n for your worker nodes.\n\n* You _may_ set `TrainingInput.parameterServerCount` to specify the\n number of parameter servers to use. If you specify one or more\n parameter servers, you _must_ also set\n `TrainingInput.parameterServerType` to specify the type of machine to\n use for your parameter servers.\n\nNote that all of your workers must use the same machine type, which can\nbe different from your parameter server type and master type. Your\nparameter servers must likewise use the same machine type, which can be\ndifferent from your worker type and master type." - ], "enum": [ "BASIC", "STANDARD_1", @@ -955,7 +868,15 @@ "CUSTOM" ], "description": "Required. Specifies the machine types, the number of replicas for workers\nand parameter servers.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "A single worker instance. This tier is suitable for learning how to use\nCloud ML, and for experimenting with new models using small datasets.", + "Many workers and a few parameter servers.", + "A large number of workers with many parameter servers.", + "A single worker instance [with a\nGPU](/ml-engine/docs/how-tos/using-gpus).", + "A single worker instance with a [Cloud TPU](/tpu)", + "The CUSTOM tier is not a set tier, but rather enables you to use your\nown cluster specification. When you use this tier, set values to\nconfigure your processing cluster according to these guidelines:\n\n* You _must_ set `TrainingInput.masterType` to specify the type\n of machine to use for your master node. This is the only required\n setting.\n\n* You _may_ set `TrainingInput.workerCount` to specify the number of\n workers to use. If you specify one or more workers, you _must_ also\n set `TrainingInput.workerType` to specify the type of machine to use\n for your worker nodes.\n\n* You _may_ set `TrainingInput.parameterServerCount` to specify the\n number of parameter servers to use. If you specify one or more\n parameter servers, you _must_ also set\n `TrainingInput.parameterServerType` to specify the type of machine to\n use for your parameter servers.\n\nNote that all of your workers must use the same machine type, which can\nbe different from your parameter server type and master type. Your\nparameter servers must likewise use the same machine type, which can be\ndifferent from your worker type and master type." + ] }, "jobDir": { "description": "Optional. A Google Cloud Storage path in which to store training outputs\nand other data needed for training. This path is passed to your TensorFlow\nprogram as the 'job_dir' command-line argument. The benefit of specifying\nthis field is that Cloud ML validates the path for use in training.", @@ -970,9 +891,16 @@ "type": "string" }, "parameterServerCount": { + "type": "string", "description": "Optional. The number of parameter server replicas to use for the training\njob. Each replica in the cluster will be of the type specified in\n`parameter_server_type`.\n\nThis value can only be used when `scale_tier` is set to `CUSTOM`.If you\nset this value, you must also set `parameter_server_type`.", - "format": "int64", - "type": "string" + "format": "int64" + }, + "packageUris": { + "description": "Required. The Google Cloud Storage location of the packages with\nthe training program and any additional dependencies.\nThe maximum number of package URIs is 100.", + "type": "array", + "items": { + "type": "string" + } } }, "id": "GoogleCloudMlV1__TrainingInput" @@ -992,12 +920,12 @@ "type": "string" }, "predictionOutput": { - "$ref": "GoogleCloudMlV1__PredictionOutput", - "description": "The current prediction job result." + "description": "The current prediction job result.", + "$ref": "GoogleCloudMlV1__PredictionOutput" }, "trainingOutput": { - "description": "The current training job result.", - "$ref": "GoogleCloudMlV1__TrainingOutput" + "$ref": "GoogleCloudMlV1__TrainingOutput", + "description": "The current training job result." }, "createTime": { "description": "Output only. When the job was created.", @@ -1005,11 +933,11 @@ "type": "string" }, "labels": { - "description": "Optional. One or more labels that you can add, to organize your jobs.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "Optional. One or more labels that you can add, to organize your jobs.\nEach label is a key-value pair, where both the key and the value are\narbitrary strings that you supply.\nFor more information, see the documentation on\n\u003ca href=\"/ml-engine/docs/how-tos/resource-labels\"\u003eusing labels\u003c/a\u003e.", + "type": "object" }, "predictionInput": { "description": "Input parameters to create a prediction job.", @@ -1059,6 +987,44 @@ }, "id": "GoogleCloudMlV1__Job" }, + "GoogleCloudMlV1__Capability": { + "type": "object", + "properties": { + "type": { + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "" + ], + "enum": [ + "TYPE_UNSPECIFIED", + "TRAINING", + "BATCH_PREDICTION", + "ONLINE_PREDICTION" + ] + }, + "availableAccelerators": { + "enumDescriptions": [ + "Unspecified accelerator type. Default to no GPU.", + "Nvidia tesla k80 GPU.", + "Nvidia tesla P100 GPU." + ], + "description": "Available accelerators for the capability.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "ACCELERATOR_TYPE_UNSPECIFIED", + "NVIDIA_TESLA_K80", + "NVIDIA_TESLA_P100" + ] + } + } + }, + "id": "GoogleCloudMlV1__Capability" + }, "GoogleApi__HttpBody": { "description": "Message that represents an arbitrary HTTP body. It should only be used for\npayload formats that can't be represented as JSON, such as raw binary or\nan HTML page.\n\n\nThis message can be used both in streaming and non-streaming API methods in\nthe request as well as the response.\n\nIt can be used as a top-level request field, which is convenient if one\nwants to extract parameters from either the URL or HTTP template into the\nrequest fields and also want access to the raw HTTP body.\n\nExample:\n\n message GetResourceRequest {\n // A unique request id.\n string request_id = 1;\n\n // The raw HTTP body is bound to this field.\n google.api.HttpBody http_body = 2;\n }\n\n service ResourceService {\n rpc GetResource(GetResourceRequest) returns (google.api.HttpBody);\n rpc UpdateResource(google.api.HttpBody) returns (google.protobuf.Empty);\n }\n\nExample with streaming methods:\n\n service CaldavService {\n rpc GetCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n rpc UpdateCalendar(stream google.api.HttpBody)\n returns (stream google.api.HttpBody);\n }\n\nUse of this type only changes how the request and response bodies are\nhandled, all other features will continue to work unchanged.", "type": "object", @@ -1086,50 +1052,87 @@ }, "id": "GoogleApi__HttpBody" }, - "GoogleCloudMlV1__Capability": { + "GoogleCloudMlV1__GetConfigResponse": { "type": "object", "properties": { - "availableAccelerators": { - "enumDescriptions": [ - "Unspecified accelerator type. Default to no GPU.", - "Nvidia tesla k80 GPU.", - "Nvidia tesla P100 GPU." - ], - "description": "Available accelerators for the capability.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "ACCELERATOR_TYPE_UNSPECIFIED", - "NVIDIA_TESLA_K80", - "NVIDIA_TESLA_P100" - ] - } + "serviceAccountProject": { + "description": "The project number for `service_account`.", + "format": "int64", + "type": "string" }, - "type": { - "enumDescriptions": [ - "", - "", - "", - "" - ], - "enum": [ - "TYPE_UNSPECIFIED", - "TRAINING", - "BATCH_PREDICTION", - "ONLINE_PREDICTION" - ], + "serviceAccount": { + "description": "The service account Cloud ML uses to access resources in the project.", "type": "string" } }, - "id": "GoogleCloudMlV1__Capability" + "id": "GoogleCloudMlV1__GetConfigResponse", + "description": "Returns service account information associated with a project." + }, + "GoogleIamV1__TestIamPermissionsResponse": { + "type": "object", + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "GoogleIamV1__TestIamPermissionsResponse", + "description": "Response message for `TestIamPermissions` method." + }, + "GoogleCloudMlV1__HyperparameterOutput": { + "description": "Represents the result of a single hyperparameter tuning trial from a\ntraining job. The TrainingOutput object that is returned on successful\ncompletion of a training job with hyperparameter tuning includes a list\nof HyperparameterOutput objects, one for each successful trial.", + "type": "object", + "properties": { + "allMetrics": { + "description": "All recorded object metrics for this trial. This field is not currently\npopulated.", + "type": "array", + "items": { + "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric" + } + }, + "finalMetric": { + "$ref": "GoogleCloudMlV1_HyperparameterOutput_HyperparameterMetric", + "description": "The final objective metric seen for this trial." + }, + "hyperparameters": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The hyperparameters given to this trial." + }, + "trialId": { + "description": "The trial id for these results.", + "type": "string" + } + }, + "id": "GoogleCloudMlV1__HyperparameterOutput" + }, + "GoogleIamV1__SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "format": "google-fieldmask", + "type": "string" + }, + "policy": { + "$ref": "GoogleIamV1__Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "GoogleIamV1__SetIamPolicyRequest" } }, + "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", "canonicalName": "Cloud Machine Learning Engine", "auth": { "oauth2": { @@ -1149,61 +1152,65 @@ "ownerName": "Google", "resources": { "projects": { + "methods": { + "predict": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "GoogleApi__HttpBody" + }, + "parameters": { + "name": { + "required": true, + "type": "string", + "pattern": "^projects/.+$", + "location": "path", + "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}:predict", + "id": "ml.projects.predict", + "path": "v1/{+name}:predict", + "request": { + "$ref": "GoogleCloudMlV1__PredictRequest" + }, + "description": "Performs prediction on the data in the request.\nCloud ML Engine implements a custom `predict` verb on top of an HTTP POST\nmethod. \u003cp\u003eFor details of the request and response format, see the **guide\nto the [predict request format](/ml-engine/docs/v1/predict-request)**." + }, + "getConfig": { + "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.", + "httpMethod": "GET", + "response": { + "$ref": "GoogleCloudMlV1__GetConfigResponse" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "Required. The project name.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}:getConfig", + "id": "ml.projects.getConfig", + "path": "v1/{+name}:getConfig" + } + }, "resources": { "operations": { "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "response": { - "$ref": "GoogleProtobuf__Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "ml.projects.operations.cancel" - }, - "delete": { - "path": "v1/{+name}", - "id": "ml.projects.operations.delete", - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", - "response": { - "$ref": "GoogleProtobuf__Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/operations/{operationsId}" - }, "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", "parameterOrder": [ "name" @@ -1213,9 +1220,9 @@ }, "parameters": { "filter": { - "location": "query", "description": "The standard list filter.", - "type": "string" + "type": "string", + "location": "query" }, "name": { "description": "The name of the operation's parent resource.", @@ -1225,15 +1232,15 @@ "location": "path" }, "pageToken": { + "location": "query", "description": "The standard list page token.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { + "location": "query", "description": "The standard list page size.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" } }, "scopes": [ @@ -1241,7 +1248,8 @@ ], "flatPath": "v1/projects/{projectsId}/operations", "id": "ml.projects.operations.list", - "path": "v1/{+name}/operations" + "path": "v1/{+name}/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 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." }, "get": { "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", @@ -1257,22 +1265,98 @@ "httpMethod": "GET", "parameters": { "name": { - "pattern": "^projects/[^/]+/operations/[^/]+$", "location": "path", "description": "The name of the operation resource.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/operations/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] + }, + "cancel": { + "httpMethod": "POST", + "response": { + "$ref": "GoogleProtobuf__Empty" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/operations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/operations/{operationsId}:cancel", + "id": "ml.projects.operations.cancel", + "path": "v1/{+name}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." + }, + "delete": { + "response": { + "$ref": "GoogleProtobuf__Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/operations/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/operations/{operationsId}", + "path": "v1/{+name}", + "id": "ml.projects.operations.delete", + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`." } } }, "models": { "methods": { + "delete": { + "path": "v1/{+name}", + "id": "ml.projects.models.delete", + "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete).", + "response": { + "$ref": "GoogleLongrunning__Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Required. The name of the model.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/models/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/models/{modelsId}" + }, "list": { + "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.\n\nIf there are no models that match the request parameters, the list request\nreturns an empty response body: {}.", "response": { "$ref": "GoogleCloudMlV1__ListModelsResponse" }, @@ -1280,42 +1364,67 @@ "parent" ], "httpMethod": "GET", - "parameters": { - "parent": { - "description": "Required. The name of the project whose models are to be listed.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "filter": { - "description": "Optional. Specifies the subset of models to retrieve.", - "type": "string", - "location": "query" - }, - "pageToken": { - "location": "query", - "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", - "format": "int32", - "type": "integer" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The name of the project whose models are to be listed." + }, + "filter": { + "location": "query", + "description": "Optional. Specifies the subset of models to retrieve.", + "type": "string" + }, + "pageToken": { + "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Optional. The number of models to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, "flatPath": "v1/projects/{projectsId}/models", "path": "v1/{+parent}/models", - "id": "ml.projects.models.list", - "description": "Lists the models in a project.\n\nEach project can contain multiple models, and each model can have multiple\nversions.\n\nIf there are no models that match the request parameters, the list request\nreturns an empty response body: {}." + "id": "ml.projects.models.list" + }, + "create": { + "flatPath": "v1/projects/{projectsId}/models", + "path": "v1/{+parent}/models", + "id": "ml.projects.models.create", + "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create).", + "request": { + "$ref": "GoogleCloudMlV1__Model" + }, + "response": { + "$ref": "GoogleCloudMlV1__Model" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "Required. The project name." + } + } }, "setIamPolicy": { - "id": "ml.projects.models.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "GoogleIamV1__SetIamPolicyRequest" }, @@ -1329,45 +1438,19 @@ }, "parameters": { "resource": { + "location": "path", "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/models/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy" - }, - "create": { - "response": { - "$ref": "GoogleCloudMlV1__Model" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The project name.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/models", - "path": "v1/{+parent}/models", - "id": "ml.projects.models.create", - "request": { - "$ref": "GoogleCloudMlV1__Model" - }, - "description": "Creates a model which will later contain one or more versions.\n\nYou must add at least one version before you can request predictions from\nthe model. Add versions by calling\n[projects.models.versions.create](/ml-engine/reference/rest/v1/projects.models.versions/create)." + "flatPath": "v1/projects/{projectsId}/models/{modelsId}:setIamPolicy", + "id": "ml.projects.models.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy" }, "getIamPolicy": { "response": { @@ -1377,28 +1460,49 @@ "resource" ], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "resource": { - "location": "path", "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+$" + "pattern": "^projects/[^/]+/models/[^/]+$", + "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/projects/{projectsId}/models/{modelsId}:getIamPolicy", "path": "v1/{+resource}:getIamPolicy", "id": "ml.projects.models.getIamPolicy", "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." }, - "patch": { - "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`.", - "request": { + "get": { + "flatPath": "v1/projects/{projectsId}/models/{modelsId}", + "id": "ml.projects.models.get", + "path": "v1/{+name}", + "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).", + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { "$ref": "GoogleCloudMlV1__Model" }, + "parameters": { + "name": { + "description": "Required. The name of the model.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/models/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { "response": { "$ref": "GoogleLongrunning__Operation" }, @@ -1406,67 +1510,40 @@ "name" ], "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "updateMask": { + "location": "query", "description": "Required. Specifies the path, relative to `Model`, of the field to update.\n\nFor example, to change the description of a model to \"foo\" and set its\ndefault version to \"version_1\", the `update_mask` parameter would be\nspecified as `description`, `default_version.name`, and the `PATCH`\nrequest body would specify the new value, as follows:\n {\n \"description\": \"foo\",\n \"defaultVersion\": {\n \"name\":\"version_1\"\n }\n }\nIn this example, the model is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your model resource.\n\nCurrently the supported update masks are `description`,\n`default_version.name`, `labels`, and `etag`.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "name": { + "pattern": "^projects/[^/]+/models/[^/]+$", + "location": "path", "description": "Required. The project name.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/models/{modelsId}", - "path": "v1/{+name}", - "id": "ml.projects.models.patch" - }, - "get": { - "flatPath": "v1/projects/{projectsId}/models/{modelsId}", - "path": "v1/{+name}", - "id": "ml.projects.models.get", - "description": "Gets information about a model, including its name, the description (if\nset), and the default version (if at least one version of the model has\nbeen deployed).", - "response": { - "$ref": "GoogleCloudMlV1__Model" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the model.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+$" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1/projects/{projectsId}/models/{modelsId}", + "path": "v1/{+name}", + "id": "ml.projects.models.patch", + "request": { + "$ref": "GoogleCloudMlV1__Model" + }, + "description": "Updates a specific model resource.\n\nCurrently the only supported fields to update are `description` and\n`default_version.name`." }, "testIamPermissions": { - "path": "v1/{+resource}:testIamPermissions", - "id": "ml.projects.models.testIamPermissions", - "request": { - "$ref": "GoogleIamV1__TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "response": { - "$ref": "GoogleIamV1__TestIamPermissionsResponse" - }, + "httpMethod": "POST", "parameterOrder": [ "resource" ], - "httpMethod": "POST", + "response": { + "$ref": "GoogleIamV1__TestIamPermissionsResponse" + }, "parameters": { "resource": { "location": "path", @@ -1479,67 +1556,19 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions" - }, - "delete": { - "response": { - "$ref": "GoogleLongrunning__Operation" + "flatPath": "v1/projects/{projectsId}/models/{modelsId}:testIamPermissions", + "id": "ml.projects.models.testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "request": { + "$ref": "GoogleIamV1__TestIamPermissionsRequest" }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the model.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/models/{modelsId}", - "path": "v1/{+name}", - "id": "ml.projects.models.delete", - "description": "Deletes a model.\n\nYou can only delete a model if there are no versions in it. You can delete\nversions by calling\n[projects.models.versions.delete](/ml-engine/reference/rest/v1/projects.models.versions/delete)." + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." } }, "resources": { "versions": { "methods": { - "setDefault": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleCloudMlV1__Version" - }, - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault", - "id": "ml.projects.models.versions.setDefault", - "path": "v1/{+name}:setDefault", - "request": { - "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest" - }, - "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method." - }, "delete": { - "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version.", "response": { "$ref": "GoogleLongrunning__Operation" }, @@ -1561,10 +1590,10 @@ ], "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}", "path": "v1/{+name}", - "id": "ml.projects.models.versions.delete" + "id": "ml.projects.models.versions.delete", + "description": "Deletes a model version.\n\nEach model can have multiple versions deployed and in use at any given\ntime. Use this method to remove a single version.\n\nNote: You cannot delete the version that is set as the default version\nof the model unless it is the only remaining version." }, "list": { - "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has many versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages).\n\nIf there are no versions that match the request parameters, the list\nrequest returns an empty response body: {}.", "response": { "$ref": "GoogleCloudMlV1__ListVersionsResponse" }, @@ -1576,6 +1605,13 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { + "parent": { + "pattern": "^projects/[^/]+/models/[^/]+$", + "location": "path", + "description": "Required. The name of the model for which to list the version.", + "required": true, + "type": "string" + }, "filter": { "location": "query", "description": "Optional. Specifies the subset of versions to retrieve.", @@ -1587,22 +1623,16 @@ "type": "string" }, "pageSize": { - "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", - "format": "int32", "type": "integer", - "location": "query" - }, - "parent": { - "pattern": "^projects/[^/]+/models/[^/]+$", - "location": "path", - "description": "Required. The name of the model for which to list the version.", - "required": true, - "type": "string" + "location": "query", + "description": "Optional. The number of versions to retrieve per \"page\" of results. If\nthere are more remaining results than this number, the response message\nwill contain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", + "format": "int32" } }, "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions", "path": "v1/{+parent}/versions", - "id": "ml.projects.models.versions.list" + "id": "ml.projects.models.versions.list", + "description": "Gets basic information about all the versions of a model.\n\nIf you expect that a model has many versions, or if you need to handle\nonly a limited number of results at a time, you can request that the list\nbe retrieved in batches (called pages).\n\nIf there are no versions that match the request parameters, the list\nrequest returns an empty response body: {}." }, "create": { "response": { @@ -1612,31 +1642,33 @@ "parent" ], "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the model.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/models/[^/]+$", - "location": "path" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "parameters": { + "parent": { + "pattern": "^projects/[^/]+/models/[^/]+$", + "location": "path", + "description": "Required. The name of the model.", + "required": true, + "type": "string" + } + }, "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions", "path": "v1/{+parent}/versions", "id": "ml.projects.models.versions.create", + "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault).", "request": { "$ref": "GoogleCloudMlV1__Version" - }, - "description": "Creates a new version of a model from a trained TensorFlow model.\n\nIf the version created in the cloud by this call is the first deployed\nversion of the specified model, it will be made the default version of the\nmodel. When you add a version to a model that already has one or more\nversions, the default version does not automatically change. If you want a\nnew version to be the default, you must call\n[projects.models.versions.setDefault](/ml-engine/reference/rest/v1/projects.models.versions/setDefault)." + } }, "patch": { - "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`.", + "path": "v1/{+name}", + "id": "ml.projects.models.versions.patch", "request": { "$ref": "GoogleCloudMlV1__Version" }, + "description": "Updates the specified Version resource.\n\nCurrently the only supported field to update is `description`.", "response": { "$ref": "GoogleLongrunning__Operation" }, @@ -1644,41 +1676,17 @@ "name" ], "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "updateMask": { + "location": "query", "description": "Required. Specifies the path, relative to `Version`, of the field to\nupdate. Must be present and non-empty.\n\nFor example, to change the description of a version to \"foo\", the\n`update_mask` parameter would be specified as `description`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"description\": \"foo\"\n }\nIn this example, the version is blindly overwritten since no etag is given.\n\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your version resource.\n\nCurrently the only supported update masks are `description`, `labels`, and\n`etag`, and `expire_time`.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "name": { - "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$", "location": "path", "description": "Required. The name of the model.", "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}", - "path": "v1/{+name}", - "id": "ml.projects.models.versions.patch" - }, - "get": { - "response": { - "$ref": "GoogleCloudMlV1__Version" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the version.", - "required": true, "type": "string", "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$" } @@ -1686,10 +1694,60 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], + "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}" + }, + "get": { + "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model.", + "response": { + "$ref": "GoogleCloudMlV1__Version" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$", + "location": "path", + "description": "Required. The name of the version.", + "required": true, + "type": "string" + } + }, "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}", "path": "v1/{+name}", - "id": "ml.projects.models.versions.get", - "description": "Gets information about a model version.\n\nModels can have multiple versions. You can call\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list)\nto get the same information that this method returns for all of the\nversions of a model." + "id": "ml.projects.models.versions.get" + }, + "setDefault": { + "response": { + "$ref": "GoogleCloudMlV1__Version" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "Required. The name of the version to make the default for the model. You\ncan get the names of all the versions of a model by calling\n[projects.models.versions.list](/ml-engine/reference/rest/v1/projects.models.versions/list).", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/models/[^/]+/versions/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/models/{modelsId}/versions/{versionsId}:setDefault", + "path": "v1/{+name}:setDefault", + "id": "ml.projects.models.versions.setDefault", + "request": { + "$ref": "GoogleCloudMlV1__SetDefaultVersionRequest" + }, + "description": "Designates a version to be the default for the model.\n\nThe default version is used for prediction requests made against the model\nthat don't specify a version.\n\nThe first version to be created for a model is automatically set as the\ndefault. You must make any subsequent changes to the default version\nsetting manually using this method." } } } @@ -1698,6 +1756,7 @@ "locations": { "methods": { "get": { + "description": "Get the complete list of CMLE capabilities in a location, along with their\nlocation-specific properties.", "response": { "$ref": "GoogleCloudMlV1__Location" }, @@ -1707,11 +1766,11 @@ "httpMethod": "GET", "parameters": { "name": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", "description": "Required. The name of the location.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ @@ -1719,10 +1778,12 @@ ], "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "path": "v1/{+name}", - "id": "ml.projects.locations.get", - "description": "Get the complete list of CMLE capabilities in a location, along with their\nlocation-specific properties." + "id": "ml.projects.locations.get" }, "list": { + "path": "v1/{+parent}/locations", + "id": "ml.projects.locations.list", + "description": "List all locations that provides at least one type of CMLE capability.", "response": { "$ref": "GoogleCloudMlV1__ListLocationsResponse" }, @@ -1731,66 +1792,37 @@ ], "httpMethod": "GET", "parameters": { + "pageToken": { + "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.", + "type": "string", + "location": "query" + }, "pageSize": { + "type": "integer", "location": "query", "description": "Optional. The number of locations to retrieve per \"page\" of results. If there\nare more remaining results than this number, the response message will\ncontain a valid value in the `next_page_token` field.\n\nThe default value is 20, and the maximum page size is 100.", - "format": "int32", - "type": "integer" + "format": "int32" }, "parent": { + "location": "path", "description": "Required. The name of the project for which available locations are to be\nlisted (since some locations might be whitelisted for specific projects).", "required": true, "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "Optional. A page token to request the next page of results.\n\nYou get the token from the `next_page_token` field of the response from\nthe previous call.", - "type": "string" + "pattern": "^projects/[^/]+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectsId}/locations", - "path": "v1/{+parent}/locations", - "id": "ml.projects.locations.list", - "description": "List all locations that provides at least one type of CMLE capability." + "flatPath": "v1/projects/{projectsId}/locations" } } }, "jobs": { "methods": { - "cancel": { - "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel", - "id": "ml.projects.jobs.cancel", - "path": "v1/{+name}:cancel", - "request": { - "$ref": "GoogleCloudMlV1__CancelJobRequest" - }, - "description": "Cancels a running job.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "GoogleProtobuf__Empty" - }, - "parameters": { - "name": { - "description": "Required. The name of the job to cancel.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/jobs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, "getIamPolicy": { + "path": "v1/{+resource}:getIamPolicy", + "id": "ml.projects.jobs.getIamPolicy", "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", "response": { "$ref": "GoogleIamV1__Policy" @@ -1801,21 +1833,48 @@ "httpMethod": "GET", "parameters": { "resource": { + "pattern": "^projects/[^/]+/jobs/[^/]+$", + "location": "path", "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/jobs/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "ml.projects.jobs.getIamPolicy" + "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:getIamPolicy" + }, + "get": { + "path": "v1/{+name}", + "id": "ml.projects.jobs.get", + "description": "Describes a job.", + "response": { + "$ref": "GoogleCloudMlV1__Job" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "location": "path", + "description": "Required. The name of the job to get the description of.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/jobs/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}" }, "patch": { + "description": "Updates a specific job resource.\n\nCurrently the only supported fields to update are `labels`.", + "request": { + "$ref": "GoogleCloudMlV1__Job" + }, "response": { "$ref": "GoogleCloudMlV1__Job" }, @@ -1823,12 +1882,15 @@ "name" ], "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "updateMask": { + "location": "query", "description": "Required. Specifies the path, relative to `Job`, of the field to update.\nTo adopt etag mechanism, include `etag` field in the mask, and include the\n`etag` value in your job resource.\n\nFor example, to change the labels of a job, the `update_mask` parameter\nwould be specified as `labels`, `etag`, and the\n`PATCH` request body would specify the new value, as follows:\n {\n \"labels\": {\n \"owner\": \"Google\",\n \"color\": \"Blue\"\n }\n \"etag\": \"33a64df551425fcc55e4d42a148795d9f25f89d4\"\n }\nIf `etag` matches the one on the server, the labels of the job will be\nreplaced with the given ones, and the server end `etag` will be\nrecalculated.\n\nCurrently the only supported update masks are `labels` and `etag`.", "format": "google-fieldmask", - "type": "string", - "location": "query" + "type": "string" }, "name": { "description": "Required. The job name.", @@ -1838,29 +1900,14 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}", "path": "v1/{+name}", - "id": "ml.projects.jobs.patch", - "request": { - "$ref": "GoogleCloudMlV1__Job" - }, - "description": "Updates a specific job resource.\n\nCurrently the only supported fields to update are `labels`." + "id": "ml.projects.jobs.patch" }, - "get": { - "description": "Describes a job.", - "response": { - "$ref": "GoogleCloudMlV1__Job" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", + "testIamPermissions": { "parameters": { - "name": { - "description": "Required. The name of the job to get the description of.", + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^projects/[^/]+/jobs/[^/]+$", @@ -1870,37 +1917,20 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}", - "path": "v1/{+name}", - "id": "ml.projects.jobs.get" - }, - "testIamPermissions": { + "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions", + "id": "ml.projects.jobs.testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", "request": { "$ref": "GoogleIamV1__TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "response": { - "$ref": "GoogleIamV1__TestIamPermissionsResponse" - }, + "httpMethod": "POST", "parameterOrder": [ "resource" ], - "httpMethod": "POST", - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/jobs/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "ml.projects.jobs.testIamPermissions" + "response": { + "$ref": "GoogleIamV1__TestIamPermissionsResponse" + } }, "list": { "response": { @@ -1910,18 +1940,21 @@ "parent" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { "parent": { - "description": "Required. The name of the project for which to list jobs.", "required": true, "type": "string", "pattern": "^projects/[^/]+$", - "location": "path" + "location": "path", + "description": "Required. The name of the project for which to list jobs." }, "filter": { + "location": "query", "description": "Optional. Specifies the subset of jobs to retrieve.\nYou can filter on the value of one or more attributes of the job object.\nFor example, retrieve jobs with a job identifier that starts with 'census':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:census*'\u003c/code\u003e\n\u003cp\u003eList all failed jobs with names that start with 'rnn':\n\u003cp\u003e\u003ccode\u003egcloud ml-engine jobs list --filter='jobId:rnn*\nAND state:FAILED'\u003c/code\u003e\n\u003cp\u003eFor more examples, see the guide to\n\u003ca href=\"/ml-engine/docs/monitor-training\"\u003emonitoring jobs\u003c/a\u003e.", - "type": "string", - "location": "query" + "type": "string" }, "pageToken": { "location": "query", @@ -1935,124 +1968,94 @@ "location": "query" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "flatPath": "v1/projects/{projectsId}/jobs", "path": "v1/{+parent}/jobs", "id": "ml.projects.jobs.list", "description": "Lists the jobs in the project.\n\nIf there are no jobs that match the request parameters, the list\nrequest returns an empty response body: {}." }, - "setIamPolicy": { - "path": "v1/{+resource}:setIamPolicy", - "id": "ml.projects.jobs.setIamPolicy", - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", - "request": { - "$ref": "GoogleIamV1__SetIamPolicyRequest" - }, - "response": { - "$ref": "GoogleIamV1__Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/jobs/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy" - }, "create": { - "path": "v1/{+parent}/jobs", - "id": "ml.projects.jobs.create", - "description": "Creates a training or a batch prediction job.", - "request": { - "$ref": "GoogleCloudMlV1__Job" - }, - "response": { - "$ref": "GoogleCloudMlV1__Job" - }, + "httpMethod": "POST", "parameterOrder": [ "parent" ], + "response": { + "$ref": "GoogleCloudMlV1__Job" + }, + "parameters": { + "parent": { + "location": "path", + "description": "Required. The project name.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/jobs", + "id": "ml.projects.jobs.create", + "path": "v1/{+parent}/jobs", + "request": { + "$ref": "GoogleCloudMlV1__Job" + }, + "description": "Creates a training or a batch prediction job." + }, + "setIamPolicy": { + "request": { + "$ref": "GoogleIamV1__SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "GoogleIamV1__Policy" + }, + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/jobs/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:setIamPolicy", + "id": "ml.projects.jobs.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy" + }, + "cancel": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "GoogleProtobuf__Empty" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { - "parent": { - "description": "Required. The project name.", + "name": { "required": true, "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" + "pattern": "^projects/[^/]+/jobs/[^/]+$", + "location": "path", + "description": "Required. The name of the job to cancel." } }, - "flatPath": "v1/projects/{projectsId}/jobs" - } - } - } - }, - "methods": { - "getConfig": { - "path": "v1/{+name}:getConfig", - "id": "ml.projects.getConfig", - "description": "Get the service account information associated with your project. You need\nthis information in order to grant the service account persmissions for\nthe Google Cloud Storage location where you put your model training code\nfor training the model with Google Cloud Machine Learning.", - "response": { - "$ref": "GoogleCloudMlV1__GetConfigResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. The project name.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}:getConfig" - }, - "predict": { - "flatPath": "v1/projects/{projectsId}:predict", - "path": "v1/{+name}:predict", - "id": "ml.projects.predict", - "description": "Performs prediction on the data in the request.\nCloud ML Engine implements a custom `predict` verb on top of an HTTP POST\nmethod. \u003cp\u003eFor details of the request and response format, see the **guide\nto the [predict request format](/ml-engine/docs/v1/predict-request)**.", - "request": { - "$ref": "GoogleCloudMlV1__PredictRequest" - }, - "response": { - "$ref": "GoogleApi__HttpBody" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "Required. The resource name of a model or a version.\n\nAuthorization: requires the `predict` permission on the specified resource.", - "required": true, - "type": "string", - "pattern": "^projects/.+$", - "location": "path" + "flatPath": "v1/projects/{projectsId}/jobs/{jobsId}:cancel", + "id": "ml.projects.jobs.cancel", + "path": "v1/{+name}:cancel", + "description": "Cancels a running job.", + "request": { + "$ref": "GoogleCloudMlV1__CancelJobRequest" + } } } } @@ -2060,6 +2063,76 @@ } }, "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, "pp": { "description": "Pretty-print response.", "type": "boolean", @@ -2072,84 +2145,11 @@ "type": "string" }, "bearer_token": { + "location": "query", "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", "type": "string" } }, "version": "v1", - "baseUrl": "https://ml.googleapis.com/", - "kind": "discovery#restDescription", - "description": "An API to enable creating and using machine learning models.", - "servicePath": "" + "baseUrl": "https://ml.googleapis.com/" }
diff --git a/monitoring/v3/monitoring-api.json b/monitoring/v3/monitoring-api.json index 4297bb5..70fc800 100644 --- a/monitoring/v3/monitoring-api.json +++ b/monitoring/v3/monitoring-api.json
@@ -1,22 +1,348 @@ { - "basePath": "", "id": "monitoring:v3", "documentationLink": "https://cloud.google.com/monitoring/api/", "revision": "20180102", "discoveryVersion": "v1", "version_module": true, "schemas": { + "MonitoredResourceMetadata": { + "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion pipeline to extract metadata for cloud resources of all types , and stores the metadata in this message.", + "type": "object", + "properties": { + "userLabels": { + "additionalProperties": { + "type": "string" + }, + "description": "Output only. A map of user-defined metadata labels.", + "type": "object" + }, + "systemLabels": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google Stackdriver. Stackdriver determines what system labels are useful and how to obtain their values. Some examples: \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example:\n{ \"name\": \"my-test-instance\",\n \"security_group\": [\"a\", \"b\", \"c\"],\n \"spot_instance\": false }\n", + "type": "object" + } + }, + "id": "MonitoredResourceMetadata" + }, + "BucketOptions": { + "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", + "type": "object", + "properties": { + "linearBuckets": { + "$ref": "Linear", + "description": "The linear bucket." + }, + "explicitBuckets": { + "$ref": "Explicit", + "description": "The explicit buckets." + }, + "exponentialBuckets": { + "description": "The exponential buckets.", + "$ref": "Exponential" + } + }, + "id": "BucketOptions" + }, + "HttpCheck": { + "properties": { + "useSsl": { + "description": "If true, use HTTPS instead of HTTP to run the check.", + "type": "boolean" + }, + "maskHeaders": { + "description": "Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.", + "type": "boolean" + }, + "authInfo": { + "$ref": "BasicAuthentication", + "description": "The authentication information. Optional when creating an HTTP check; defaults to empty." + }, + "headers": { + "additionalProperties": { + "type": "string" + }, + "description": "The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second.", + "type": "object" + }, + "path": { + "description": "The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to \"/\").", + "type": "string" + }, + "port": { + "description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).", + "format": "int32", + "type": "integer" + } + }, + "id": "HttpCheck", + "description": "Information involved in an HTTP/HTTPS uptime check request.", + "type": "object" + }, + "CollectdValue": { + "description": "A single data point from a collectd-based plugin.", + "type": "object", + "properties": { + "value": { + "description": "The measurement value.", + "$ref": "TypedValue" + }, + "dataSourceType": { + "enumDescriptions": [ + "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.", + "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.", + "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.", + "A rate of change of the measurement.", + "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA." + ], + "enum": [ + "UNSPECIFIED_DATA_SOURCE_TYPE", + "GAUGE", + "COUNTER", + "DERIVE", + "ABSOLUTE" + ], + "description": "The type of measurement.", + "type": "string" + }, + "dataSourceName": { + "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".", + "type": "string" + } + }, + "id": "CollectdValue" + }, + "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", + "type": "object", + "properties": { + "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 field, or localized by the client.", + "type": "string" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + } + }, + "id": "Status" + }, + "MetricDescriptor": { + "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.", + "type": "object", + "properties": { + "unit": { + "description": "Optional. The unit in which the metric value is reported. For example, kBy/s means kilobytes/sec, and 1 is the dimensionless unit. The supported units are a subset of The Unified Code for Units of Measure standard (http://unitsofmeasure.org/ucum.html).\u003cbr\u003e\u003cbr\u003e This field is part of the metric's documentation, but it is ignored by Stackdriver.", + "type": "string" + }, + "labels": { + "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + }, + "name": { + "description": "The resource name of the metric descriptor.", + "type": "string" + }, + "type": { + "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n", + "type": "string" + }, + "valueType": { + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "BOOL", + "INT64", + "DOUBLE", + "STRING", + "DISTRIBUTION", + "MONEY" + ], + "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.", + "type": "string", + "enumDescriptions": [ + "Do not use this default value.", + "The value is a boolean. This value type can be used only if the metric kind is GAUGE.", + "The value is a signed 64-bit integer.", + "The value is a double precision floating point number.", + "The value is a text string. This value type can be used only if the metric kind is GAUGE.", + "The value is a Distribution.", + "The value is money." + ] + }, + "metricKind": { + "enum": [ + "METRIC_KIND_UNSPECIFIED", + "GAUGE", + "DELTA", + "CUMULATIVE" + ], + "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.", + "type": "string", + "enumDescriptions": [ + "Do not use this default value.", + "An instantaneous measurement of a value.", + "The change in a value during a time interval.", + "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points." + ] + }, + "description": { + "description": "A detailed description of the metric, which can be used in documentation.", + "type": "string" + }, + "displayName": { + "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.", + "type": "string" + } + }, + "id": "MetricDescriptor" + }, + "SourceContext": { + "properties": { + "fileName": { + "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".", + "type": "string" + } + }, + "id": "SourceContext", + "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.", + "type": "object" + }, + "Range": { + "description": "The range of the population values.", + "type": "object", + "properties": { + "min": { + "description": "The minimum of the population values.", + "format": "double", + "type": "number" + }, + "max": { + "description": "The maximum of the population values.", + "format": "double", + "type": "number" + } + }, + "id": "Range" + }, + "ListGroupsResponse": { + "description": "The ListGroups response.", + "type": "object", + "properties": { + "group": { + "description": "The groups that match the specified filters.", + "type": "array", + "items": { + "$ref": "Group" + } + }, + "nextPageToken": { + "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.", + "type": "string" + } + }, + "id": "ListGroupsResponse" + }, + "UptimeCheckConfig": { + "description": "This message configures which resources and services to monitor for availability.", + "type": "object", + "properties": { + "displayName": { + "description": "A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.", + "type": "string" + }, + "monitoredResource": { + "description": "The monitored resource associated with the configuration.", + "$ref": "MonitoredResource" + }, + "contentMatchers": { + "description": "The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.", + "type": "array", + "items": { + "$ref": "ContentMatcher" + } + }, + "timeout": { + "description": "The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.", + "format": "google-duration", + "type": "string" + }, + "period": { + "description": "How often the uptime check is performed. Currently, only 1, 5, 10, and 15 minutes are supported. Required.", + "format": "google-duration", + "type": "string" + }, + "httpCheck": { + "description": "Contains information needed to make an HTTP or HTTPS check.", + "$ref": "HttpCheck" + }, + "name": { + "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.", + "type": "string" + }, + "resourceGroup": { + "description": "The group resource associated with the configuration.", + "$ref": "ResourceGroup" + }, + "tcpCheck": { + "$ref": "TcpCheck", + "description": "Contains information needed to make a TCP check." + }, + "internalCheckers": { + "description": "The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all InternalCheckers configured for the project that owns this CheckConfig.", + "type": "array", + "items": { + "$ref": "InternalChecker" + } + }, + "isInternal": { + "description": "Denotes whether this is a check that egresses from InternalCheckers.", + "type": "boolean" + }, + "selectedRegions": { + "enumDescriptions": [ + "Default value if no region is specified. Will result in uptime checks running from all regions.", + "Allows checks to run from locations within the United States of America.", + "Allows checks to run from locations within the continent of Europe.", + "Allows checks to run from locations within the continent of South America.", + "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)." + ], + "description": "The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.", + "type": "array", + "items": { + "enum": [ + "REGION_UNSPECIFIED", + "USA", + "EUROPE", + "SOUTH_AMERICA", + "ASIA_PACIFIC" + ], + "type": "string" + } + } + }, + "id": "UptimeCheckConfig" + }, "ListGroupMembersResponse": { "description": "The ListGroupMembers response.", "type": "object", "properties": { - "members": { - "description": "A set of monitored resources in the group.", - "type": "array", - "items": { - "$ref": "MonitoredResource" - } - }, "nextPageToken": { "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.", "type": "string" @@ -25,13 +351,18 @@ "description": "The total number of elements matching this request.", "format": "int32", "type": "integer" + }, + "members": { + "description": "A set of monitored resources in the group.", + "type": "array", + "items": { + "$ref": "MonitoredResource" + } } }, "id": "ListGroupMembersResponse" }, "CreateCollectdTimeSeriesRequest": { - "description": "The CreateCollectdTimeSeries request.", - "type": "object", "properties": { "resource": { "$ref": "MonitoredResource", @@ -49,7 +380,9 @@ "type": "string" } }, - "id": "CreateCollectdTimeSeriesRequest" + "id": "CreateCollectdTimeSeriesRequest", + "description": "The CreateCollectdTimeSeries request.", + "type": "object" }, "ListMonitoredResourceDescriptorsResponse": { "description": "The ListMonitoredResourceDescriptors response.", @@ -70,9 +403,18 @@ "id": "ListMonitoredResourceDescriptorsResponse" }, "TimeSeries": { - "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.", - "type": "object", "properties": { + "metric": { + "$ref": "Metric", + "description": "The associated metric. A fully-specified metric used to identify the time series." + }, + "points": { + "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.", + "type": "array", + "items": { + "$ref": "Point" + } + }, "resource": { "$ref": "MonitoredResource", "description": "The associated monitored resource. Custom metrics can use only certain monitored resource types in their time series data." @@ -82,6 +424,15 @@ "description": "Output only. The associated monitored resource metadata. When reading a a timeseries, this field will include metadata labels that are explicitly named in the reduction. When creating a timeseries, this field is ignored." }, "valueType": { + "enum": [ + "VALUE_TYPE_UNSPECIFIED", + "BOOL", + "INT64", + "DOUBLE", + "STRING", + "DISTRIBUTION", + "MONEY" + ], "description": "The value type of the time series. When listing time series, this value type might be different from the value type of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the type of the data in the points field.", "type": "string", "enumDescriptions": [ @@ -92,20 +443,9 @@ "The value is a text string. This value type can be used only if the metric kind is GAUGE.", "The value is a Distribution.", "The value is money." - ], - "enum": [ - "VALUE_TYPE_UNSPECIFIED", - "BOOL", - "INT64", - "DOUBLE", - "STRING", - "DISTRIBUTION", - "MONEY" ] }, "metricKind": { - "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.", - "type": "string", "enumDescriptions": [ "Do not use this default value.", "An instantaneous measurement of a value.", @@ -117,21 +457,14 @@ "GAUGE", "DELTA", "CUMULATIVE" - ] - }, - "points": { - "description": "The data points of this time series. When listing time series, the order of the points is specified by the list method.When creating a time series, this field must contain exactly one point and the point's type must be the same as the value type of the associated metric. If the associated metric's descriptor must be auto-created, then the value type of the descriptor is determined by the point's type, which must be BOOL, INT64, DOUBLE, or DISTRIBUTION.", - "type": "array", - "items": { - "$ref": "Point" - } - }, - "metric": { - "$ref": "Metric", - "description": "The associated metric. A fully-specified metric used to identify the time series." + ], + "description": "The metric kind of the time series. When listing time series, this metric kind might be different from the metric kind of the associated metric if this time series is an alignment or reduction of other time series.When creating a time series, this field is optional. If present, it must be the same as the metric kind of the associated metric. If the associated metric's descriptor must be auto-created, then this field specifies the metric kind of the new descriptor and must be either GAUGE (the default) or CUMULATIVE.", + "type": "string" } }, - "id": "TimeSeries" + "id": "TimeSeries", + "description": "A collection of data points that describes the time-varying values of a metric. A time series is identified by a combination of a fully-specified monitored resource and a fully-specified metric. This type is used for both listing and creating time series.", + "type": "object" }, "CreateTimeSeriesRequest": { "description": "The CreateTimeSeries request.", @@ -148,8 +481,6 @@ "id": "CreateTimeSeriesRequest" }, "Distribution": { - "description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.", - "type": "object", "properties": { "sumOfSquaredDeviation": { "description": "The sum of squared deviations from the mean of the values in the population. For values x_i this is:\nSum[i=1..n]((x_i - mean)^2)\nKnuth, \"The Art of Computer Programming\", Vol. 2, page 323, 3rd edition describes Welford's method for accumulating this sum in one pass.If count is zero then this field must be zero.", @@ -179,26 +510,28 @@ } }, "bucketOptions": { - "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries.", - "$ref": "BucketOptions" + "$ref": "BucketOptions", + "description": "Required in the Stackdriver Monitoring API v3. Defines the histogram bucket boundaries." } }, - "id": "Distribution" + "id": "Distribution", + "description": "Distribution contains summary statistics for a population of values. It optionally contains a histogram representing the distribution of those values across a set of buckets.The summary statistics are the count, mean, sum of the squared deviation from the mean, the minimum, and the maximum of the set of population of values. The histogram is based on a sequence of buckets and gives a count of values that fall into each bucket. The boundaries of the buckets are given either explicitly or by formulas for buckets of fixed or exponentially increasing widths.Although it is not forbidden, it is generally a bad idea to include non-finite values (infinities or NaNs) in the population of values, as this will render the mean and sum_of_squared_deviation fields meaningless.", + "type": "object" }, "MonitoredResource": { "description": "An object representing a resource that can be used for monitoring, logging, billing, or other purposes. Examples include virtual machine instances, databases, and storage devices such as disks. The type field identifies a MonitoredResourceDescriptor object that describes the resource's schema. Information in the labels field identifies the actual resource and its attributes according to the schema. For example, a particular Compute Engine VM instance could be represented by the following object, because the MonitoredResourceDescriptor for \"gce_instance\" has labels \"instance_id\" and \"zone\":\n{ \"type\": \"gce_instance\",\n \"labels\": { \"instance_id\": \"12345678901234\",\n \"zone\": \"us-central1-a\" }}\n", "type": "object", "properties": { + "type": { + "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.", + "type": "string" + }, "labels": { "additionalProperties": { "type": "string" }, "description": "Required. Values for all of the labels listed in the associated monitored resource descriptor. For example, Compute Engine VM instances use the labels \"project_id\", \"instance_id\", and \"zone\".", "type": "object" - }, - "type": { - "description": "Required. The monitored resource type. This field must match the type field of a MonitoredResourceDescriptor object. For example, the type of a Compute Engine VM instance is gce_instance.", - "type": "string" } }, "id": "MonitoredResource" @@ -248,6 +581,17 @@ "description": "An object that describes the schema of a MonitoredResource object using a type name and a set of labels. For example, the monitored resource descriptor for Google Compute Engine VM instances has a type of \"gce_instance\" and specifies the use of the labels \"instance_id\" and \"zone\" to identify particular VM instances.Different APIs can support different monitored resource types. APIs generally provide a list method that returns the monitored resource descriptors used by the API.", "type": "object", "properties": { + "labels": { + "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + }, + "name": { + "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".", + "type": "string" + }, "displayName": { "description": "Optional. A concise name for the monitored resource type that might be displayed in user interfaces. It should be a Title Cased Noun Phrase, without any article or other determiners. For example, \"Google Cloud SQL Database\".", "type": "string" @@ -259,54 +603,18 @@ "type": { "description": "Required. The monitored resource type. For example, the type \"cloudsql_database\" represents databases in Google Cloud SQL. The maximum length of this value is 256 characters.", "type": "string" - }, - "labels": { - "description": "Required. A set of labels used to describe instances of this monitored resource type. For example, an individual Google Cloud SQL database is identified by values for the labels \"database_id\" and \"zone\".", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } - }, - "name": { - "description": "Optional. The resource name of the monitored resource descriptor: \"projects/{project_id}/monitoredResourceDescriptors/{type}\" where {type} is the value of the type field in this object and {project_id} is a project ID that provides API-specific context for accessing the type. APIs that do not use project information can use the resource name format \"monitoredResourceDescriptors/{type}\".", - "type": "string" } }, "id": "MonitoredResourceDescriptor" }, - "TypedValue": { - "description": "A single strongly-typed value.", - "type": "object", - "properties": { - "doubleValue": { - "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.", - "format": "double", - "type": "number" - }, - "int64Value": { - "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.", - "format": "int64", - "type": "string" - }, - "distributionValue": { - "$ref": "Distribution", - "description": "A distribution value." - }, - "boolValue": { - "description": "A Boolean value: true or false.", - "type": "boolean" - }, - "stringValue": { - "description": "A variable-length string value.", - "type": "string" - } - }, - "id": "TypedValue" - }, "ResourceGroup": { "description": "The resource submessage for group checks. It can be used instead of a monitored resource, when multiple resources are being monitored.", "type": "object", "properties": { + "groupId": { + "description": "The group of resources being monitored. Should be only the group_id, not projects/\u003cproject_id\u003e/groups/\u003cgroup_id\u003e.", + "type": "string" + }, "resourceType": { "enumDescriptions": [ "Default value (not valid).", @@ -320,29 +628,38 @@ ], "description": "The resource type of the group members.", "type": "string" - }, - "groupId": { - "description": "The group of resources being monitored. Should be only the group_id, not projects/\u003cproject_id\u003e/groups/\u003cgroup_id\u003e.", - "type": "string" } }, "id": "ResourceGroup" }, - "CollectdValueError": { - "description": "Describes the error status for values that were not written.", - "type": "object", + "TypedValue": { "properties": { - "error": { - "$ref": "Status", - "description": "Records the error status for the value." + "boolValue": { + "description": "A Boolean value: true or false.", + "type": "boolean" }, - "index": { - "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.", - "format": "int32", - "type": "integer" + "stringValue": { + "description": "A variable-length string value.", + "type": "string" + }, + "doubleValue": { + "description": "A 64-bit double-precision floating-point number. Its magnitude is approximately ±10\u003csup\u003e±300\u003c/sup\u003e and it has 16 significant digits of precision.", + "format": "double", + "type": "number" + }, + "int64Value": { + "description": "A 64-bit integer. Its range is approximately ±9.2x10\u003csup\u003e18\u003c/sup\u003e.", + "format": "int64", + "type": "string" + }, + "distributionValue": { + "$ref": "Distribution", + "description": "A distribution value." } }, - "id": "CollectdValueError" + "id": "TypedValue", + "description": "A single strongly-typed value.", + "type": "object" }, "UptimeCheckIp": { "description": "Contains the region, location, and list of IP addresses where checkers in the location run from.", @@ -353,6 +670,13 @@ "type": "string" }, "region": { + "enum": [ + "REGION_UNSPECIFIED", + "USA", + "EUROPE", + "SOUTH_AMERICA", + "ASIA_PACIFIC" + ], "description": "A broad region category in which the IP address is located.", "type": "string", "enumDescriptions": [ @@ -361,13 +685,6 @@ "Allows checks to run from locations within the continent of Europe.", "Allows checks to run from locations within the continent of South America.", "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)." - ], - "enum": [ - "REGION_UNSPECIFIED", - "USA", - "EUROPE", - "SOUTH_AMERICA", - "ASIA_PACIFIC" ] }, "location": { @@ -377,10 +694,49 @@ }, "id": "UptimeCheckIp" }, + "CollectdValueError": { + "description": "Describes the error status for values that were not written.", + "type": "object", + "properties": { + "index": { + "description": "The zero-based index in CollectdPayload.values within the parent CreateCollectdTimeSeriesRequest.collectd_payloads.", + "format": "int32", + "type": "integer" + }, + "error": { + "$ref": "Status", + "description": "Records the error status for the value." + } + }, + "id": "CollectdValueError" + }, "CollectdPayload": { "description": "A collection of data points sent from a collectd-based plugin. See the collectd documentation for more information.", "type": "object", "properties": { + "typeInstance": { + "description": "The measurement type instance. Example: \"used\".", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "$ref": "TypedValue" + }, + "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345", + "type": "object" + }, + "type": { + "description": "The measurement type. Example: \"memory\".", + "type": "string" + }, + "plugin": { + "description": "The name of the plugin. Example: \"disk\".", + "type": "string" + }, + "pluginInstance": { + "description": "The instance name of the plugin Example: \"hdcl\".", + "type": "string" + }, "endTime": { "description": "The end time of the interval.", "format": "google-datetime", @@ -397,29 +753,6 @@ "items": { "$ref": "CollectdValue" } - }, - "typeInstance": { - "description": "The measurement type instance. Example: \"used\".", - "type": "string" - }, - "type": { - "description": "The measurement type. Example: \"memory\".", - "type": "string" - }, - "metadata": { - "additionalProperties": { - "$ref": "TypedValue" - }, - "description": "The measurement metadata. Example: \"process_id\" -\u003e 12345", - "type": "object" - }, - "plugin": { - "description": "The name of the plugin. Example: \"disk\".", - "type": "string" - }, - "pluginInstance": { - "description": "The instance name of the plugin Example: \"hdcl\".", - "type": "string" } }, "id": "CollectdPayload" @@ -524,8 +857,6 @@ "id": "InternalChecker" }, "TcpCheck": { - "description": "Information required for a TCP uptime check request.", - "type": "object", "properties": { "port": { "description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) to construct the full URL. Required.", @@ -533,7 +864,24 @@ "type": "integer" } }, - "id": "TcpCheck" + "id": "TcpCheck", + "description": "Information required for a TCP uptime check request.", + "type": "object" + }, + "Explicit": { + "properties": { + "bounds": { + "description": "The values must be monotonically increasing.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + }, + "id": "Explicit", + "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.", + "type": "object" }, "TimeInterval": { "description": "A time interval extending just after a start time through an end time. If the start time is the same as the end time, then the interval represents a single point in time.", @@ -552,21 +900,6 @@ }, "id": "TimeInterval" }, - "Explicit": { - "description": "Specifies a set of buckets with arbitrary widths.There are size(bounds) + 1 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): boundsi Lower bound (1 \u003c= i \u003c N); boundsi - 1The bounds field must contain at least one element. If bounds has only one element, then there are no finite buckets, and that single element is the common boundary of the overflow and underflow buckets.", - "type": "object", - "properties": { - "bounds": { - "description": "The values must be monotonically increasing.", - "type": "array", - "items": { - "format": "double", - "type": "number" - } - } - }, - "id": "Explicit" - }, "ListUptimeCheckIpsResponse": { "description": "The protocol for the ListUptimeCheckIps response.", "type": "object", @@ -589,6 +922,11 @@ "description": "Specifies an exponential sequence of buckets that have a width that is proportional to the value of the lower bound. Each bucket represents a constant relative uncertainty on a specific value in the bucket.There are num_finite_buckets + 2 (= N) buckets. Bucket i has the following boundaries:Upper bound (0 \u003c= i \u003c N-1): scale * (growth_factor ^ i). Lower bound (1 \u003c= i \u003c N): scale * (growth_factor ^ (i - 1)).", "type": "object", "properties": { + "scale": { + "description": "Must be greater than 0.", + "format": "double", + "type": "number" + }, "numFiniteBuckets": { "description": "Must be greater than 0.", "format": "int32", @@ -598,11 +936,6 @@ "description": "Must be greater than 1.", "format": "double", "type": "number" - }, - "scale": { - "description": "Must be greater than 0.", - "format": "double", - "type": "number" } }, "id": "Exponential" @@ -611,13 +944,13 @@ "description": "A single data point in a time series.", "type": "object", "properties": { - "value": { - "description": "The value of the data point.", - "$ref": "TypedValue" - }, "interval": { "$ref": "TimeInterval", "description": "The time interval to which the data point applies. For GAUGE metrics, only the end time of the interval is used. For DELTA metrics, the start and end time should specify a non-zero interval, with subsequent points specifying contiguous and non-overlapping intervals. For CUMULATIVE metrics, the start and end time should specify a non-zero interval, with subsequent points specifying the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points." + }, + "value": { + "$ref": "TypedValue", + "description": "The value of the data point." } }, "id": "Point" @@ -626,16 +959,16 @@ "description": "A specific metric, identified by specifying values for all of the labels of a MetricDescriptor.", "type": "object", "properties": { - "type": { - "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.", - "type": "string" - }, "labels": { "additionalProperties": { "type": "string" }, "description": "The set of label values that uniquely identify this metric. All labels listed in the MetricDescriptor must be assigned values.", "type": "object" + }, + "type": { + "description": "An existing metric type, see google.api.MetricDescriptor. For example, custom.googleapis.com/invoice/paid/amount.", + "type": "string" } }, "id": "Metric" @@ -667,8 +1000,6 @@ "type": "string" }, "kind": { - "description": "The field type.", - "type": "string", "enumDescriptions": [ "Field type unknown.", "Field type double.", @@ -710,7 +1041,9 @@ "TYPE_SFIXED64", "TYPE_SINT32", "TYPE_SINT64" - ] + ], + "description": "The field type.", + "type": "string" }, "options": { "description": "The protocol buffer options.", @@ -768,27 +1101,27 @@ "description": "A description of a label.", "type": "object", "properties": { + "key": { + "description": "The label key.", + "type": "string" + }, "description": { "description": "A human-readable description for the label.", "type": "string" }, "valueType": { - "enumDescriptions": [ - "A variable-length string. This is the default.", - "Boolean; true or false.", - "A 64-bit signed integer." - ], "enum": [ "STRING", "BOOL", "INT64" ], "description": "The type of data that can be assigned to the label.", - "type": "string" - }, - "key": { - "description": "The label key.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "A variable-length string. This is the default.", + "Boolean; true or false.", + "A 64-bit signed integer." + ] } }, "id": "LabelDescriptor" @@ -797,68 +1130,20 @@ "description": "The ListTimeSeries response.", "type": "object", "properties": { + "nextPageToken": { + "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.", + "type": "string" + }, "timeSeries": { "description": "One or more time series that match the filter included in the request.", "type": "array", "items": { "$ref": "TimeSeries" } - }, - "nextPageToken": { - "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.", - "type": "string" } }, "id": "ListTimeSeriesResponse" }, - "Type": { - "description": "A protocol buffer message type.", - "type": "object", - "properties": { - "options": { - "description": "The protocol buffer options.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "fields": { - "description": "The list of fields.", - "type": "array", - "items": { - "$ref": "Field" - } - }, - "name": { - "description": "The fully qualified message name.", - "type": "string" - }, - "oneofs": { - "description": "The list of types appearing in oneof definitions in this type.", - "type": "array", - "items": { - "type": "string" - } - }, - "sourceContext": { - "description": "The source context.", - "$ref": "SourceContext" - }, - "syntax": { - "description": "The source syntax.", - "type": "string", - "enumDescriptions": [ - "Syntax proto2.", - "Syntax proto3." - ], - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ] - } - }, - "id": "Type" - }, "Group": { "description": "The description of a dynamic collection of monitored resources. Each group has a filter that is matched against monitored resources and their associated metadata. If a group's filter matches an available monitored resource, then that resource is a member of that group. Groups can contain any number of monitored resources, and each monitored resource can be a member of any number of groups.Groups can be nested in parent-child hierarchies. The parentName field identifies an optional parent for each group. If a group has a parent, then the only monitored resources available to be matched by the group's filter are the resources contained in the parent group. In other words, a group contains the monitored resources that match its filter and the filters of all the group's ancestors. A group without a parent can contain any monitored resource.For example, consider an infrastructure running a set of instances with two user-defined tags: \"environment\" and \"role\". A parent group has a filter, environment=\"production\". A child of that parent group has a filter, role=\"transcoder\". The parent group contains all instances in the production environment, regardless of their roles. The child group contains instances that have the transcoder role and are in the production environment.The monitored resources contained in a group can change at any moment, depending on what resources exist and what filters are associated with the group and its ancestors.", "type": "object", @@ -886,6 +1171,54 @@ }, "id": "Group" }, + "Type": { + "properties": { + "fields": { + "description": "The list of fields.", + "type": "array", + "items": { + "$ref": "Field" + } + }, + "name": { + "description": "The fully qualified message name.", + "type": "string" + }, + "oneofs": { + "description": "The list of types appearing in oneof definitions in this type.", + "type": "array", + "items": { + "type": "string" + } + }, + "sourceContext": { + "description": "The source context.", + "$ref": "SourceContext" + }, + "syntax": { + "enumDescriptions": [ + "Syntax proto2.", + "Syntax proto3." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ], + "description": "The source syntax.", + "type": "string" + }, + "options": { + "description": "The protocol buffer options.", + "type": "array", + "items": { + "$ref": "Option" + } + } + }, + "id": "Type", + "description": "A protocol buffer message type.", + "type": "object" + }, "BasicAuthentication": { "description": "A type of authentication to perform against the specified resource or URL that uses username and password. Currently, only Basic authentication is supported in Uptime Monitoring.", "type": "object", @@ -900,340 +1233,6 @@ } }, "id": "BasicAuthentication" - }, - "MonitoredResourceMetadata": { - "description": "Auxiliary metadata for a MonitoredResource object. MonitoredResource objects contain the minimum set of information to uniquely identify a monitored resource instance. There is some other useful auxiliary metadata. Google Stackdriver Monitoring & Logging uses an ingestion pipeline to extract metadata for cloud resources of all types , and stores the metadata in this message.", - "type": "object", - "properties": { - "systemLabels": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Output only. Values for predefined system metadata labels. System labels are a kind of metadata extracted by Google Stackdriver. Stackdriver determines what system labels are useful and how to obtain their values. Some examples: \"machine_image\", \"vpc\", \"subnet_id\", \"security_group\", \"name\", etc. System label values can be only strings, Boolean values, or a list of strings. For example:\n{ \"name\": \"my-test-instance\",\n \"security_group\": [\"a\", \"b\", \"c\"],\n \"spot_instance\": false }\n", - "type": "object" - }, - "userLabels": { - "description": "Output only. A map of user-defined metadata labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - }, - "id": "MonitoredResourceMetadata" - }, - "BucketOptions": { - "description": "BucketOptions describes the bucket boundaries used to create a histogram for the distribution. The buckets can be in a linear sequence, an exponential sequence, or each bucket can be specified explicitly. BucketOptions does not include the number of values in each bucket.A bucket has an inclusive lower bound and exclusive upper bound for the values that are counted for that bucket. The upper bound of a bucket must be strictly greater than the lower bound. The sequence of N buckets for a distribution consists of an underflow bucket (number 0), zero or more finite buckets (number 1 through N - 2) and an overflow bucket (number N - 1). The buckets are contiguous: the lower bound of bucket i (i \u003e 0) is the same as the upper bound of bucket i - 1. The buckets span the whole range of finite values: lower bound of the underflow bucket is -infinity and the upper bound of the overflow bucket is +infinity. The finite buckets are so-called because both bounds are finite.", - "type": "object", - "properties": { - "linearBuckets": { - "$ref": "Linear", - "description": "The linear bucket." - }, - "explicitBuckets": { - "$ref": "Explicit", - "description": "The explicit buckets." - }, - "exponentialBuckets": { - "$ref": "Exponential", - "description": "The exponential buckets." - } - }, - "id": "BucketOptions" - }, - "HttpCheck": { - "description": "Information involved in an HTTP/HTTPS uptime check request.", - "type": "object", - "properties": { - "port": { - "description": "The port to the page to run the check against. Will be combined with host (specified within the MonitoredResource) and path to construct the full URL. Optional (defaults to 80 without SSL, or 443 with SSL).", - "format": "int32", - "type": "integer" - }, - "headers": { - "additionalProperties": { - "type": "string" - }, - "description": "The list of headers to send as part of the uptime check request. If two headers have the same key and different values, they should be entered as a single header, with the value being a comma-separated list of all the desired values as described at https://www.w3.org/Protocols/rfc2616/rfc2616.txt (page 31). Entering two separate headers with the same key in a Create call will cause the first to be overwritten by the second.", - "type": "object" - }, - "path": { - "description": "The path to the page to run the check against. Will be combined with the host (specified within the MonitoredResource) and port to construct the full URL. Optional (defaults to \"/\").", - "type": "string" - }, - "useSsl": { - "description": "If true, use HTTPS instead of HTTP to run the check.", - "type": "boolean" - }, - "maskHeaders": { - "description": "Boolean specifiying whether to encrypt the header information. Encryption should be specified for any headers related to authentication that you do not wish to be seen when retrieving the configuration. The server will be responsible for encrypting the headers. On Get/List calls, if mask_headers is set to True then the headers will be obscured with ******.", - "type": "boolean" - }, - "authInfo": { - "description": "The authentication information. Optional when creating an HTTP check; defaults to empty.", - "$ref": "BasicAuthentication" - } - }, - "id": "HttpCheck" - }, - "CollectdValue": { - "description": "A single data point from a collectd-based plugin.", - "type": "object", - "properties": { - "value": { - "description": "The measurement value.", - "$ref": "TypedValue" - }, - "dataSourceType": { - "description": "The type of measurement.", - "type": "string", - "enumDescriptions": [ - "An unspecified data source type. This corresponds to google.api.MetricDescriptor.MetricKind.METRIC_KIND_UNSPECIFIED.", - "An instantaneous measurement of a varying quantity. This corresponds to google.api.MetricDescriptor.MetricKind.GAUGE.", - "A cumulative value over time. This corresponds to google.api.MetricDescriptor.MetricKind.CUMULATIVE.", - "A rate of change of the measurement.", - "An amount of change since the last measurement interval. This corresponds to google.api.MetricDescriptor.MetricKind.DELTA." - ], - "enum": [ - "UNSPECIFIED_DATA_SOURCE_TYPE", - "GAUGE", - "COUNTER", - "DERIVE", - "ABSOLUTE" - ] - }, - "dataSourceName": { - "description": "The data source for the collectd value. For example there are two data sources for network measurements: \"rx\" and \"tx\".", - "type": "string" - } - }, - "id": "CollectdValue" - }, - "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:\nSimple to use and understand for most users\nFlexible enough to meet unexpected needsOverviewThe 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, 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 that can be used for common error conditions.Language mappingThe 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 usesThe 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:\nPartial 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.\nWorkflow errors. A typical workflow has multiple steps. Each step may have a Status message for error reporting.\nBatch 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.\nAsynchronous 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.\nLogging. If some API errors are stored in logs, the message Status could be used directly after any stripping needed for security/privacy reasons.", - "type": "object", - "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 user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.", - "type": "string" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - } - }, - "id": "Status" - }, - "SourceContext": { - "description": "SourceContext represents information about the source of a protobuf element, like the file in which it is defined.", - "type": "object", - "properties": { - "fileName": { - "description": "The path-qualified name of the .proto file that contained the associated protobuf element. For example: \"google/protobuf/source_context.proto\".", - "type": "string" - } - }, - "id": "SourceContext" - }, - "MetricDescriptor": { - "description": "Defines a metric type and its schema. Once a metric descriptor is created, deleting or altering it stops data collection and makes the metric type's existing data unusable.", - "type": "object", - "properties": { - "metricKind": { - "description": "Whether the metric records instantaneous values, changes to a value, etc. Some combinations of metric_kind and value_type might not be supported.", - "type": "string", - "enumDescriptions": [ - "Do not use this default value.", - "An instantaneous measurement of a value.", - "The change in a value during a time interval.", - "A value accumulated over a time interval. Cumulative measurements in a time series should have the same start time and increasing end times, until an event resets the cumulative value to zero and sets a new start time for the following points." - ], - "enum": [ - "METRIC_KIND_UNSPECIFIED", - "GAUGE", - "DELTA", - "CUMULATIVE" - ] - }, - "description": { - "description": "A detailed description of the metric, which can be used in documentation.", - "type": "string" - }, - "displayName": { - "description": "A concise name for the metric, which can be displayed in user interfaces. Use sentence case without an ending period, for example \"Request count\". This field is optional but it is recommended to be set for any metrics associated with user-visible concepts, such as Quota.", - "type": "string" - }, - "unit": { - "description": "Optional. The unit in which the metric value is reported. For example, kBy/s means kilobytes/sec, and 1 is the dimensionless unit. The supported units are a subset of The Unified Code for Units of Measure standard (http://unitsofmeasure.org/ucum.html).\u003cbr\u003e\u003cbr\u003e This field is part of the metric's documentation, but it is ignored by Stackdriver.", - "type": "string" - }, - "labels": { - "description": "The set of labels that can be used to describe a specific instance of this metric type. For example, the appengine.googleapis.com/http/server/response_latencies metric type has a label for the HTTP response code, response_code, so you can look at latencies for successful responses or just for responses that failed.", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } - }, - "name": { - "description": "The resource name of the metric descriptor.", - "type": "string" - }, - "type": { - "description": "The metric type, including its DNS name prefix. The type is not URL-encoded. All user-defined custom metric types have the DNS name custom.googleapis.com. Metric types should use a natural hierarchical grouping. For example:\n\"custom.googleapis.com/invoice/paid/amount\"\n\"appengine.googleapis.com/http/server/response_latencies\"\n", - "type": "string" - }, - "valueType": { - "enumDescriptions": [ - "Do not use this default value.", - "The value is a boolean. This value type can be used only if the metric kind is GAUGE.", - "The value is a signed 64-bit integer.", - "The value is a double precision floating point number.", - "The value is a text string. This value type can be used only if the metric kind is GAUGE.", - "The value is a Distribution.", - "The value is money." - ], - "enum": [ - "VALUE_TYPE_UNSPECIFIED", - "BOOL", - "INT64", - "DOUBLE", - "STRING", - "DISTRIBUTION", - "MONEY" - ], - "description": "Whether the measurement is an integer, a floating-point number, etc. Some combinations of metric_kind and value_type might not be supported.", - "type": "string" - } - }, - "id": "MetricDescriptor" - }, - "Range": { - "description": "The range of the population values.", - "type": "object", - "properties": { - "min": { - "description": "The minimum of the population values.", - "format": "double", - "type": "number" - }, - "max": { - "description": "The maximum of the population values.", - "format": "double", - "type": "number" - } - }, - "id": "Range" - }, - "UptimeCheckConfig": { - "description": "This message configures which resources and services to monitor for availability.", - "type": "object", - "properties": { - "timeout": { - "description": "The maximum amount of time to wait for the request to complete (must be between 1 and 60 seconds). Required.", - "format": "google-duration", - "type": "string" - }, - "period": { - "description": "How often the uptime check is performed. Currently, only 1, 5, 10, and 15 minutes are supported. Required.", - "format": "google-duration", - "type": "string" - }, - "name": { - "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.", - "type": "string" - }, - "httpCheck": { - "$ref": "HttpCheck", - "description": "Contains information needed to make an HTTP or HTTPS check." - }, - "resourceGroup": { - "description": "The group resource associated with the configuration.", - "$ref": "ResourceGroup" - }, - "tcpCheck": { - "description": "Contains information needed to make a TCP check.", - "$ref": "TcpCheck" - }, - "internalCheckers": { - "description": "The internal checkers that this check will egress from. If is_internal is true and this list is empty, the check will egress from all InternalCheckers configured for the project that owns this CheckConfig.", - "type": "array", - "items": { - "$ref": "InternalChecker" - } - }, - "isInternal": { - "description": "Denotes whether this is a check that egresses from InternalCheckers.", - "type": "boolean" - }, - "selectedRegions": { - "description": "The list of regions from which the check will be run. If this field is specified, enough regions to include a minimum of 3 locations must be provided, or an error message is returned. Not specifying this field will result in uptime checks running from all regions.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "REGION_UNSPECIFIED", - "USA", - "EUROPE", - "SOUTH_AMERICA", - "ASIA_PACIFIC" - ] - }, - "enumDescriptions": [ - "Default value if no region is specified. Will result in uptime checks running from all regions.", - "Allows checks to run from locations within the United States of America.", - "Allows checks to run from locations within the continent of Europe.", - "Allows checks to run from locations within the continent of South America.", - "Allows checks to run from locations within the Asia Pacific area (ex: Singapore)." - ] - }, - "displayName": { - "description": "A human-friendly name for the uptime check configuration. The display name should be unique within a Stackdriver Account in order to make it easier to identify; however, uniqueness is not enforced. Required.", - "type": "string" - }, - "monitoredResource": { - "description": "The monitored resource associated with the configuration.", - "$ref": "MonitoredResource" - }, - "contentMatchers": { - "description": "The expected content on the page the check is run against. Currently, only the first entry in the list is supported, and other entries will be ignored. The server will look for an exact match of the string in the page response's content. This field is optional and should only be specified if a content match is required.", - "type": "array", - "items": { - "$ref": "ContentMatcher" - } - } - }, - "id": "UptimeCheckConfig" - }, - "ListGroupsResponse": { - "description": "The ListGroups response.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "If there are more results than have been returned, then this field is set to a non-empty value. To see the additional results, use that value as pageToken in the next call to this method.", - "type": "string" - }, - "group": { - "description": "The groups that match the specified filters.", - "type": "array", - "items": { - "$ref": "Group" - } - } - }, - "id": "ListGroupsResponse" } }, "icons": { @@ -1270,12 +1269,205 @@ "resources": { "projects": { "resources": { + "collectdTimeSeries": { + "methods": { + "create": { + "response": { + "$ref": "CreateCollectdTimeSeriesResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.write" + ], + "flatPath": "v3/projects/{projectsId}/collectdTimeSeries", + "path": "v3/{+name}/collectdTimeSeries", + "id": "monitoring.projects.collectdTimeSeries.create", + "request": { + "$ref": "CreateCollectdTimeSeriesRequest" + }, + "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e" + } + } + }, + "metricDescriptors": { + "methods": { + "create": { + "id": "monitoring.projects.metricDescriptors.create", + "path": "v3/{+name}/metricDescriptors", + "request": { + "$ref": "MetricDescriptor" + }, + "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "MetricDescriptor" + }, + "parameters": { + "name": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.write" + ], + "flatPath": "v3/projects/{projectsId}/metricDescriptors" + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/metricDescriptors/.+$", + "location": "path", + "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring" + ], + "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}", + "path": "v3/{+name}", + "id": "monitoring.projects.metricDescriptors.delete", + "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted." + }, + "list": { + "path": "v3/{+name}/metricDescriptors", + "id": "monitoring.projects.metricDescriptors.list", + "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.", + "response": { + "$ref": "ListMetricDescriptorsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "filter": { + "location": "query", + "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n", + "type": "string" + }, + "name": { + "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "A positive number that is the maximum number of results to return.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read", + "https://www.googleapis.com/auth/monitoring.write" + ], + "flatPath": "v3/projects/{projectsId}/metricDescriptors" + }, + "get": { + "httpMethod": "GET", + "response": { + "$ref": "MetricDescriptor" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/metricDescriptors/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read", + "https://www.googleapis.com/auth/monitoring.write" + ], + "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}", + "id": "monitoring.projects.metricDescriptors.get", + "path": "v3/{+name}", + "description": "Gets a single metric descriptor. This method does not require a Stackdriver account." + } + } + }, "timeSeries": { "methods": { - "list": { + "create": { + "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.", + "request": { + "$ref": "CreateTimeSeriesRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.write" + ], + "parameters": { + "name": { + "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, "flatPath": "v3/projects/{projectsId}/timeSeries", "path": "v3/{+name}/timeSeries", - "id": "monitoring.projects.timeSeries.list", + "id": "monitoring.projects.timeSeries.create" + }, + "list": { "description": "Lists time series that match a filter. This method does not require a Stackdriver account.", "response": { "$ref": "ListTimeSeriesResponse" @@ -1290,18 +1482,14 @@ "https://www.googleapis.com/auth/monitoring.read" ], "parameters": { - "pageSize": { - "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.", - "format": "int32", - "type": "integer", - "location": "query" - }, "orderBy": { "location": "query", "description": "Specifies the order in which the points of the time series should be returned. By default, results are not ordered. Currently, this field must be left blank.", "type": "string" }, "aggregation.crossSeriesReducer": { + "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.", + "type": "string", "location": "query", "enum": [ "REDUCE_NONE", @@ -1317,19 +1505,12 @@ "REDUCE_PERCENTILE_95", "REDUCE_PERCENTILE_50", "REDUCE_PERCENTILE_05" - ], - "description": "The approach to be used to combine time series. Not all reducer functions may be applied to all time series, depending on the metric type and the value type of the original time series. Reduction may change the metric type of value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.", - "type": "string" + ] }, "filter": { - "location": "query", "description": "A monitoring filter that specifies which time series should be returned. The filter must specify a single metric type, and can additionally specify metric labels and other information. For example:\nmetric.type = \"compute.googleapis.com/instance/cpu/usage_time\" AND\n metric.label.instance_name = \"my-instance-name\"\n", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", - "type": "string" + "type": "string", + "location": "query" }, "aggregation.perSeriesAligner": { "description": "The approach to be used to align individual time series. Not all alignment functions may be applied to all time series, depending on the metric type and value type of the original time series. Alignment may change the metric type or the value type of the time series.Time series data must be aligned in order to perform cross-time series reduction. If crossSeriesReducer is specified, then perSeriesAligner must be specified and not equal ALIGN_NONE and alignmentPeriod must be specified; otherwise, an error is returned.", @@ -1355,6 +1536,11 @@ "ALIGN_PERCENTILE_05" ] }, + "pageToken": { + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "type": "string", + "location": "query" + }, "interval.startTime": { "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.", "format": "google-datetime", @@ -1370,69 +1556,176 @@ "HEADERS" ] }, - "aggregation.groupByFields": { - "location": "query", - "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.", - "type": "string", - "repeated": true - }, - "name": { - "location": "path", - "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "interval.endTime": { - "description": "Required. The end of the time interval.", - "format": "google-datetime", - "type": "string", - "location": "query" - }, - "aggregation.alignmentPeriod": { - "location": "query", - "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.", - "format": "google-duration", - "type": "string" - } - } - }, - "create": { - "flatPath": "v3/projects/{projectsId}/timeSeries", - "id": "monitoring.projects.timeSeries.create", - "path": "v3/{+name}/timeSeries", - "request": { - "$ref": "CreateTimeSeriesRequest" - }, - "description": "Creates or adds data to one or more time series. The response is empty if all time series in the request were written. If any time series could not be written, a corresponding failure message is included in the error response.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { "name": { "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", "required": true, "type": "string", "pattern": "^projects/[^/]+$", "location": "path" + }, + "aggregation.groupByFields": { + "repeated": true, + "location": "query", + "description": "The set of fields to preserve when crossSeriesReducer is specified. The groupByFields determine how the time series are partitioned into subsets prior to applying the aggregation function. Each subset contains time series that have the same value for each of the grouping fields. Each individual time series is a member of exactly one subset. The crossSeriesReducer is applied to each subset of time series. It is not possible to reduce across different resource types, so this field implicitly contains resource.type. Fields not specified in groupByFields are aggregated away. If groupByFields is not specified and all the time series have the same resource type, then the time series are aggregated into a single output time series. If crossSeriesReducer is not defined, this field is ignored.", + "type": "string" + }, + "interval.endTime": { + "location": "query", + "description": "Required. The end of the time interval.", + "format": "google-datetime", + "type": "string" + }, + "aggregation.alignmentPeriod": { + "location": "query", + "description": "The alignment period for per-time series alignment. If present, alignmentPeriod must be at least 60 seconds. After per-time series alignment, each time series will contain data points only on the period boundaries. If perSeriesAligner is not specified or equals ALIGN_NONE, then this field is ignored. If perSeriesAligner is specified and does not equal ALIGN_NONE, then this field must be defined; otherwise an error is returned.", + "format": "google-duration", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "A positive number that is the maximum number of results to return. When view field sets to FULL, it limits the number of Points server will return; if view field is HEADERS, it limits the number of TimeSeries server will return.", + "format": "int32", + "type": "integer" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.write" - ] + "flatPath": "v3/projects/{projectsId}/timeSeries", + "path": "v3/{+name}/timeSeries", + "id": "monitoring.projects.timeSeries.list" } } }, "uptimeCheckConfigs": { "methods": { + "list": { + "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs", + "path": "v3/{+parent}/uptimeCheckConfigs", + "id": "monitoring.projects.uptimeCheckConfigs.list", + "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.", + "response": { + "$ref": "ListUptimeCheckConfigsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ], + "parameters": { + "pageToken": { + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.", + "format": "int32", + "type": "integer" + }, + "parent": { + "location": "path", + "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + } + }, + "get": { + "description": "Gets a single uptime check configuration.", + "httpMethod": "GET", + "response": { + "$ref": "UptimeCheckConfig" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "location": "path", + "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ], + "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}", + "id": "monitoring.projects.uptimeCheckConfigs.get", + "path": "v3/{+name}" + }, + "patch": { + "id": "monitoring.projects.uptimeCheckConfigs.patch", + "path": "v3/{+name}", + "request": { + "$ref": "UptimeCheckConfig" + }, + "description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.", + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "UptimeCheckConfig" + }, + "parameters": { + "updateMask": { + "location": "query", + "description": "Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.", + "format": "google-fieldmask", + "type": "string" + }, + "name": { + "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring" + ], + "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}" + }, + "create": { + "response": { + "$ref": "UptimeCheckConfig" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "parent": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The project in which to create the uptime check. The format is:projects/[PROJECT_ID].", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring" + ], + "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs", + "path": "v3/{+parent}/uptimeCheckConfigs", + "id": "monitoring.projects.uptimeCheckConfigs.create", + "request": { + "$ref": "UptimeCheckConfig" + }, + "description": "Creates a new uptime check configuration." + }, "delete": { - "description": "Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion.", "response": { "$ref": "Empty" }, @@ -1455,150 +1748,27 @@ }, "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}", "path": "v3/{+name}", - "id": "monitoring.projects.uptimeCheckConfigs.delete" - }, - "list": { - "description": "Lists the existing valid uptime check configurations for the project, leaving out any invalid configurations.", - "response": { - "$ref": "ListUptimeCheckConfigsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call.", - "type": "string" - }, - "pageSize": { - "description": "The maximum number of results to return in a single response. The server may further constrain the maximum number of results returned in a single page. If the page_size is \u003c=0, the server will decide the number of results to be returned.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "description": "The project whose uptime check configurations are listed. The format isprojects/[PROJECT_ID].", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs", - "path": "v3/{+parent}/uptimeCheckConfigs", - "id": "monitoring.projects.uptimeCheckConfigs.list" - }, - "get": { - "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}", - "path": "v3/{+name}", - "id": "monitoring.projects.uptimeCheckConfigs.get", - "description": "Gets a single uptime check configuration.", - "response": { - "$ref": "UptimeCheckConfig" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read" - ], - "parameters": { - "name": { - "location": "path", - "description": "The uptime check configuration to retrieve. The format isprojects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$" - } - } - }, - "patch": { - "request": { - "$ref": "UptimeCheckConfig" - }, - "description": "Updates an uptime check configuration. You can either replace the entire configuration with a new one or replace only certain fields in the current configuration by specifying the fields to be updated via \"updateMask\". Returns the updated configuration.", - "response": { - "$ref": "UptimeCheckConfig" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "description": "Optional. If present, only the listed fields in the current uptime check configuration are updated with values from the new configuration. If this field is empty, then the current configuration is completely replaced with the new configuration.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "description": "A unique resource name for this UptimeCheckConfig. The format is:projects/[PROJECT_ID]/uptimeCheckConfigs/[UPTIME_CHECK_ID].This field should be omitted when creating the uptime check configuration; on create, the resource name is assigned by the server and included in the response.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/uptimeCheckConfigs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring" - ], - "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs/{uptimeCheckConfigsId}", - "path": "v3/{+name}", - "id": "monitoring.projects.uptimeCheckConfigs.patch" - }, - "create": { - "request": { - "$ref": "UptimeCheckConfig" - }, - "description": "Creates a new uptime check configuration.", - "httpMethod": "POST", - "parameterOrder": [ - "parent" - ], - "response": { - "$ref": "UptimeCheckConfig" - }, - "parameters": { - "parent": { - "location": "path", - "description": "The project in which to create the uptime check. The format is:projects/[PROJECT_ID].", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring" - ], - "flatPath": "v3/projects/{projectsId}/uptimeCheckConfigs", - "id": "monitoring.projects.uptimeCheckConfigs.create", - "path": "v3/{+parent}/uptimeCheckConfigs" + "id": "monitoring.projects.uptimeCheckConfigs.delete", + "description": "Deletes an uptime check configuration. Note that this method will fail if the uptime check configuration is referenced by an alert policy or other dependent configs that would be rendered invalid by the deletion." } } }, "monitoredResourceDescriptors": { "methods": { "list": { - "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], "response": { "$ref": "ListMonitoredResourceDescriptorsResponse" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read", + "https://www.googleapis.com/auth/monitoring.write" + ], "parameters": { "filter": { "location": "query", @@ -1613,9 +1783,9 @@ "location": "path" }, "pageToken": { + "location": "query", "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { "description": "A positive number that is the maximum number of results to return.", @@ -1624,31 +1794,22 @@ "location": "query" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read", - "https://www.googleapis.com/auth/monitoring.write" - ], "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors", + "path": "v3/{+name}/monitoredResourceDescriptors", "id": "monitoring.projects.monitoredResourceDescriptors.list", - "path": "v3/{+name}/monitoredResourceDescriptors" + "description": "Lists monitored resource descriptors that match a filter. This method does not require a Stackdriver account." }, "get": { + "id": "monitoring.projects.monitoredResourceDescriptors.get", + "path": "v3/{+name}", "description": "Gets a single monitored resource descriptor. This method does not require a Stackdriver account.", - "response": { - "$ref": "MonitoredResourceDescriptor" - }, + "httpMethod": "GET", "parameterOrder": [ "name" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read", - "https://www.googleapis.com/auth/monitoring.write" - ], + "response": { + "$ref": "MonitoredResourceDescriptor" + }, "parameters": { "name": { "description": "The monitored resource descriptor to get. The format is \"projects/{project_id_or_number}/monitoredResourceDescriptors/{resource_type}\". The {resource_type} is a predefined type, such as cloudsql_database.", @@ -1658,94 +1819,79 @@ "location": "path" } }, - "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}", - "path": "v3/{+name}", - "id": "monitoring.projects.monitoredResourceDescriptors.get" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read", + "https://www.googleapis.com/auth/monitoring.write" + ], + "flatPath": "v3/projects/{projectsId}/monitoredResourceDescriptors/{monitoredResourceDescriptorsId}" } } }, "groups": { - "methods": { - "list": { - "flatPath": "v3/projects/{projectsId}/groups", - "path": "v3/{+name}/groups", - "id": "monitoring.projects.groups.list", - "description": "Lists the existing groups.", - "response": { - "$ref": "ListGroupsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read" - ], - "parameters": { - "childrenOfGroup": { - "location": "query", - "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.", - "type": "string" - }, - "descendantsOfGroup": { - "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "A positive number that is the maximum number of results to return.", - "format": "int32", - "type": "integer" - }, - "ancestorsOfGroup": { - "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.", - "type": "string", - "location": "query" - }, - "name": { - "location": "path", - "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" + "resources": { + "members": { + "methods": { + "list": { + "response": { + "$ref": "ListGroupMembersResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ], + "parameters": { + "filter": { + "location": "query", + "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "A positive number that is the maximum number of results to return.", + "format": "int32", + "type": "integer" + }, + "interval.startTime": { + "location": "query", + "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/groups/[^/]+$", + "location": "path" + }, + "interval.endTime": { + "description": "Required. The end of the time interval.", + "format": "google-datetime", + "type": "string", + "location": "query" + } + }, + "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members", + "path": "v3/{+name}/members", + "id": "monitoring.projects.groups.members.list", + "description": "Lists the monitored resources that are members of a group." } } - }, - "get": { - "description": "Gets a single group.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Group" - }, - "parameters": { - "name": { - "location": "path", - "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/groups/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read" - ], - "flatPath": "v3/projects/{projectsId}/groups/{groupsId}", - "id": "monitoring.projects.groups.get", - "path": "v3/{+name}" - }, + } + }, + "methods": { "update": { "description": "Updates an existing group. You can change any group attributes except name.", "request": { @@ -1771,9 +1917,9 @@ "pattern": "^projects/[^/]+/groups/[^/]+$" }, "validateOnly": { - "location": "query", "description": "If true, validate this request but do not update the existing group.", - "type": "boolean" + "type": "boolean", + "location": "query" } }, "flatPath": "v3/projects/{projectsId}/groups/{groupsId}", @@ -1781,10 +1927,12 @@ "id": "monitoring.projects.groups.update" }, "create": { - "description": "Creates a new group.", + "path": "v3/{+name}/groups", + "id": "monitoring.projects.groups.create", "request": { "$ref": "Group" }, + "description": "Creates a new group.", "response": { "$ref": "Group" }, @@ -1792,17 +1940,13 @@ "name" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring" - ], "parameters": { "name": { + "pattern": "^projects/[^/]+$", "location": "path", "description": "The project in which to create the group. The format is \"projects/{project_id_or_number}\".", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" + "type": "string" }, "validateOnly": { "location": "query", @@ -1810,11 +1954,16 @@ "type": "boolean" } }, - "flatPath": "v3/projects/{projectsId}/groups", - "path": "v3/{+name}/groups", - "id": "monitoring.projects.groups.create" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring" + ], + "flatPath": "v3/projects/{projectsId}/groups" }, "delete": { + "flatPath": "v3/projects/{projectsId}/groups/{groupsId}", + "path": "v3/{+name}", + "id": "monitoring.projects.groups.delete", "description": "Deletes an existing group.", "response": { "$ref": "Empty" @@ -1829,243 +1978,93 @@ ], "parameters": { "name": { + "pattern": "^projects/[^/]+/groups/[^/]+$", + "location": "path", "description": "The group to delete. The format is \"projects/{project_id_or_number}/groups/{group_id}\".", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/groups/[^/]+$", - "location": "path" - } - }, - "flatPath": "v3/projects/{projectsId}/groups/{groupsId}", - "path": "v3/{+name}", - "id": "monitoring.projects.groups.delete" - } - }, - "resources": { - "members": { - "methods": { - "list": { - "flatPath": "v3/projects/{projectsId}/groups/{groupsId}/members", - "id": "monitoring.projects.groups.members.list", - "path": "v3/{+name}/members", - "description": "Lists the monitored resources that are members of a group.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "ListGroupMembersResponse" - }, - "parameters": { - "pageSize": { - "location": "query", - "description": "A positive number that is the maximum number of results to return.", - "format": "int32", - "type": "integer" - }, - "interval.startTime": { - "location": "query", - "description": "Optional. The beginning of the time interval. The default value for the start time is the end time. The start time must not be later than the end time.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "location": "path", - "description": "The group whose members are listed. The format is \"projects/{project_id_or_number}/groups/{group_id}\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/groups/[^/]+$" - }, - "interval.endTime": { - "location": "query", - "description": "Required. The end of the time interval.", - "format": "google-datetime", - "type": "string" - }, - "filter": { - "description": "An optional list filter describing the members to be returned. The filter may reference the type, labels, and metadata of monitored resources that comprise the group. For example, to return only resources representing Compute Engine VM instances, use this filter:\nresource.type = \"gce_instance\"\n", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read" - ] + "type": "string" } } - } - } - }, - "collectdTimeSeries": { - "methods": { - "create": { - "request": { - "$ref": "CreateCollectdTimeSeriesRequest" - }, - "description": "Stackdriver Monitoring Agent only: Creates a new time series.\u003caside class=\"caution\"\u003eThis method is only for use by the Stackdriver Monitoring Agent. Use projects.timeSeries.create instead.\u003c/aside\u003e", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "CreateCollectdTimeSeriesResponse" - }, - "parameters": { - "name": { - "location": "path", - "description": "The project in which to create the time series. The format is \"projects/PROJECT_ID_OR_NUMBER\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.write" - ], - "flatPath": "v3/projects/{projectsId}/collectdTimeSeries", - "id": "monitoring.projects.collectdTimeSeries.create", - "path": "v3/{+name}/collectdTimeSeries" - } - } - }, - "metricDescriptors": { - "methods": { + }, "list": { - "description": "Lists metric descriptors that match a filter. This method does not require a Stackdriver account.", "response": { - "$ref": "ListMetricDescriptorsResponse" + "$ref": "ListGroupsResponse" }, "parameterOrder": [ "name" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ], "parameters": { + "descendantsOfGroup": { + "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns the descendants of the specified group. This is a superset of the results returned by the childrenOfGroup filter, and includes children-of-children, and so forth.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "type": "string" + }, "pageSize": { "description": "A positive number that is the maximum number of results to return.", "format": "int32", "type": "integer", "location": "query" }, - "filter": { - "location": "query", - "description": "If this field is empty, all custom and system-defined metric descriptors are returned. Otherwise, the filter specifies which metric descriptors are to be returned. For example, the following filter matches all custom metrics:\nmetric.type = starts_with(\"custom.googleapis.com/\")\n", - "type": "string" + "ancestorsOfGroup": { + "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups that are ancestors of the specified group. The groups are returned in order, starting with the immediate parent and ending with the most distant ancestor. If the specified group has no immediate parent, the results are empty.", + "type": "string", + "location": "query" }, "name": { - "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", + "description": "The project whose groups are to be listed. The format is \"projects/{project_id_or_number}\".", "required": true, "type": "string", "pattern": "^projects/[^/]+$", "location": "path" }, - "pageToken": { + "childrenOfGroup": { "location": "query", - "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return additional results from the previous method call.", + "description": "A group name: \"projects/{project_id_or_number}/groups/{group_id}\". Returns groups whose parentName field contains the group name. If no groups have this parent, the results are empty.", "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read", - "https://www.googleapis.com/auth/monitoring.write" - ], - "flatPath": "v3/projects/{projectsId}/metricDescriptors", - "path": "v3/{+name}/metricDescriptors", - "id": "monitoring.projects.metricDescriptors.list" + "flatPath": "v3/projects/{projectsId}/groups", + "path": "v3/{+name}/groups", + "id": "monitoring.projects.groups.list", + "description": "Lists the existing groups." }, "get": { - "httpMethod": "GET", + "description": "Gets a single group.", + "response": { + "$ref": "Group" + }, "parameterOrder": [ "name" ], - "response": { - "$ref": "MetricDescriptor" - }, + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/monitoring", + "https://www.googleapis.com/auth/monitoring.read" + ], "parameters": { "name": { "location": "path", - "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example value of {metric_id} is \"compute.googleapis.com/instance/disk/read_bytes_count\".", + "description": "The group to retrieve. The format is \"projects/{project_id_or_number}/groups/{group_id}\".", "required": true, "type": "string", - "pattern": "^projects/[^/]+/metricDescriptors/.+$" + "pattern": "^projects/[^/]+/groups/[^/]+$" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.read", - "https://www.googleapis.com/auth/monitoring.write" - ], - "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}", - "id": "monitoring.projects.metricDescriptors.get", + "flatPath": "v3/projects/{projectsId}/groups/{groupsId}", "path": "v3/{+name}", - "description": "Gets a single metric descriptor. This method does not require a Stackdriver account." - }, - "create": { - "response": { - "$ref": "MetricDescriptor" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring", - "https://www.googleapis.com/auth/monitoring.write" - ], - "parameters": { - "name": { - "description": "The project on which to execute the request. The format is \"projects/{project_id_or_number}\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "flatPath": "v3/projects/{projectsId}/metricDescriptors", - "path": "v3/{+name}/metricDescriptors", - "id": "monitoring.projects.metricDescriptors.create", - "description": "Creates a new metric descriptor. User-created metric descriptors define custom metrics.", - "request": { - "$ref": "MetricDescriptor" - } - }, - "delete": { - "flatPath": "v3/projects/{projectsId}/metricDescriptors/{metricDescriptorsId}", - "path": "v3/{+name}", - "id": "monitoring.projects.metricDescriptors.delete", - "description": "Deletes a metric descriptor. Only user-created custom metrics can be deleted.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/monitoring" - ], - "parameters": { - "name": { - "description": "The metric descriptor on which to execute the request. The format is \"projects/{project_id_or_number}/metricDescriptors/{metric_id}\". An example of {metric_id} is: \"custom.googleapis.com/my_test_metric\".", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/metricDescriptors/.+$", - "location": "path" - } - } + "id": "monitoring.projects.groups.get" } } } @@ -2074,17 +2073,19 @@ "uptimeCheckIps": { "methods": { "list": { + "id": "monitoring.uptimeCheckIps.list", + "path": "v3/uptimeCheckIps", "description": "Returns the list of IPs that checkers run from", "httpMethod": "GET", - "parameterOrder": [], "response": { "$ref": "ListUptimeCheckIpsResponse" }, + "parameterOrder": [], "parameters": { "pageToken": { + "location": "query", "description": "If this field is not empty then it must contain the nextPageToken value returned by a previous call to this method. Using this field causes the method to return more results from the previous method call. NOTE: this field is not yet implemented", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { "location": "query", @@ -2098,31 +2099,39 @@ "https://www.googleapis.com/auth/monitoring", "https://www.googleapis.com/auth/monitoring.read" ], - "flatPath": "v3/uptimeCheckIps", - "id": "monitoring.uptimeCheckIps.list", - "path": "v3/uptimeCheckIps" + "flatPath": "v3/uptimeCheckIps" } } } }, "parameters": { + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "$.xgafv": { + "enum": [ + "1", + "2" + ], "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" + "location": "query" }, "alt": { "description": "Data format for response.", @@ -2141,61 +2150,52 @@ "location": "query" }, "key": { + "location": "query", "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.", - "type": "string", - "location": "query" + "type": "string" }, "access_token": { + "location": "query", "description": "OAuth access token.", + "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.", "type": "string", "location": "query" }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, "pp": { - "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" + "default": "true", + "location": "query" }, "bearer_token": { "description": "OAuth bearer token.", "type": "string", "location": "query" }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, "upload_protocol": { - "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "prettyPrint": { "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true", "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" } }, "version": "v3", "baseUrl": "https://monitoring.googleapis.com/", - "servicePath": "", "kind": "discovery#restDescription", - "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages." + "description": "Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages.", + "servicePath": "", + "basePath": "" }
diff --git a/oslogin/v1/oslogin-api.json b/oslogin/v1/oslogin-api.json index 3b3c35f..efbca42 100644 --- a/oslogin/v1/oslogin-api.json +++ b/oslogin/v1/oslogin-api.json
@@ -1,16 +1,14 @@ { + "id": "oslogin:v1", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/", + "revision": "20180105", + "discoveryVersion": "v1", + "version_module": true, "schemas": { "LoginProfile": { "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.", "type": "object", "properties": { - "sshPublicKeys": { - "additionalProperties": { - "$ref": "SshPublicKey" - }, - "description": "A map from SSH public key fingerprint to the associated key object.", - "type": "object" - }, "name": { "description": "The primary email address that uniquely identifies the user.", "type": "string" @@ -25,6 +23,13 @@ "suspended": { "description": "Indicates if the user is suspended. A suspended user cannot log in but\ntheir profile information is retained.", "type": "boolean" + }, + "sshPublicKeys": { + "additionalProperties": { + "$ref": "SshPublicKey" + }, + "description": "A map from SSH public key fingerprint to the associated key object.", + "type": "object" } }, "id": "LoginProfile" @@ -70,19 +75,6 @@ "description": "The POSIX account information associated with a Google account.", "type": "object", "properties": { - "uid": { - "description": "The user ID.", - "format": "int64", - "type": "string" - }, - "username": { - "description": "The username of the POSIX account.", - "type": "string" - }, - "shell": { - "description": "The path to the logic shell for this account.", - "type": "string" - }, "homeDirectory": { "description": "The path to the home directory for this account.", "type": "string" @@ -107,6 +99,19 @@ "description": "The default group ID.", "format": "int64", "type": "string" + }, + "uid": { + "description": "The user ID.", + "format": "int64", + "type": "string" + }, + "username": { + "description": "The username of the POSIX account.", + "type": "string" + }, + "shell": { + "description": "The path to the logic shell for this account.", + "type": "string" } }, "id": "PosixAccount" @@ -114,8 +119,8 @@ }, "protocol": "rest", "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "canonicalName": "Cloud OS Login", "auth": { @@ -141,29 +146,25 @@ "users": { "methods": { "importSshPublicKey": { - "request": { - "$ref": "SshPublicKey" - }, - "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.", - "response": { - "$ref": "ImportSshPublicKeyResponse" - }, + "httpMethod": "POST", "parameterOrder": [ "parent" ], - "httpMethod": "POST", + "response": { + "$ref": "ImportSshPublicKeyResponse" + }, "parameters": { - "parent": { - "pattern": "^users/[^/]+$", - "location": "path", - "description": "The unique ID for the user in format `users/{user}`.", - "required": true, + "projectId": { + "location": "query", + "description": "The project ID of the Google Cloud Platform project.", "type": "string" }, - "projectId": { - "description": "The project ID of the Google Cloud Platform project.", + "parent": { + "description": "The unique ID for the user in format `users/{user}`.", + "required": true, "type": "string", - "location": "query" + "pattern": "^users/[^/]+$", + "location": "path" } }, "scopes": [ @@ -171,11 +172,14 @@ "https://www.googleapis.com/auth/compute" ], "flatPath": "v1/users/{usersId}:importSshPublicKey", + "id": "oslogin.users.importSshPublicKey", "path": "v1/{+parent}:importSshPublicKey", - "id": "oslogin.users.importSshPublicKey" + "request": { + "$ref": "SshPublicKey" + }, + "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile." }, "getLoginProfile": { - "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.", "response": { "$ref": "LoginProfile" }, @@ -183,6 +187,10 @@ "name" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], "parameters": { "name": { "pattern": "^users/[^/]+$", @@ -192,53 +200,50 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], "flatPath": "v1/users/{usersId}/loginProfile", "path": "v1/{+name}/loginProfile", - "id": "oslogin.users.getLoginProfile" + "id": "oslogin.users.getLoginProfile", + "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine." } }, "resources": { "sshPublicKeys": { "methods": { "delete": { - "path": "v1/{+name}", - "id": "oslogin.users.sshPublicKeys.delete", - "description": "Deletes an SSH public key.", + "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], - "httpMethod": "DELETE", "parameters": { "name": { - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path", "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", "required": true, - "type": "string" + "type": "string", + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/compute" ], - "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}" + "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "id": "oslogin.users.sshPublicKeys.delete", + "path": "v1/{+name}", + "description": "Deletes an SSH public key." }, "get": { "description": "Retrieves an SSH public key.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], "response": { "$ref": "SshPublicKey" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", "parameters": { "name": { "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.", @@ -253,30 +258,34 @@ "https://www.googleapis.com/auth/compute" ], "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", - "id": "oslogin.users.sshPublicKeys.get", - "path": "v1/{+name}" + "path": "v1/{+name}", + "id": "oslogin.users.sshPublicKeys.get" }, "patch": { - "id": "oslogin.users.sshPublicKeys.patch", "path": "v1/{+name}", + "id": "oslogin.users.sshPublicKeys.patch", + "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.", "request": { "$ref": "SshPublicKey" }, - "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.", - "httpMethod": "PATCH", - "parameterOrder": [ - "name" - ], "response": { "$ref": "SshPublicKey" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], "parameters": { "name": { - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path", "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", "required": true, - "type": "string" + "type": "string", + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", + "location": "path" }, "updateMask": { "location": "query", @@ -285,10 +294,6 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], "flatPath": "v1/users/{usersId}/sshPublicKeys/{sshPublicKeysId}" } } @@ -296,13 +301,14 @@ "projects": { "methods": { "delete": { + "description": "Deletes a POSIX account.", + "httpMethod": "DELETE", "response": { "$ref": "Empty" }, "parameterOrder": [ "name" ], - "httpMethod": "DELETE", "parameters": { "name": { "pattern": "^users/[^/]+/projects/[^/]+$", @@ -317,9 +323,8 @@ "https://www.googleapis.com/auth/compute" ], "flatPath": "v1/users/{usersId}/projects/{projectsId}", - "path": "v1/{+name}", "id": "oslogin.users.projects.delete", - "description": "Deletes a POSIX account." + "path": "v1/{+name}" } } } @@ -327,16 +332,16 @@ } }, "parameters": { - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, "oauth_token": { "location": "query", "description": "OAuth 2.0 token for the current user.", "type": "string" }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", @@ -348,35 +353,41 @@ "type": "boolean", "default": "true" }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, "callback": { "description": "JSONP", "type": "string", "location": "query" }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", @@ -384,34 +395,28 @@ ], "location": "query", "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" + "default": "json" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" }, "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.", "type": "string", "location": "query" }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, "quotaUser": { "location": "query", "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.", "type": "string" }, "pp": { - "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" } }, "version": "v1", @@ -419,10 +424,5 @@ "servicePath": "", "description": "Manages OS login configuration for Google account users.", "kind": "discovery#restDescription", - "basePath": "", - "id": "oslogin:v1", - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/", - "revision": "20180105", - "discoveryVersion": "v1", - "version_module": true + "basePath": "" }
diff --git a/oslogin/v1alpha/oslogin-api.json b/oslogin/v1alpha/oslogin-api.json index a9e6670..106442a 100644 --- a/oslogin/v1alpha/oslogin-api.json +++ b/oslogin/v1alpha/oslogin-api.json
@@ -1,25 +1,19 @@ { - "id": "oslogin:v1alpha", - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/", - "revision": "20171211", - "discoveryVersion": "v1", "version_module": true, "schemas": { - "ImportSshPublicKeyResponse": { - "description": "A response message for importing an SSH public key.", - "type": "object", - "properties": { - "loginProfile": { - "description": "The login profile information for the user.", - "$ref": "LoginProfile" - } - }, - "id": "ImportSshPublicKeyResponse" - }, "PosixAccount": { "description": "The POSIX account information associated with a Google account.", "type": "object", "properties": { + "accountId": { + "description": "Output only. A POSIX account identifier.", + "type": "string" + }, + "gid": { + "description": "The default group ID.", + "format": "int64", + "type": "string" + }, "uid": { "description": "The user ID.", "format": "int64", @@ -48,20 +42,13 @@ "primary": { "description": "Only one POSIX account can be marked as primary.", "type": "boolean" - }, - "accountId": { - "description": "Output only. A POSIX account identifier.", - "type": "string" - }, - "gid": { - "description": "The default group ID.", - "format": "int64", - "type": "string" } }, "id": "PosixAccount" }, "LoginProfile": { + "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.", + "type": "object", "properties": { "name": { "description": "A unique user ID for identifying the user.", @@ -86,24 +73,18 @@ "type": "object" } }, - "id": "LoginProfile", - "description": "The user profile information used for logging in to a virtual machine on\nGoogle Compute Engine.", - "type": "object" + "id": "LoginProfile" }, "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" + "type": "object", + "properties": {}, + "id": "Empty" }, "SshPublicKey": { "description": "The SSH public key information associated with a Google account.", "type": "object", "properties": { - "key": { - "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.", - "type": "string" - }, "expirationTimeUsec": { "description": "An expiration time in microseconds since epoch.", "format": "int64", @@ -112,16 +93,31 @@ "fingerprint": { "description": "Output only. The SHA-256 fingerprint of the SSH public key.", "type": "string" + }, + "key": { + "description": "Public key text in SSH format, defined by\n\u003ca href=\"https://www.ietf.org/rfc/rfc4253.txt\" target=\"_blank\"\u003eRFC4253\u003c/a\u003e\nsection 6.6.", + "type": "string" } }, "id": "SshPublicKey" + }, + "ImportSshPublicKeyResponse": { + "description": "A response message for importing an SSH public key.", + "type": "object", + "properties": { + "loginProfile": { + "description": "The login profile information for the user.", + "$ref": "LoginProfile" + } + }, + "id": "ImportSshPublicKeyResponse" } }, - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, "protocol": "rest", + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" + }, "canonicalName": "Cloud OS Login", "auth": { "oauth2": { @@ -150,131 +146,12 @@ "ownerName": "Google", "resources": { "users": { - "resources": { - "sshPublicKeys": { - "methods": { - "delete": { - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path", - "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", - "id": "oslogin.users.sshPublicKeys.delete", - "path": "v1alpha/{+name}", - "description": "Deletes an SSH public key." - }, - "get": { - "httpMethod": "GET", - "response": { - "$ref": "SshPublicKey" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", - "id": "oslogin.users.sshPublicKeys.get", - "path": "v1alpha/{+name}", - "description": "Retrieves an SSH public key." - }, - "patch": { - "response": { - "$ref": "SshPublicKey" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "location": "query", - "description": "Mask to control which fields get updated. Updates all if not present.", - "format": "google-fieldmask", - "type": "string" - }, - "name": { - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path", - "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", - "path": "v1alpha/{+name}", - "id": "oslogin.users.sshPublicKeys.patch", - "request": { - "$ref": "SshPublicKey" - }, - "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics." - } - } - }, - "projects": { - "methods": { - "delete": { - "description": "Deletes a POSIX account.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+/projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}", - "id": "oslogin.users.projects.delete", - "path": "v1alpha/{+name}" - } - } - } - }, "methods": { "importSshPublicKey": { + "request": { + "$ref": "SshPublicKey" + }, + "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.", "response": { "$ref": "ImportSshPublicKeyResponse" }, @@ -302,21 +179,17 @@ ], "flatPath": "v1alpha/users/{usersId}:importSshPublicKey", "path": "v1alpha/{+parent}:importSshPublicKey", - "id": "oslogin.users.importSshPublicKey", - "request": { - "$ref": "SshPublicKey" - }, - "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile." + "id": "oslogin.users.importSshPublicKey" }, "getLoginProfile": { "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine.", - "httpMethod": "GET", "response": { "$ref": "LoginProfile" }, "parameterOrder": [ "name" ], + "httpMethod": "GET", "parameters": { "name": { "description": "The unique ID for the user in format `users/{user}`.", @@ -333,38 +206,140 @@ "https://www.googleapis.com/auth/compute.readonly" ], "flatPath": "v1alpha/users/{usersId}/loginProfile", - "id": "oslogin.users.getLoginProfile", - "path": "v1alpha/{+name}/loginProfile" + "path": "v1alpha/{+name}/loginProfile", + "id": "oslogin.users.getLoginProfile" + } + }, + "resources": { + "projects": { + "methods": { + "delete": { + "description": "Deletes a POSIX account.", + "httpMethod": "DELETE", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "location": "path", + "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/projects/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "v1alpha/users/{usersId}/projects/{projectsId}", + "id": "oslogin.users.projects.delete", + "path": "v1alpha/{+name}" + } + } + }, + "sshPublicKeys": { + "methods": { + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "path": "v1alpha/{+name}", + "id": "oslogin.users.sshPublicKeys.delete", + "description": "Deletes an SSH public key." + }, + "get": { + "description": "Retrieves an SSH public key.", + "response": { + "$ref": "SshPublicKey" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameters": { + "name": { + "location": "path", + "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$" + } + }, + "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "path": "v1alpha/{+name}", + "id": "oslogin.users.sshPublicKeys.get" + }, + "patch": { + "request": { + "$ref": "SshPublicKey" + }, + "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.", + "httpMethod": "PATCH", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "SshPublicKey" + }, + "parameters": { + "updateMask": { + "description": "Mask to control which fields get updated. Updates all if not present.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "name": { + "location": "path", + "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "v1alpha/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "id": "oslogin.users.sshPublicKeys.patch", + "path": "v1alpha/{+name}" + } + } } } } }, "parameters": { - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, "upload_protocol": { - "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "prettyPrint": { "location": "query", @@ -372,33 +347,33 @@ "type": "boolean", "default": "true" }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, "$.xgafv": { - "enum": [ - "1", - "2" - ], "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], - "location": "query" + "location": "query", + "enum": [ + "1", + "2" + ] }, "callback": { + "location": "query", "description": "JSONP", - "type": "string", - "location": "query" + "type": "string" }, "alt": { "description": "Data format for response.", @@ -416,15 +391,36 @@ ], "location": "query" }, + "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.", + "type": "string", + "location": "query" + }, "access_token": { - "location": "query", "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", "type": "string" }, - "key": { + "pp": { "location": "query", - "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.", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" } }, "version": "v1alpha", @@ -432,5 +428,9 @@ "kind": "discovery#restDescription", "description": "Manages OS login configuration for Google account users.", "servicePath": "", - "basePath": "" + "basePath": "", + "revision": "20180105", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/", + "id": "oslogin:v1alpha", + "discoveryVersion": "v1" }
diff --git a/oslogin/v1beta/oslogin-api.json b/oslogin/v1beta/oslogin-api.json index 8db3d83..43d8d61 100644 --- a/oslogin/v1beta/oslogin-api.json +++ b/oslogin/v1beta/oslogin-api.json
@@ -1,331 +1,20 @@ { - "canonicalName": "Cloud OS Login", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/compute.readonly": { - "description": "View your Google Compute Engine resources" - }, - "https://www.googleapis.com/auth/compute": { - "description": "View and manage your Google Compute Engine resources" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - } - } - } - }, - "rootUrl": "https://oslogin.googleapis.com/", - "ownerDomain": "google.com", - "name": "oslogin", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Cloud OS Login API", - "ownerName": "Google", - "resources": { - "users": { - "methods": { - "importSshPublicKey": { - "response": { - "$ref": "ImportSshPublicKeyResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "parent": { - "description": "The unique ID for the user in format `users/{user}`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+$", - "location": "path" - }, - "projectId": { - "description": "The project ID of the Google Cloud Platform project.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1beta/users/{usersId}:importSshPublicKey", - "path": "v1beta/{+parent}:importSshPublicKey", - "id": "oslogin.users.importSshPublicKey", - "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.", - "request": { - "$ref": "SshPublicKey" - } - }, - "getLoginProfile": { - "response": { - "$ref": "LoginProfile" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/compute", - "https://www.googleapis.com/auth/compute.readonly" - ], - "parameters": { - "name": { - "description": "The unique ID for the user in format `users/{user}`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta/users/{usersId}/loginProfile", - "path": "v1beta/{+name}/loginProfile", - "id": "oslogin.users.getLoginProfile", - "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine." - } - }, - "resources": { - "sshPublicKeys": { - "methods": { - "delete": { - "path": "v1beta/{+name}", - "id": "oslogin.users.sshPublicKeys.delete", - "description": "Deletes an SSH public key.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "name": { - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path", - "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}" - }, - "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "SshPublicKey" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "name": { - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path", - "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", - "id": "oslogin.users.sshPublicKeys.get", - "path": "v1beta/{+name}", - "description": "Retrieves an SSH public key." - }, - "patch": { - "path": "v1beta/{+name}", - "id": "oslogin.users.sshPublicKeys.patch", - "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics.", - "request": { - "$ref": "SshPublicKey" - }, - "response": { - "$ref": "SshPublicKey" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "parameters": { - "updateMask": { - "description": "Mask to control which fields get updated. Updates all if not present.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "name": { - "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}" - } - } - }, - "projects": { - "methods": { - "delete": { - "path": "v1beta/{+name}", - "id": "oslogin.users.projects.delete", - "description": "Deletes a POSIX account.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+/projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/compute" - ], - "flatPath": "v1beta/users/{usersId}/projects/{projectsId}" - } - } - } - } - } - }, - "parameters": { - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - } - }, - "version": "v1beta", - "baseUrl": "https://oslogin.googleapis.com/", - "servicePath": "", - "description": "Manages OS login configuration for Google account users.", - "kind": "discovery#restDescription", - "basePath": "", - "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/", "id": "oslogin:v1beta", - "revision": "20171211", + "documentationLink": "https://cloud.google.com/compute/docs/oslogin/rest/", + "revision": "20180105", "discoveryVersion": "v1", "version_module": true, "schemas": { "ImportSshPublicKeyResponse": { + "description": "A response message for importing an SSH public key.", + "type": "object", "properties": { "loginProfile": { - "$ref": "LoginProfile", - "description": "The login profile information for the user." + "description": "The login profile information for the user.", + "$ref": "LoginProfile" } }, - "id": "ImportSshPublicKeyResponse", - "description": "A response message for importing an SSH public key.", - "type": "object" + "id": "ImportSshPublicKeyResponse" }, "PosixAccount": { "properties": { @@ -428,9 +117,320 @@ "type": "object" } }, - "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" - } + }, + "protocol": "rest", + "canonicalName": "Cloud OS Login", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/compute.readonly": { + "description": "View your Google Compute Engine resources" + }, + "https://www.googleapis.com/auth/compute": { + "description": "View and manage your Google Compute Engine resources" + }, + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + } + } + } + }, + "rootUrl": "https://oslogin.googleapis.com/", + "ownerDomain": "google.com", + "name": "oslogin", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Cloud OS Login API", + "ownerName": "Google", + "resources": { + "users": { + "methods": { + "importSshPublicKey": { + "description": "Adds an SSH public key and returns the profile information. Default POSIX\naccount information is set when no username and UID exist as part of the\nlogin profile.", + "request": { + "$ref": "SshPublicKey" + }, + "response": { + "$ref": "ImportSshPublicKeyResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameters": { + "projectId": { + "location": "query", + "description": "The project ID of the Google Cloud Platform project.", + "type": "string" + }, + "parent": { + "description": "The unique ID for the user in format `users/{user}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta/users/{usersId}:importSshPublicKey", + "path": "v1beta/{+parent}:importSshPublicKey", + "id": "oslogin.users.importSshPublicKey" + }, + "getLoginProfile": { + "response": { + "$ref": "LoginProfile" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/compute", + "https://www.googleapis.com/auth/compute.readonly" + ], + "parameters": { + "name": { + "pattern": "^users/[^/]+$", + "location": "path", + "description": "The unique ID for the user in format `users/{user}`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta/users/{usersId}/loginProfile", + "path": "v1beta/{+name}/loginProfile", + "id": "oslogin.users.getLoginProfile", + "description": "Retrieves the profile information used for logging in to a virtual machine\non Google Compute Engine." + } + }, + "resources": { + "sshPublicKeys": { + "methods": { + "delete": { + "description": "Deletes an SSH public key.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameters": { + "name": { + "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "path": "v1beta/{+name}", + "id": "oslogin.users.sshPublicKeys.delete" + }, + "get": { + "response": { + "$ref": "SshPublicKey" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", + "location": "path", + "description": "The fingerprint of the public key to retrieve. Public keys are identified\nby their SHA-256 fingerprint. The fingerprint of the public key is in\nformat `users/{user}/sshPublicKeys/{fingerprint}`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "path": "v1beta/{+name}", + "id": "oslogin.users.sshPublicKeys.get", + "description": "Retrieves an SSH public key." + }, + "patch": { + "response": { + "$ref": "SshPublicKey" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "name": { + "pattern": "^users/[^/]+/sshPublicKeys/[^/]+$", + "location": "path", + "description": "The fingerprint of the public key to update. Public keys are identified by\ntheir SHA-256 fingerprint. The fingerprint of the public key is in format\n`users/{user}/sshPublicKeys/{fingerprint}`.", + "required": true, + "type": "string" + }, + "updateMask": { + "location": "query", + "description": "Mask to control which fields get updated. Updates all if not present.", + "format": "google-fieldmask", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "flatPath": "v1beta/users/{usersId}/sshPublicKeys/{sshPublicKeysId}", + "path": "v1beta/{+name}", + "id": "oslogin.users.sshPublicKeys.patch", + "request": { + "$ref": "SshPublicKey" + }, + "description": "Updates an SSH public key and returns the profile information. This method\nsupports patch semantics." + } + } + }, + "projects": { + "methods": { + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/compute" + ], + "parameters": { + "name": { + "description": "A reference to the POSIX account to update. POSIX accounts are identified\nby the project ID they are associated with. A reference to the POSIX\naccount is in format `users/{user}/projects/{project}`.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+/projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta/users/{usersId}/projects/{projectsId}", + "path": "v1beta/{+name}", + "id": "oslogin.users.projects.delete", + "description": "Deletes a POSIX account." + } + } + } + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + } + }, + "version": "v1beta", + "baseUrl": "https://oslogin.googleapis.com/", + "servicePath": "", + "description": "Manages OS login configuration for Google account users.", + "kind": "discovery#restDescription", + "basePath": "" }
diff --git a/partners/v2/partners-api.json b/partners/v2/partners-api.json index ece2c80..aa9cf90 100644 --- a/partners/v2/partners-api.json +++ b/partners/v2/partners-api.json
@@ -1,4 +1,13 @@ { + "baseUrl": "https://partners.googleapis.com/", + "canonicalName": "Partners", + "kind": "discovery#restDescription", + "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.", + "servicePath": "", + "rootUrl": "https://partners.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "partners", "batchPath": "batch", "revision": "20171211", "documentationLink": "https://developers.google.com/partners/", @@ -8,763 +17,9 @@ "ownerName": "Google", "version_module": true, "resources": { - "v2": { - "methods": { - "updateCompanies": { - "description": "Update company.\nShould only be called within the context of an authorized logged in user.", - "request": { - "$ref": "Company" - }, - "response": { - "$ref": "Company" - }, - "parameterOrder": [], - "httpMethod": "PATCH", - "parameters": { - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "location": "query", - "description": "Locale to use for the current request.", - "type": "string" - }, - "requestMetadata.userOverrides.ipAddress": { - "location": "query", - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string" - }, - "updateMask": { - "location": "query", - "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.", - "format": "google-fieldmask", - "type": "string" - }, - "requestMetadata.experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true, - "location": "query" - }, - "requestMetadata.trafficSource.trafficSubId": { - "location": "query", - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - } - }, - "flatPath": "v2/companies", - "path": "v2/companies", - "id": "partners.updateCompanies" - }, - "getPartnersstatus": { - "flatPath": "v2/partnersstatus", - "path": "v2/partnersstatus", - "id": "partners.getPartnersstatus", - "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.", - "response": { - "$ref": "GetPartnersStatusResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": { - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.userId": { - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.ipAddress": { - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" - } - } - }, - "updateLeads": { - "request": { - "$ref": "Lead" - }, - "description": "Updates the specified lead.", - "httpMethod": "PATCH", - "parameterOrder": [], - "response": { - "$ref": "Lead" - }, - "parameters": { - "updateMask": { - "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.ipAddress": { - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2/leads", - "id": "partners.updateLeads", - "path": "v2/leads" - } - } - }, - "users": { - "methods": { - "createCompanyRelation": { - "request": { - "$ref": "CompanyRelation" - }, - "description": "Creates a user's company relation. Affiliates the user to a company.", - "response": { - "$ref": "CompanyRelation" - }, - "parameterOrder": [ - "userId" - ], - "httpMethod": "PUT", - "parameters": { - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "requestMetadata.partnersSessionId": { - "location": "query", - "description": "Google Partners session ID.", - "type": "string" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.ipAddress": { - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" - }, - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "userId": { - "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v2/users/{userId}/companyRelation", - "path": "v2/users/{userId}/companyRelation", - "id": "partners.users.createCompanyRelation" - }, - "deleteCompanyRelation": { - "flatPath": "v2/users/{userId}/companyRelation", - "id": "partners.users.deleteCompanyRelation", - "path": "v2/users/{userId}/companyRelation", - "description": "Deletes a user's company relation. Unaffiliaites the user from a company.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "userId" - ], - "parameters": { - "requestMetadata.partnersSessionId": { - "location": "query", - "description": "Google Partners session ID.", - "type": "string" - }, - "requestMetadata.userOverrides.userId": { - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "location": "query", - "description": "Locale to use for the current request.", - "type": "string" - }, - "requestMetadata.userOverrides.ipAddress": { - "location": "query", - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string" - }, - "requestMetadata.experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true, - "location": "query" - }, - "userId": { - "location": "path", - "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.", - "required": true, - "type": "string" - }, - "requestMetadata.trafficSource.trafficSubId": { - "location": "query", - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - } - } - }, - "get": { - "description": "Gets a user.", - "response": { - "$ref": "User" - }, - "parameterOrder": [ - "userId" - ], - "httpMethod": "GET", - "parameters": { - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "requestMetadata.partnersSessionId": { - "location": "query", - "description": "Google Partners session ID.", - "type": "string" - }, - "userView": { - "location": "query", - "enum": [ - "BASIC", - "PROFILE", - "PUBLIC_PROFILE" - ], - "description": "Specifies what parts of the user information to return.", - "type": "string" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "location": "query", - "description": "Locale to use for the current request.", - "type": "string" - }, - "requestMetadata.userOverrides.ipAddress": { - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" - }, - "requestMetadata.experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true, - "location": "query" - }, - "requestMetadata.trafficSource.trafficSubId": { - "location": "query", - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - }, - "userId": { - "location": "path", - "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.", - "required": true, - "type": "string" - } - }, - "flatPath": "v2/users/{userId}", - "path": "v2/users/{userId}", - "id": "partners.users.get" - }, - "updateProfile": { - "flatPath": "v2/users/profile", - "path": "v2/users/profile", - "id": "partners.users.updateProfile", - "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.", - "request": { - "$ref": "UserProfile" - }, - "response": { - "$ref": "UserProfile" - }, - "parameterOrder": [], - "httpMethod": "PATCH", - "parameters": { - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.ipAddress": { - "location": "query", - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string" - }, - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "requestMetadata.trafficSource.trafficSubId": { - "location": "query", - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - } - } - } - } - }, - "companies": { - "methods": { - "get": { - "description": "Gets a company.", - "httpMethod": "GET", - "response": { - "$ref": "GetCompanyResponse" - }, - "parameterOrder": [ - "companyId" - ], - "parameters": { - "requestMetadata.trafficSource.trafficSourceId": { - "location": "query", - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - }, - "requestMetadata.userOverrides.ipAddress": { - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" - }, - "companyId": { - "location": "path", - "description": "The ID of the company to retrieve.", - "required": true, - "type": "string" - }, - "currencyCode": { - "location": "query", - "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.", - "type": "string" - }, - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "orderBy": { - "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.", - "type": "string", - "location": "query" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.userId": { - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string", - "location": "query" - }, - "view": { - "location": "query", - "enum": [ - "COMPANY_VIEW_UNSPECIFIED", - "CV_GOOGLE_PARTNER_SEARCH" - ], - "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.", - "type": "string" - }, - "address": { - "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2/companies/{companyId}", - "id": "partners.companies.get", - "path": "v2/companies/{companyId}" - }, - "list": { - "description": "Lists companies.", - "httpMethod": "GET", - "response": { - "$ref": "ListCompaniesResponse" - }, - "parameterOrder": [], - "parameters": { - "languageCodes": { - "location": "query", - "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").", - "type": "string", - "repeated": true - }, - "pageSize": { - "location": "query", - "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.", - "format": "int32", - "type": "integer" - }, - "requestMetadata.userOverrides.ipAddress": { - "location": "query", - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string" - }, - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "orderBy": { - "location": "query", - "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.", - "type": "string" - }, - "specializations": { - "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.", - "type": "string", - "repeated": true, - "location": "query", - "enum": [ - "BADGE_SPECIALIZATION_UNKNOWN", - "BADGE_SPECIALIZATION_ADWORDS_SEARCH", - "BADGE_SPECIALIZATION_ADWORDS_DISPLAY", - "BADGE_SPECIALIZATION_ADWORDS_MOBILE", - "BADGE_SPECIALIZATION_ADWORDS_VIDEO", - "BADGE_SPECIALIZATION_ADWORDS_SHOPPING" - ] - }, - "maxMonthlyBudget.currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "minMonthlyBudget.currencyCode": { - "description": "The 3-letter currency code defined in ISO 4217.", - "type": "string", - "location": "query" - }, - "view": { - "location": "query", - "enum": [ - "COMPANY_VIEW_UNSPECIFIED", - "CV_GOOGLE_PARTNER_SEARCH" - ], - "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.", - "type": "string" - }, - "address": { - "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - }, - "minMonthlyBudget.units": { - "location": "query", - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", - "format": "int64", - "type": "string" - }, - "maxMonthlyBudget.nanos": { - "location": "query", - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", - "format": "int32", - "type": "integer" - }, - "services": { - "location": "query", - "enum": [ - "SERVICE_UNSPECIFIED", - "S_ADVANCED_ADWORDS_SUPPORT", - "S_ADVERTISING_ON_GOOGLE", - "S_AN_ENHANCED_WEBSITE", - "S_AN_ONLINE_MARKETING_PLAN", - "S_MOBILE_AND_VIDEO_ADS", - "S_MOBILE_WEBSITE_SERVICES" - ], - "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.", - "type": "string", - "repeated": true - }, - "requestMetadata.trafficSource.trafficSourceId": { - "location": "query", - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - }, - "maxMonthlyBudget.units": { - "location": "query", - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", - "format": "int64", - "type": "string" - }, - "minMonthlyBudget.nanos": { - "location": "query", - "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", - "format": "int32", - "type": "integer" - }, - "requestMetadata.trafficSource.trafficSubId": { - "location": "query", - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.", - "type": "string", - "location": "query" - }, - "companyName": { - "location": "query", - "description": "Company name to search for.", - "type": "string" - }, - "industries": { - "location": "query", - "enum": [ - "INDUSTRY_UNSPECIFIED", - "I_AUTOMOTIVE", - "I_BUSINESS_TO_BUSINESS", - "I_CONSUMER_PACKAGED_GOODS", - "I_EDUCATION", - "I_FINANCE", - "I_HEALTHCARE", - "I_MEDIA_AND_ENTERTAINMENT", - "I_RETAIL", - "I_TECHNOLOGY", - "I_TRAVEL" - ], - "description": "List of industries the company can help with.", - "type": "string", - "repeated": true - }, - "websiteUrl": { - "location": "query", - "description": "Website URL that will help to find a better matched company.\n.", - "type": "string" - }, - "gpsMotivations": { - "location": "query", - "enum": [ - "GPS_MOTIVATION_UNSPECIFIED", - "GPSM_HELP_WITH_ADVERTISING", - "GPSM_HELP_WITH_WEBSITE", - "GPSM_NO_WEBSITE" - ], - "description": "List of reasons for using Google Partner Search to get companies.", - "type": "string", - "repeated": true - } - }, - "flatPath": "v2/companies", - "id": "partners.companies.list", - "path": "v2/companies" - } - }, - "resources": { - "leads": { - "methods": { - "create": { - "description": "Creates an advertiser lead for the given company ID.", - "request": { - "$ref": "CreateLeadRequest" - }, - "response": { - "$ref": "CreateLeadResponse" - }, - "parameterOrder": [ - "companyId" - ], - "httpMethod": "POST", - "parameters": { - "companyId": { - "description": "The ID of the company to contact.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v2/companies/{companyId}/leads", - "path": "v2/companies/{companyId}/leads", - "id": "partners.companies.leads.create" - } - } - } - } - }, - "userEvents": { - "methods": { - "log": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "LogUserEventResponse" - }, - "parameters": {}, - "flatPath": "v2/userEvents:log", - "id": "partners.userEvents.log", - "path": "v2/userEvents:log", - "request": { - "$ref": "LogUserEventRequest" - }, - "description": "Logs a user event." - } - } - }, - "clientMessages": { - "methods": { - "log": { - "response": { - "$ref": "LogMessageResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "flatPath": "v2/clientMessages:log", - "path": "v2/clientMessages:log", - "id": "partners.clientMessages.log", - "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.", - "request": { - "$ref": "LogMessageRequest" - } - } - } - }, "exams": { "methods": { "getToken": { - "flatPath": "v2/exams/{examType}/token", - "path": "v2/exams/{examType}/token", - "id": "partners.exams.getToken", "description": "Gets an Exam Token for a Partner's user to take an exam in the Exams System", "response": { "$ref": "ExamToken" @@ -780,20 +35,20 @@ "location": "query" }, "requestMetadata.locale": { - "location": "query", "description": "Locale to use for the current request.", - "type": "string" + "type": "string", + "location": "query" }, "requestMetadata.userOverrides.ipAddress": { + "location": "query", "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" + "type": "string" }, "requestMetadata.experimentIds": { + "location": "query", "description": "Experiment IDs the current request belongs to.", "type": "string", - "repeated": true, - "location": "query" + "repeated": true }, "requestMetadata.trafficSource.trafficSubId": { "location": "query", @@ -819,23 +74,27 @@ "CET_MOBILE_SITES" ] }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, "requestMetadata.userOverrides.userId": { "description": "Logged-in user ID to impersonate instead of the user's ID.", "type": "string", "location": "query" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" } - } + }, + "flatPath": "v2/exams/{examType}/token", + "path": "v2/exams/{examType}/token", + "id": "partners.exams.getToken" } } }, "leads": { "methods": { "list": { + "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user.", "response": { "$ref": "ListLeadsResponse" }, @@ -843,19 +102,19 @@ "httpMethod": "GET", "parameters": { "requestMetadata.partnersSessionId": { + "location": "query", "description": "Google Partners session ID.", - "type": "string", - "location": "query" + "type": "string" }, "requestMetadata.userOverrides.userId": { + "location": "query", "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string", - "location": "query" + "type": "string" }, "pageToken": { - "location": "query", "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListLeadsResponse.next_page_token`\nreturned from the previous call to\nListLeads.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", @@ -869,64 +128,6 @@ "location": "query" }, "requestMetadata.locale": { - "location": "query", - "description": "Locale to use for the current request.", - "type": "string" - }, - "requestMetadata.userOverrides.ipAddress": { - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string", - "location": "query" - }, - "requestMetadata.experimentIds": { - "location": "query", - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true - }, - "orderBy": { - "location": "query", - "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported", - "type": "string" - }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v2/leads", - "path": "v2/leads", - "id": "partners.leads.list", - "description": "Lists advertiser leads for a user's associated company.\nShould only be called within the context of an authorized logged in user." - } - } - }, - "offers": { - "methods": { - "list": { - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListOffersResponse" - }, - "parameters": { - "requestMetadata.userOverrides.userId": { - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.partnersSessionId": { - "location": "query", - "description": "Google Partners session ID.", - "type": "string" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "location": "query", - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - }, - "requestMetadata.locale": { "description": "Locale to use for the current request.", "type": "string", "location": "query" @@ -943,50 +144,106 @@ "location": "query" }, "requestMetadata.trafficSource.trafficSubId": { - "location": "query", "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "orderBy": { + "location": "query", + "description": "How to order Leads. Currently, only `create_time`\nand `create_time desc` are supported", "type": "string" } }, + "flatPath": "v2/leads", + "path": "v2/leads", + "id": "partners.leads.list" + } + } + }, + "offers": { + "methods": { + "list": { + "description": "Lists the Offers available for the current user", + "response": { + "$ref": "ListOffersResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "requestMetadata.userOverrides.userId": { + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.ipAddress": { + "location": "query", + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string" + }, + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + } + }, "flatPath": "v2/offers", - "id": "partners.offers.list", "path": "v2/offers", - "description": "Lists the Offers available for the current user" + "id": "partners.offers.list" } }, "resources": { "history": { "methods": { "list": { + "flatPath": "v2/offers/history", + "path": "v2/offers/history", + "id": "partners.offers.history.list", + "description": "Lists the Historical Offers for the current user (or user's entire company)", "response": { "$ref": "ListOffersHistoryResponse" }, "parameterOrder": [], "httpMethod": "GET", "parameters": { + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, "entireCompany": { "description": "if true, show history for the entire company. Requires user to be admin.", "type": "boolean", "location": "query" }, - "requestMetadata.experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true, - "location": "query" - }, - "orderBy": { + "requestMetadata.trafficSource.trafficSubId": { "location": "query", - "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type.", + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", "type": "string" }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", + "orderBy": { + "description": "Comma-separated list of fields to order by, e.g.: \"foo,bar,baz\".\nUse \"foo desc\" to sort descending.\nList of valid field names is: name, offer_code, expiration_time, status,\n last_modified_time, sender_name, creation_time, country_code,\n offer_type.", "type": "string", "location": "query" }, @@ -995,22 +252,27 @@ "description": "Logged-in user ID to impersonate instead of the user's ID.", "type": "string" }, - "pageToken": { - "location": "query", - "description": "Token to retrieve a specific page.", - "type": "string" - }, - "pageSize": { - "description": "Maximum number of rows to return per page.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", "type": "string", "location": "query" }, + "pageToken": { + "description": "Token to retrieve a specific page.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Maximum number of rows to return per page.", + "format": "int32", + "type": "integer" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, "requestMetadata.locale": { "location": "query", "description": "Locale to use for the current request.", @@ -1021,104 +283,36 @@ "description": "IP address to use instead of the user's geo-located IP address.", "type": "string" } - }, - "flatPath": "v2/offers/history", - "path": "v2/offers/history", - "id": "partners.offers.history.list", - "description": "Lists the Historical Offers for the current user (or user's entire company)" + } } } } } }, - "userStates": { - "methods": { - "list": { - "description": "Lists states for current user.", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListUserStatesResponse" - }, - "parameters": { - "requestMetadata.userOverrides.userId": { - "location": "query", - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, - "requestMetadata.partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string", - "location": "query" - }, - "requestMetadata.trafficSource.trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" - }, - "requestMetadata.locale": { - "description": "Locale to use for the current request.", - "type": "string", - "location": "query" - }, - "requestMetadata.userOverrides.ipAddress": { - "location": "query", - "description": "IP address to use instead of the user's geo-located IP address.", - "type": "string" - }, - "requestMetadata.experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true, - "location": "query" - }, - "requestMetadata.trafficSource.trafficSubId": { - "location": "query", - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - } - }, - "flatPath": "v2/userStates", - "id": "partners.userStates.list", - "path": "v2/userStates" - } - } - }, "analytics": { "methods": { "list": { "description": "Lists analytics data for a user's associated company.\nShould only be called within the context of an authorized logged in user.", + "httpMethod": "GET", + "parameterOrder": [], "response": { "$ref": "ListAnalyticsResponse" }, - "parameterOrder": [], - "httpMethod": "GET", "parameters": { - "requestMetadata.experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "string", - "repeated": true, - "location": "query" - }, - "requestMetadata.trafficSource.trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string", - "location": "query" + "requestMetadata.partnersSessionId": { + "location": "query", + "description": "Google Partners session ID.", + "type": "string" }, "requestMetadata.userOverrides.userId": { "description": "Logged-in user ID to impersonate instead of the user's ID.", "type": "string", "location": "query" }, - "requestMetadata.partnersSessionId": { - "location": "query", - "description": "Google Partners session ID.", - "type": "string" - }, "pageToken": { - "location": "query", "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListAnalyticsResponse.next_page_token`\nreturned from the previous call to\nListAnalytics.\nWill be a date string in `YYYY-MM-DD` format representing the end date\nof the date range of results to return.\nIf unspecified or set to \"\", default value is the current date.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", @@ -1132,6 +326,607 @@ "type": "string" }, "requestMetadata.locale": { + "location": "query", + "description": "Locale to use for the current request.", + "type": "string" + }, + "requestMetadata.userOverrides.ipAddress": { + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string", + "location": "query" + }, + "requestMetadata.experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true, + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "location": "query", + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + } + }, + "flatPath": "v2/analytics", + "id": "partners.analytics.list", + "path": "v2/analytics" + } + } + }, + "userStates": { + "methods": { + "list": { + "flatPath": "v2/userStates", + "path": "v2/userStates", + "id": "partners.userStates.list", + "description": "Lists states for current user.", + "response": { + "$ref": "ListUserStatesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "requestMetadata.userOverrides.userId": { + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.locale": { + "location": "query", + "description": "Locale to use for the current request.", + "type": "string" + }, + "requestMetadata.userOverrides.ipAddress": { + "location": "query", + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string" + }, + "requestMetadata.experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true, + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "location": "query", + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + } + } + } + } + }, + "v2": { + "methods": { + "getPartnersstatus": { + "description": "Gets Partners Status of the logged in user's agency.\nShould only be called if the logged in user is the admin of the agency.", + "response": { + "$ref": "GetPartnersStatusResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "requestMetadata.userOverrides.userId": { + "location": "query", + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.ipAddress": { + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string", + "location": "query" + }, + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2/partnersstatus", + "path": "v2/partnersstatus", + "id": "partners.getPartnersstatus" + }, + "updateLeads": { + "flatPath": "v2/leads", + "id": "partners.updateLeads", + "path": "v2/leads", + "request": { + "$ref": "Lead" + }, + "description": "Updates the specified lead.", + "httpMethod": "PATCH", + "parameterOrder": [], + "response": { + "$ref": "Lead" + }, + "parameters": { + "requestMetadata.userOverrides.userId": { + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.partnersSessionId": { + "location": "query", + "description": "Google Partners session ID.", + "type": "string" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.ipAddress": { + "location": "query", + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.\nOnly `state` and `adwords_customer_id` are currently supported.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "requestMetadata.experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true, + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "location": "query", + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + } + } + }, + "updateCompanies": { + "description": "Update company.\nShould only be called within the context of an authorized logged in user.", + "request": { + "$ref": "Company" + }, + "response": { + "$ref": "Company" + }, + "parameterOrder": [], + "httpMethod": "PATCH", + "parameters": { + "requestMetadata.userOverrides.userId": { + "location": "query", + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" + }, + "requestMetadata.partnersSessionId": { + "location": "query", + "description": "Google Partners session ID.", + "type": "string" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.ipAddress": { + "location": "query", + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string" + }, + "updateMask": { + "description": "Standard field mask for the set of fields to be updated.\nRequired with at least 1 value in FieldMask's paths.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "requestMetadata.experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true, + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "location": "query", + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + } + }, + "flatPath": "v2/companies", + "path": "v2/companies", + "id": "partners.updateCompanies" + } + } + }, + "companies": { + "methods": { + "get": { + "flatPath": "v2/companies/{companyId}", + "id": "partners.companies.get", + "path": "v2/companies/{companyId}", + "description": "Gets a company.", + "httpMethod": "GET", + "parameterOrder": [ + "companyId" + ], + "response": { + "$ref": "GetCompanyResponse" + }, + "parameters": { + "companyId": { + "location": "path", + "description": "The ID of the company to retrieve.", + "required": true, + "type": "string" + }, + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, + "currencyCode": { + "description": "If the company's budget is in a different currency code than this one, then\nthe converted budget is converted to this currency code.", + "type": "string", + "location": "query" + }, + "orderBy": { + "description": "How to order addresses within the returned company. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "location": "query", + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.userOverrides.userId": { + "location": "query", + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" + }, + "requestMetadata.partnersSessionId": { + "location": "query", + "description": "Google Partners session ID.", + "type": "string" + }, + "view": { + "location": "query", + "enum": [ + "COMPANY_VIEW_UNSPECIFIED", + "CV_GOOGLE_PARTNER_SEARCH" + ], + "description": "The view of `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.", + "type": "string" + }, + "requestMetadata.locale": { + "location": "query", + "description": "Locale to use for the current request.", + "type": "string" + }, + "address": { + "description": "The address to use for sorting the company's addresses by proximity.\nIf not given, the geo-located address of the request is used.\nUsed when order_by is set.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.userOverrides.ipAddress": { + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string", + "location": "query" + } + } + }, + "list": { + "response": { + "$ref": "ListCompaniesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "specializations": { + "location": "query", + "enum": [ + "BADGE_SPECIALIZATION_UNKNOWN", + "BADGE_SPECIALIZATION_ADWORDS_SEARCH", + "BADGE_SPECIALIZATION_ADWORDS_DISPLAY", + "BADGE_SPECIALIZATION_ADWORDS_MOBILE", + "BADGE_SPECIALIZATION_ADWORDS_VIDEO", + "BADGE_SPECIALIZATION_ADWORDS_SHOPPING" + ], + "description": "List of specializations that the returned agencies should provide. If this\nis not empty, any returned agency must have at least one of these\nspecializations, or one of the services in the \"services\" field.", + "type": "string", + "repeated": true + }, + "maxMonthlyBudget.currencyCode": { + "location": "query", + "description": "The 3-letter currency code defined in ISO 4217.", + "type": "string" + }, + "requestMetadata.userOverrides.userId": { + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string", + "location": "query" + }, + "minMonthlyBudget.currencyCode": { + "location": "query", + "description": "The 3-letter currency code defined in ISO 4217.", + "type": "string" + }, + "view": { + "location": "query", + "enum": [ + "COMPANY_VIEW_UNSPECIFIED", + "CV_GOOGLE_PARTNER_SEARCH" + ], + "description": "The view of the `Company` resource to be returned. This must not be\n`COMPANY_VIEW_UNSPECIFIED`.", + "type": "string" + }, + "address": { + "location": "query", + "description": "The address to use when searching for companies.\nIf not given, the geo-located address of the request is used.", + "type": "string" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "minMonthlyBudget.units": { + "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string", + "location": "query" + }, + "maxMonthlyBudget.nanos": { + "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "services": { + "location": "query", + "enum": [ + "SERVICE_UNSPECIFIED", + "S_ADVANCED_ADWORDS_SUPPORT", + "S_ADVERTISING_ON_GOOGLE", + "S_AN_ENHANCED_WEBSITE", + "S_AN_ONLINE_MARKETING_PLAN", + "S_MOBILE_AND_VIDEO_ADS", + "S_MOBILE_WEBSITE_SERVICES" + ], + "description": "List of services that the returned agencies should provide. If this is\nnot empty, any returned agency must have at least one of these services,\nor one of the specializations in the \"specializations\" field.", + "type": "string", + "repeated": true + }, + "maxMonthlyBudget.units": { + "location": "query", + "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "minMonthlyBudget.nanos": { + "location": "query", + "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", + "format": "int32", + "type": "integer" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "companyName": { + "description": "Company name to search for.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "A token identifying a page of results that the server returns.\nTypically, this is the value of `ListCompaniesResponse.next_page_token`\nreturned from the previous call to\nListCompanies.", + "type": "string" + }, + "industries": { + "location": "query", + "enum": [ + "INDUSTRY_UNSPECIFIED", + "I_AUTOMOTIVE", + "I_BUSINESS_TO_BUSINESS", + "I_CONSUMER_PACKAGED_GOODS", + "I_EDUCATION", + "I_FINANCE", + "I_HEALTHCARE", + "I_MEDIA_AND_ENTERTAINMENT", + "I_RETAIL", + "I_TECHNOLOGY", + "I_TRAVEL" + ], + "description": "List of industries the company can help with.", + "type": "string", + "repeated": true + }, + "websiteUrl": { + "description": "Website URL that will help to find a better matched company.\n.", + "type": "string", + "location": "query" + }, + "gpsMotivations": { + "description": "List of reasons for using Google Partner Search to get companies.", + "type": "string", + "repeated": true, + "location": "query", + "enum": [ + "GPS_MOTIVATION_UNSPECIFIED", + "GPSM_HELP_WITH_ADVERTISING", + "GPSM_HELP_WITH_WEBSITE", + "GPSM_NO_WEBSITE" + ] + }, + "languageCodes": { + "location": "query", + "description": "List of language codes that company can support. Only primary language\nsubtags are accepted as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").", + "type": "string", + "repeated": true + }, + "pageSize": { + "location": "query", + "description": "Requested page size. Server may return fewer companies than requested.\nIf unspecified, server picks an appropriate default.", + "format": "int32", + "type": "integer" + }, + "requestMetadata.userOverrides.ipAddress": { + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string", + "location": "query" + }, + "requestMetadata.experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true, + "location": "query" + }, + "orderBy": { + "location": "query", + "description": "How to order addresses within the returned companies. Currently, only\n`address` and `address desc` is supported which will sorted by closest to\nfarthest in distance from given address and farthest to closest distance\nfrom given address respectively.", + "type": "string" + } + }, + "flatPath": "v2/companies", + "path": "v2/companies", + "id": "partners.companies.list", + "description": "Lists companies." + } + }, + "resources": { + "leads": { + "methods": { + "create": { + "request": { + "$ref": "CreateLeadRequest" + }, + "description": "Creates an advertiser lead for the given company ID.", + "httpMethod": "POST", + "parameterOrder": [ + "companyId" + ], + "response": { + "$ref": "CreateLeadResponse" + }, + "parameters": { + "companyId": { + "location": "path", + "description": "The ID of the company to contact.", + "required": true, + "type": "string" + } + }, + "flatPath": "v2/companies/{companyId}/leads", + "id": "partners.companies.leads.create", + "path": "v2/companies/{companyId}/leads" + } + } + } + } + }, + "users": { + "methods": { + "createCompanyRelation": { + "request": { + "$ref": "CompanyRelation" + }, + "description": "Creates a user's company relation. Affiliates the user to a company.", + "httpMethod": "PUT", + "parameterOrder": [ + "userId" + ], + "response": { + "$ref": "CompanyRelation" + }, + "parameters": { + "requestMetadata.experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true, + "location": "query" + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "userId": { + "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.", + "required": true, + "type": "string", + "location": "path" + }, + "requestMetadata.userOverrides.userId": { + "location": "query", + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.locale": { "description": "Locale to use for the current request.", "type": "string", "location": "query" @@ -1142,30 +937,275 @@ "type": "string" } }, - "flatPath": "v2/analytics", - "path": "v2/analytics", - "id": "partners.analytics.list" + "flatPath": "v2/users/{userId}/companyRelation", + "id": "partners.users.createCompanyRelation", + "path": "v2/users/{userId}/companyRelation" + }, + "deleteCompanyRelation": { + "description": "Deletes a user's company relation. Unaffiliaites the user from a company.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "userId" + ], + "httpMethod": "DELETE", + "parameters": { + "requestMetadata.userOverrides.userId": { + "location": "query", + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.ipAddress": { + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string", + "location": "query" + }, + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, + "userId": { + "description": "The ID of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean\nthe currently authenticated user.", + "required": true, + "type": "string", + "location": "path" + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2/users/{userId}/companyRelation", + "path": "v2/users/{userId}/companyRelation", + "id": "partners.users.deleteCompanyRelation" + }, + "get": { + "description": "Gets a user.", + "response": { + "$ref": "User" + }, + "parameterOrder": [ + "userId" + ], + "httpMethod": "GET", + "parameters": { + "requestMetadata.userOverrides.userId": { + "location": "query", + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" + }, + "requestMetadata.partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string", + "location": "query" + }, + "userView": { + "description": "Specifies what parts of the user information to return.", + "type": "string", + "location": "query", + "enum": [ + "BASIC", + "PROFILE", + "PUBLIC_PROFILE" + ] + }, + "requestMetadata.trafficSource.trafficSourceId": { + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "requestMetadata.locale": { + "location": "query", + "description": "Locale to use for the current request.", + "type": "string" + }, + "requestMetadata.userOverrides.ipAddress": { + "location": "query", + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string" + }, + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, + "userId": { + "description": "Identifier of the user. Can be set to \u003ccode\u003eme\u003c/code\u003e to mean the currently\nauthenticated user.", + "required": true, + "type": "string", + "location": "path" + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v2/users/{userId}", + "path": "v2/users/{userId}", + "id": "partners.users.get" + }, + "updateProfile": { + "flatPath": "v2/users/profile", + "path": "v2/users/profile", + "id": "partners.users.updateProfile", + "request": { + "$ref": "UserProfile" + }, + "description": "Updates a user's profile. A user can only update their own profile and\nshould only be called within the context of a logged in user.", + "response": { + "$ref": "UserProfile" + }, + "parameterOrder": [], + "httpMethod": "PATCH", + "parameters": { + "requestMetadata.experimentIds": { + "location": "query", + "description": "Experiment IDs the current request belongs to.", + "type": "string", + "repeated": true + }, + "requestMetadata.trafficSource.trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.userId": { + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string", + "location": "query" + }, + "requestMetadata.partnersSessionId": { + "location": "query", + "description": "Google Partners session ID.", + "type": "string" + }, + "requestMetadata.trafficSource.trafficSourceId": { + "location": "query", + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "requestMetadata.locale": { + "description": "Locale to use for the current request.", + "type": "string", + "location": "query" + }, + "requestMetadata.userOverrides.ipAddress": { + "location": "query", + "description": "IP address to use instead of the user's geo-located IP address.", + "type": "string" + } + } + } + } + }, + "userEvents": { + "methods": { + "log": { + "flatPath": "v2/userEvents:log", + "id": "partners.userEvents.log", + "path": "v2/userEvents:log", + "request": { + "$ref": "LogUserEventRequest" + }, + "description": "Logs a user event.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "LogUserEventResponse" + }, + "parameters": {} + } + } + }, + "clientMessages": { + "methods": { + "log": { + "flatPath": "v2/clientMessages:log", + "path": "v2/clientMessages:log", + "id": "partners.clientMessages.log", + "request": { + "$ref": "LogMessageRequest" + }, + "description": "Logs a generic message from the client, such as\n`Failed to render component`, `Profile page is running slow`,\n`More than 500 users have accessed this result.`, etc.", + "response": { + "$ref": "LogMessageResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {} } } } }, "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "access_token": { + "description": "OAuth access token.", "type": "string", "location": "query" }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", @@ -1190,6 +1230,8 @@ "location": "query" }, "alt": { + "description": "Data format for response.", + "default": "json", "enum": [ "json", "media", @@ -1201,47 +1243,751 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], - "location": "query", - "description": "Data format for response.", - "default": "json" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", "location": "query" } }, "schemas": { + "ListUserStatesResponse": { + "properties": { + "responseMetadata": { + "description": "Current response metadata.", + "$ref": "ResponseMetadata" + }, + "userStates": { + "description": "User's states.", + "type": "array", + "items": { + "enum": [ + "USER_STATE_UNSPECIFIED", + "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT" + ], + "type": "string" + }, + "enumDescriptions": [ + "Unchosen.", + "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search." + ] + } + }, + "id": "ListUserStatesResponse", + "description": "Response message for\nListUserStates.", + "type": "object" + }, + "CompanyRelation": { + "properties": { + "resolvedTimestamp": { + "description": "The timestamp when the user was approved.\n@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "companyAdmin": { + "description": "Indicates if the user is an admin for this company.", + "type": "boolean" + }, + "address": { + "description": "The primary address for this company.", + "type": "string" + }, + "isPending": { + "description": "The flag that indicates if the company is pending verification.", + "type": "boolean" + }, + "creationTime": { + "description": "The timestamp of when affiliation was requested.\n@OutputOnly", + "format": "google-datetime", + "type": "string" + }, + "state": { + "enumDescriptions": [ + "Default unspecified value.", + "User has filled in a request to be associated with an company.\nNow waiting email confirmation.", + "Pending approval from company.\nEmail confirmation will not approve this one.", + "Approved by company." + ], + "enum": [ + "USER_COMPANY_REATION_STATE_NONE_SPECIFIED", + "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL", + "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN", + "USER_COMPANY_RELATION_STATE_APPROVED" + ], + "description": "The state of relationship, in terms of approvals.", + "type": "string" + }, + "primaryAddress": { + "description": "The primary location of the company.", + "$ref": "Location" + }, + "managerAccount": { + "description": "The AdWords manager account # associated this company.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "The name (in the company's primary language) for the company.", + "type": "string" + }, + "segment": { + "description": "The segment the company is classified as.", + "type": "array", + "items": { + "enum": [ + "COMPANY_SEGMENT_UNKNOWN", + "COMPANY_SEGMENT_NAL", + "COMPANY_SEGMENT_PSP", + "COMPANY_SEGMENT_PPSP" + ], + "type": "string" + }, + "enumDescriptions": [ + "Default segment indicates an unknown.", + "Segment representing a selected group of Partners", + "Segment representing Premier SMB Partners, an AdWords partnership program.", + "A segment of Premier SMB Partners that have relationship with Google." + ] + }, + "internalCompanyId": { + "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.", + "type": "string" + }, + "specializationStatus": { + "description": "The list of Google Partners specialization statuses for the company.", + "type": "array", + "items": { + "$ref": "SpecializationStatus" + } + }, + "badgeTier": { + "enumDescriptions": [ + "Tier badge is not set.", + "Agency has regular partner badge.", + "Agency has premier badge." + ], + "enum": [ + "BADGE_TIER_NONE", + "BADGE_TIER_REGULAR", + "BADGE_TIER_PREMIER" + ], + "description": "Whether the company is a Partner.", + "type": "string" + }, + "website": { + "description": "The website URL for this company.", + "type": "string" + }, + "phoneNumber": { + "description": "The phone number for the company's primary address.", + "type": "string" + }, + "primaryCountryCode": { + "description": "The primary country code of the company.", + "type": "string" + }, + "companyId": { + "description": "The ID of the company. There may be no id if this is a\npending company.5", + "type": "string" + }, + "primaryLanguageCode": { + "description": "The primary language code of the company.", + "type": "string" + }, + "logoUrl": { + "description": "A URL to a profile photo, e.g. a G+ profile photo.", + "type": "string" + } + }, + "id": "CompanyRelation", + "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.", + "type": "object" + }, + "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" + } + }, + "id": "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`.", + "type": "object" + }, + "Empty": { + "properties": {}, + "id": "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 `{}`.", + "type": "object" + }, + "TrafficSource": { + "properties": { + "trafficSourceId": { + "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + }, + "trafficSubId": { + "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", + "type": "string" + } + }, + "id": "TrafficSource", + "description": "Source of traffic for the current request.", + "type": "object" + }, + "RequestMetadata": { + "description": "Common data that is in each API request.", + "type": "object", + "properties": { + "locale": { + "description": "Locale to use for the current request.", + "type": "string" + }, + "userOverrides": { + "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products.", + "$ref": "UserOverrides" + }, + "partnersSessionId": { + "description": "Google Partners session ID.", + "type": "string" + }, + "experimentIds": { + "description": "Experiment IDs the current request belongs to.", + "type": "array", + "items": { + "type": "string" + } + }, + "trafficSource": { + "description": "Source of traffic for the current request.", + "$ref": "TrafficSource" + } + }, + "id": "RequestMetadata" + }, + "CreateLeadRequest": { + "description": "Request message for CreateLead.", + "type": "object", + "properties": { + "requestMetadata": { + "description": "Current request metadata.", + "$ref": "RequestMetadata" + }, + "lead": { + "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided.", + "$ref": "Lead" + }, + "recaptchaChallenge": { + "$ref": "RecaptchaChallenge", + "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info." + } + }, + "id": "CreateLeadRequest" + }, + "EventData": { + "description": "Key value data pair for an event.", + "type": "object", + "properties": { + "key": { + "enumDescriptions": [ + "Unchosen.", + "Action data.", + "Agency ID data.", + "Agency name data.", + "Agency phone number data.", + "Agency website data.", + "Budget data.", + "Center-point data.", + "Certification data.", + "Comment data.", + "Country data.", + "Currency data.", + "Currently viewed agency ID data.", + "Distance data.", + "Distance type data.", + "Exam data.", + "History token data.", + "Identifier data.", + "Industry data.", + "Insight tag data.", + "Language data.", + "Location data.", + "Marketing opt-in data.", + "Query data.", + "Search start index data.", + "Service data.", + "Show vow data.", + "Solution data.", + "Traffic source ID data.", + "Traffic sub ID data.", + "Viewport data.", + "Website data.", + "Details data.", + "Experiment ID data.", + "Google Partner Search motivation data.", + "URL data.", + "Element we wanted user to focus on.", + "Progress when viewing an item \\[0-100\\]." + ], + "enum": [ + "EVENT_DATA_TYPE_UNSPECIFIED", + "ACTION", + "AGENCY_ID", + "AGENCY_NAME", + "AGENCY_PHONE_NUMBER", + "AGENCY_WEBSITE", + "BUDGET", + "CENTER_POINT", + "CERTIFICATION", + "COMMENT", + "COUNTRY", + "CURRENCY", + "CURRENTLY_VIEWED_AGENCY_ID", + "DISTANCE", + "DISTANCE_TYPE", + "EXAM", + "HISTORY_TOKEN", + "ID", + "INDUSTRY", + "INSIGHT_TAG", + "LANGUAGE", + "LOCATION", + "MARKETING_OPT_IN", + "QUERY", + "SEARCH_START_INDEX", + "SERVICE", + "SHOW_VOW", + "SOLUTION", + "TRAFFIC_SOURCE_ID", + "TRAFFIC_SUB_ID", + "VIEW_PORT", + "WEBSITE", + "DETAILS", + "EXPERIMENT_ID", + "GPS_MOTIVATION", + "URL", + "ELEMENT_FOCUS", + "PROGRESS" + ], + "description": "Data type.", + "type": "string" + }, + "values": { + "description": "Data values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "EventData" + }, + "ExamStatus": { + "description": "A user's information on a specific exam.", + "type": "object", + "properties": { + "examType": { + "enumDescriptions": [ + "Unchosen.", + "Adwords Fundamentals exam.", + "AdWords advanced search exam.", + "AdWords advanced display exam.", + "VideoAds exam.", + "DoubleClick exam.", + "Analytics exam.", + "Shopping exam.", + "Mobile exam.", + "Digital Sales exam.", + "Mobile Sites exam." + ], + "enum": [ + "CERTIFICATION_EXAM_TYPE_UNSPECIFIED", + "CET_ADWORDS_FUNDAMENTALS", + "CET_ADWORDS_ADVANCED_SEARCH", + "CET_ADWORDS_ADVANCED_DISPLAY", + "CET_VIDEO_ADS", + "CET_DOUBLECLICK", + "CET_ANALYTICS", + "CET_SHOPPING", + "CET_MOBILE", + "CET_DIGITAL_SALES", + "CET_MOBILE_SITES" + ], + "description": "The type of the exam.", + "type": "string" + }, + "passed": { + "description": "Whether this exam has been passed and not expired.", + "type": "boolean" + }, + "taken": { + "description": "The date the user last taken this exam.", + "format": "google-datetime", + "type": "string" + }, + "warning": { + "description": "Whether this exam is in the state of warning.", + "type": "boolean" + }, + "expiration": { + "description": "Date this exam is due to expire.", + "format": "google-datetime", + "type": "string" + }, + "lastPassed": { + "description": "The date the user last passed this exam.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "ExamStatus" + }, + "ListOffersResponse": { + "description": "Response for ListOffer.", + "type": "object", + "properties": { + "availableOffers": { + "description": "Available Offers to be distributed.", + "type": "array", + "items": { + "$ref": "AvailableOffer" + } + }, + "responseMetadata": { + "description": "Current response metadata.", + "$ref": "ResponseMetadata" + }, + "noOfferReason": { + "enumDescriptions": [ + "Unset.", + "Not an MCC.", + "Offer limit has been reached.", + "Ineligible for offers." + ], + "enum": [ + "NO_OFFER_REASON_UNSPECIFIED", + "NO_OFFER_REASON_NO_MCC", + "NO_OFFER_REASON_LIMIT_REACHED", + "NO_OFFER_REASON_INELIGIBLE" + ], + "description": "Reason why no Offers are available.", + "type": "string" + } + }, + "id": "ListOffersResponse" + }, + "CountryOfferInfo": { + "properties": { + "offerCountryCode": { + "description": "Country code for which offer codes may be requested.", + "type": "string" + }, + "spendXAmount": { + "description": "(localized) Spend X amount for that country's offer.", + "type": "string" + }, + "offerType": { + "enumDescriptions": [ + "Unset.", + "AdWords spend X get Y.", + "Youtube video.", + "Spend Match up to Y." + ], + "enum": [ + "OFFER_TYPE_UNSPECIFIED", + "OFFER_TYPE_SPEND_X_GET_Y", + "OFFER_TYPE_VIDEO", + "OFFER_TYPE_SPEND_MATCH" + ], + "description": "Type of offer country is eligible for.", + "type": "string" + }, + "getYAmount": { + "description": "(localized) Get Y amount for that country's offer.", + "type": "string" + } + }, + "id": "CountryOfferInfo", + "description": "Offer info by country.", + "type": "object" + }, + "ListCompaniesResponse": { + "description": "Response message for\nListCompanies.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.", + "type": "string" + }, + "responseMetadata": { + "$ref": "ResponseMetadata", + "description": "Current response metadata." + }, + "companies": { + "description": "The list of companies.", + "type": "array", + "items": { + "$ref": "Company" + } + } + }, + "id": "ListCompaniesResponse" + }, + "OfferCustomer": { + "description": "Customers qualified for an offer.", + "type": "object", + "properties": { + "eligibilityDaysLeft": { + "description": "Days the customer is still eligible.", + "format": "int32", + "type": "integer" + }, + "creationTime": { + "description": "Time the customer was created.", + "format": "google-datetime", + "type": "string" + }, + "offerType": { + "enum": [ + "OFFER_TYPE_UNSPECIFIED", + "OFFER_TYPE_SPEND_X_GET_Y", + "OFFER_TYPE_VIDEO", + "OFFER_TYPE_SPEND_MATCH" + ], + "description": "Type of the offer", + "type": "string", + "enumDescriptions": [ + "Unset.", + "AdWords spend X get Y.", + "Youtube video.", + "Spend Match up to Y." + ] + }, + "externalCid": { + "description": "External CID for the customer.", + "format": "int64", + "type": "string" + }, + "countryCode": { + "description": "Country code of the customer.", + "type": "string" + }, + "getYAmount": { + "description": "Formatted Get Y amount with currency code.", + "type": "string" + }, + "name": { + "description": "Name of the customer.", + "type": "string" + }, + "spendXAmount": { + "description": "Formatted Spend X amount with currency code.", + "type": "string" + }, + "adwordsUrl": { + "description": "URL to the customer's AdWords page.", + "type": "string" + } + }, + "id": "OfferCustomer" + }, + "CertificationStatus": { + "description": "Google Partners certification status.", + "type": "object", + "properties": { + "examStatuses": { + "description": "List of certification exam statuses.", + "type": "array", + "items": { + "$ref": "CertificationExamStatus" + } + }, + "type": { + "enum": [ + "CERTIFICATION_TYPE_UNSPECIFIED", + "CT_ADWORDS", + "CT_YOUTUBE", + "CT_VIDEOADS", + "CT_ANALYTICS", + "CT_DOUBLECLICK", + "CT_SHOPPING", + "CT_MOBILE", + "CT_DIGITAL_SALES", + "CT_ADWORDS_SEARCH", + "CT_ADWORDS_DISPLAY", + "CT_MOBILE_SITES" + ], + "description": "The type of the certification.", + "type": "string", + "enumDescriptions": [ + "Unchosen.", + "AdWords certified.", + "YouTube certified.", + "VideoAds certified.", + "Analytics certified.", + "DoubleClick certified.", + "Shopping certified.", + "Mobile certified.", + "Digital sales certified.", + "AdWords Search certified.", + "AdWords Display certified.", + "Mobile Sites certified." + ] + }, + "userCount": { + "description": "Number of people who are certified,", + "format": "int32", + "type": "integer" + }, + "isCertified": { + "description": "Whether certification is passing.", + "type": "boolean" + } + }, + "id": "CertificationStatus" + }, + "LocalizedCompanyInfo": { + "description": "The localized company information.", + "type": "object", + "properties": { + "languageCode": { + "description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").", + "type": "string" + }, + "countryCodes": { + "description": "List of country codes for the localized company info.", + "type": "array", + "items": { + "type": "string" + } + }, + "overview": { + "description": "Localized brief description that the company uses to advertise themselves.", + "type": "string" + }, + "displayName": { + "description": "Localized display name.", + "type": "string" + } + }, + "id": "LocalizedCompanyInfo" + }, + "LogUserEventResponse": { + "description": "Response message for\nLogUserEvent.", + "type": "object", + "properties": { + "responseMetadata": { + "$ref": "ResponseMetadata", + "description": "Current response metadata." + } + }, + "id": "LogUserEventResponse" + }, + "ListOffersHistoryResponse": { + "description": "Response for ListOfferHistory.", + "type": "object", + "properties": { + "offers": { + "description": "Historical offers meeting request.", + "type": "array", + "items": { + "$ref": "HistoricalOffer" + } + }, + "nextPageToken": { + "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.", + "type": "string" + }, + "responseMetadata": { + "description": "Current response metadata.", + "$ref": "ResponseMetadata" + }, + "canShowEntireCompany": { + "description": "True if the user has the option to show entire company history.", + "type": "boolean" + }, + "totalResults": { + "description": "Number of results across all pages.", + "format": "int32", + "type": "integer" + }, + "showingEntireCompany": { + "description": "True if this response is showing entire company history.", + "type": "boolean" + } + }, + "id": "ListOffersHistoryResponse" + }, + "LogMessageResponse": { + "properties": { + "responseMetadata": { + "description": "Current response metadata.", + "$ref": "ResponseMetadata" + } + }, + "id": "LogMessageResponse", + "description": "Response message for\nLogClientMessage.", + "type": "object" + }, + "SpecializationStatus": { + "properties": { + "badgeSpecialization": { + "enumDescriptions": [ + "Unknown specialization", + "AdWords Search specialization", + "AdWords Display specialization", + "AdWords Mobile specialization", + "AdWords Video specialization", + "AdWords Shopping specialization" + ], + "enum": [ + "BADGE_SPECIALIZATION_UNKNOWN", + "BADGE_SPECIALIZATION_ADWORDS_SEARCH", + "BADGE_SPECIALIZATION_ADWORDS_DISPLAY", + "BADGE_SPECIALIZATION_ADWORDS_MOBILE", + "BADGE_SPECIALIZATION_ADWORDS_VIDEO", + "BADGE_SPECIALIZATION_ADWORDS_SHOPPING" + ], + "description": "The specialization this status is for.", + "type": "string" + }, + "badgeSpecializationState": { + "enumDescriptions": [ + "Unknown state", + "Specialization passed", + "Specialization not passed", + "Specialization in grace" + ], + "enum": [ + "BADGE_SPECIALIZATION_STATE_UNKNOWN", + "BADGE_SPECIALIZATION_STATE_PASSED", + "BADGE_SPECIALIZATION_STATE_NOT_PASSED", + "BADGE_SPECIALIZATION_STATE_IN_GRACE" + ], + "description": "State of agency specialization.", + "type": "string" + } + }, + "id": "SpecializationStatus", + "description": "Agency specialization status", + "type": "object" + }, "Certification": { "description": "A user's information on a specific certification.", "type": "object", "properties": { + "lastAchieved": { + "description": "The date the user last achieved certification.", + "format": "google-datetime", + "type": "string" + }, "achieved": { "description": "Whether this certification has been achieved.", "type": "boolean" @@ -1256,8 +2002,6 @@ "type": "boolean" }, "certificationType": { - "description": "The type of certification, the area of expertise.", - "type": "string", "enumDescriptions": [ "Unchosen.", "AdWords certified.", @@ -1285,11 +2029,8 @@ "CT_ADWORDS_SEARCH", "CT_ADWORDS_DISPLAY", "CT_MOBILE_SITES" - ] - }, - "lastAchieved": { - "description": "The date the user last achieved certification.", - "format": "google-datetime", + ], + "description": "The type of certification, the area of expertise.", "type": "string" } }, @@ -1299,26 +2040,34 @@ "description": "A resource representing a user of the Partners platform.", "type": "object", "properties": { - "profile": { - "description": "The profile information of a Partners user, contains all the directly\neditable user information.", - "$ref": "UserProfile" + "publicProfile": { + "description": "Information about a user's external public profile outside Google Partners.", + "$ref": "PublicProfile" + }, + "companyVerificationEmail": { + "description": "The email address used by the user used for company verification.\n@OutputOnly", + "type": "string" + }, + "certificationStatus": { + "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly", + "type": "array", + "items": { + "$ref": "Certification" + } }, "company": { "$ref": "CompanyRelation", "description": "The company that the user is associated with.\nIf not present, the user is not associated with any company." }, + "profile": { + "$ref": "UserProfile", + "description": "The profile information of a Partners user, contains all the directly\neditable user information." + }, "lastAccessTime": { "description": "The most recent time the user interacted with the Partners site.\n@OutputOnly", "format": "google-datetime", "type": "string" }, - "primaryEmails": { - "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, "availableAdwordsManagerAccounts": { "description": "This is the list of AdWords Manager Accounts the user has edit access to.\nIf the user has edit access to multiple accounts, the user can choose the\npreferred account and we use this when a personal account is needed. Can\nbe empty meaning the user has access to no accounts.\n@OutputOnly", "type": "array", @@ -1326,6 +2075,13 @@ "$ref": "AdWordsManagerAccountInfo" } }, + "primaryEmails": { + "description": "The list of emails the user has access to/can select as primary.\n@OutputOnly", + "type": "array", + "items": { + "type": "string" + } + }, "internalId": { "description": "The internal user ID.\nOnly available for a whitelisted set of api clients.", "type": "string" @@ -1340,21 +2096,6 @@ "id": { "description": "The ID of the user.", "type": "string" - }, - "publicProfile": { - "$ref": "PublicProfile", - "description": "Information about a user's external public profile outside Google Partners." - }, - "certificationStatus": { - "description": "The list of achieved certifications. These are calculated based on exam\nresults and other requirements.\n@OutputOnly", - "type": "array", - "items": { - "$ref": "Certification" - } - }, - "companyVerificationEmail": { - "description": "The email address used by the user used for company verification.\n@OutputOnly", - "type": "string" } }, "id": "User" @@ -1363,57 +2104,64 @@ "description": "Response message for\nListAnalytics.", "type": "object", "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.", + "type": "string" + }, + "responseMetadata": { + "$ref": "ResponseMetadata", + "description": "Current response metadata." + }, + "analyticsSummary": { + "description": "Aggregated information across the response's\nanalytics.", + "$ref": "AnalyticsSummary" + }, "analytics": { "description": "The list of analytics.\nSorted in ascending order of\nAnalytics.event_date.", "type": "array", "items": { "$ref": "Analytics" } - }, + } + }, + "id": "ListAnalyticsResponse" + }, + "ListLeadsResponse": { + "description": "Response message for ListLeads.", + "type": "object", + "properties": { "nextPageToken": { - "description": "A token to retrieve next page of results.\nPass this value in the `ListAnalyticsRequest.page_token` field in the\nsubsequent call to\nListAnalytics to retrieve the\nnext page of results.", + "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.", "type": "string" }, "responseMetadata": { "description": "Current response metadata.", "$ref": "ResponseMetadata" }, - "analyticsSummary": { - "$ref": "AnalyticsSummary", - "description": "Aggregated information across the response's\nanalytics." + "totalSize": { + "description": "The total count of leads for the given company.", + "format": "int32", + "type": "integer" + }, + "leads": { + "description": "The list of leads.", + "type": "array", + "items": { + "$ref": "Lead" + } } }, - "id": "ListAnalyticsResponse" + "id": "ListLeadsResponse" }, "Company": { "description": "A company resource in the Google Partners API. Once certified, it qualifies\nfor being searched by advertisers.", "type": "object", "properties": { - "locations": { - "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.", - "type": "array", - "items": { - "$ref": "Location" - } - }, "convertedMinMonthlyBudget": { - "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code.", - "$ref": "Money" + "$ref": "Money", + "description": "The minimum monthly budget that the company accepts for partner business,\nconverted to the requested currency code." }, "industries": { - "enumDescriptions": [ - "Unchosen.", - "The automotive industry.", - "The business-to-business industry.", - "The consumer packaged goods industry.", - "The education industry.", - "The finance industry.", - "The healthcare industry.", - "The media and entertainment industry.", - "The retail industry.", - "The technology industry.", - "The travel industry." - ], "description": "Industries the company can help with.", "type": "array", "items": { @@ -1431,7 +2179,20 @@ "I_TECHNOLOGY", "I_TRAVEL" ] - } + }, + "enumDescriptions": [ + "Unchosen.", + "The automotive industry.", + "The business-to-business industry.", + "The consumer packaged goods industry.", + "The education industry.", + "The finance industry.", + "The healthcare industry.", + "The media and entertainment industry.", + "The retail industry.", + "The technology industry.", + "The travel industry." + ] }, "websiteUrl": { "description": "URL of the company's website.", @@ -1475,10 +2236,6 @@ "description": "Basic information from the company's public profile.", "$ref": "PublicProfile" }, - "originalMinMonthlyBudget": { - "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness.", - "$ref": "Money" - }, "primaryLocation": { "description": "The primary location of the company.", "$ref": "Location" @@ -1508,6 +2265,10 @@ ] } }, + "originalMinMonthlyBudget": { + "$ref": "Money", + "description": "The unconverted minimum monthly budget that the company accepts for partner\nbusiness." + }, "ranks": { "description": "Information related to the ranking of the company within the list of\ncompanies.", "type": "array", @@ -1537,19 +2298,6 @@ } }, "companyTypes": { - "enumDescriptions": [ - "Unchosen.", - "Handles all aspects of the advertising process.", - "Focuses solely on an advertiser's media placement.", - "Plans/executes advertising campaigns.", - "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.", - "Increases visibility in search engine result pages.", - "Drives promotional efforts for immediate impact.", - "Focuses on bid management, conversion, reporting.", - "Establishes favorable relationship with public through low/no-cost\ncommunications.", - "Does not manage other company's accounts, manages own marketing programs.", - "Full-service AdWords account management for local businesses." - ], "description": "Company type labels listed on the company's profile.", "type": "array", "items": { @@ -1567,7 +2315,20 @@ "SELF_MANAGED", "RESELLER" ] - } + }, + "enumDescriptions": [ + "Unchosen.", + "Handles all aspects of the advertising process.", + "Focuses solely on an advertiser's media placement.", + "Plans/executes advertising campaigns.", + "Like a\nFULL_SERVICE_AGENCY,\nbut specializing in digital.", + "Increases visibility in search engine result pages.", + "Drives promotional efforts for immediate impact.", + "Focuses on bid management, conversion, reporting.", + "Establishes favorable relationship with public through low/no-cost\ncommunications.", + "Does not manage other company's accounts, manages own marketing programs.", + "Full-service AdWords account management for local businesses." + ] }, "autoApprovalEmailDomains": { "description": "Email domains that allow users with a matching email address to get\nauto-approved for associating with this company.", @@ -1581,8 +2342,6 @@ "type": "string" }, "profileStatus": { - "description": "The public viewability status of the company's profile.", - "type": "string", "enumDescriptions": [ "Unchosen.", "Company profile does not show up publicly.", @@ -1594,38 +2353,20 @@ "HIDDEN", "PUBLISHED", "SEARCHABLE" - ] + ], + "description": "The public viewability status of the company's profile.", + "type": "string" + }, + "locations": { + "description": "The list of all company locations.\nIf set, must include the\nprimary_location\nin the list.", + "type": "array", + "items": { + "$ref": "Location" + } } }, "id": "Company" }, - "ListLeadsResponse": { - "description": "Response message for ListLeads.", - "type": "object", - "properties": { - "leads": { - "description": "The list of leads.", - "type": "array", - "items": { - "$ref": "Lead" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.\nPass this value in the `ListLeadsRequest.page_token` field in the\nsubsequent call to\nListLeads to retrieve the\nnext page of results.", - "type": "string" - }, - "responseMetadata": { - "description": "Current response metadata.", - "$ref": "ResponseMetadata" - }, - "totalSize": { - "description": "The total count of leads for the given company.", - "format": "int32", - "type": "integer" - } - }, - "id": "ListLeadsResponse" - }, "CreateLeadResponse": { "description": "Response message for CreateLead.", "type": "object", @@ -1635,6 +2376,8 @@ "$ref": "Lead" }, "recaptchaStatus": { + "description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.", + "type": "string", "enumDescriptions": [ "Unchosen.", "No reCaptcha validation needed.", @@ -1646,9 +2389,7 @@ "RS_NOT_NEEDED", "RS_PASSED", "RS_FAILED" - ], - "description": "The outcome of \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e\nvalidation.", - "type": "string" + ] }, "responseMetadata": { "$ref": "ResponseMetadata", @@ -1662,12 +2403,12 @@ "type": "object", "properties": { "company": { - "$ref": "Company", - "description": "The company." + "description": "The company.", + "$ref": "Company" }, "responseMetadata": { - "$ref": "ResponseMetadata", - "description": "Current response metadata." + "description": "Current response metadata.", + "$ref": "ResponseMetadata" } }, "id": "GetCompanyResponse" @@ -1685,8 +2426,8 @@ "type": "string" }, "latLng": { - "$ref": "LatLng", - "description": "The latitude and longitude of the location, in degrees." + "description": "The latitude and longitude of the location, in degrees.", + "$ref": "LatLng" }, "regionCode": { "description": "CLDR (Common Locale Data Repository) region code .", @@ -1732,6 +2473,8 @@ "type": "integer" }, "type": { + "description": "The type of certification exam.", + "type": "string", "enumDescriptions": [ "Unchosen.", "Adwords Fundamentals exam.", @@ -1757,9 +2500,7 @@ "CET_MOBILE", "CET_DIGITAL_SALES", "CET_MOBILE_SITES" - ], - "description": "The type of certification exam.", - "type": "string" + ] } }, "id": "CertificationExamStatus" @@ -1814,10 +2555,6 @@ "description": "A set of opt-ins for a user.", "type": "object", "properties": { - "marketComm": { - "description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.", - "type": "boolean" - }, "specialOffers": { "description": "An opt-in about receiving email regarding new features and products.", "type": "boolean" @@ -1833,6 +2570,10 @@ "phoneContact": { "description": "An opt-in to allow recieivng phone calls about their Partners account.", "type": "boolean" + }, + "marketComm": { + "description": "An opt-in about receiving email from Partners marketing teams. Includes\nmember-only events and special promotional offers for Google products.", + "type": "boolean" } }, "id": "OptIns" @@ -1866,8 +2607,8 @@ "type": "object", "properties": { "responseMetadata": { - "description": "Current response metadata.", - "$ref": "ResponseMetadata" + "$ref": "ResponseMetadata", + "description": "Current response metadata." } }, "id": "GetPartnersStatusResponse" @@ -1876,29 +2617,6 @@ "description": "The profile information of a Partners user.", "type": "object", "properties": { - "givenName": { - "description": "The user's given name.", - "type": "string" - }, - "address": { - "$ref": "Location", - "description": "The user's mailing address, contains multiple fields." - }, - "industries": { - "description": "A list of ids representing which industries the user selected.", - "type": "array", - "items": { - "type": "string" - } - }, - "emailOptIns": { - "$ref": "OptIns", - "description": "The list of opt-ins for the user, related to communication preferences." - }, - "familyName": { - "description": "The user's family name.", - "type": "string" - }, "languages": { "description": "The list of languages this user understands.", "type": "array", @@ -1906,6 +2624,14 @@ "type": "string" } }, + "familyName": { + "description": "The user's family name.", + "type": "string" + }, + "emailOptIns": { + "$ref": "OptIns", + "description": "The list of opt-ins for the user, related to communication preferences." + }, "markets": { "description": "A list of ids representing which markets the user was interested in.", "type": "array", @@ -1934,6 +2660,10 @@ "description": "The email address the user has selected on the Partners site as primary.", "type": "string" }, + "profilePublic": { + "description": "Whether the user's public profile is visible to anyone with the URL.", + "type": "boolean" + }, "channels": { "description": "A list of ids representing which channels the user selected they were in.", "type": "array", @@ -1941,16 +2671,27 @@ "type": "string" } }, - "profilePublic": { - "description": "Whether the user's public profile is visible to anyone with the URL.", - "type": "boolean" - }, "jobFunctions": { "description": "A list of ids represnting which job categories the user selected.", "type": "array", "items": { "type": "string" } + }, + "givenName": { + "description": "The user's given name.", + "type": "string" + }, + "address": { + "description": "The user's mailing address, contains multiple fields.", + "$ref": "Location" + }, + "industries": { + "description": "A list of ids representing which industries the user selected.", + "type": "array", + "items": { + "type": "string" + } } }, "id": "UserProfile" @@ -1959,37 +2700,6 @@ "description": "Historical information about a Google Partners Offer.", "type": "object", "properties": { - "offerCode": { - "description": "Offer code.", - "type": "string" - }, - "creationTime": { - "description": "Time offer was first created.", - "format": "google-datetime", - "type": "string" - }, - "status": { - "description": "Status of the offer.", - "type": "string", - "enumDescriptions": [ - "Unset.", - "Offer distributed.", - "Offer redeemed.", - "Offer awarded.", - "Offer expired." - ], - "enum": [ - "OFFER_STATUS_UNSPECIFIED", - "OFFER_STATUS_DISTRIBUTED", - "OFFER_STATUS_REDEEMED", - "OFFER_STATUS_AWARDED", - "OFFER_STATUS_EXPIRED" - ] - }, - "clientEmail": { - "description": "Email address for client.", - "type": "string" - }, "clientId": { "description": "ID of client.", "format": "int64", @@ -2036,6 +2746,37 @@ "description": "Time this offer expires.", "format": "google-datetime", "type": "string" + }, + "offerCode": { + "description": "Offer code.", + "type": "string" + }, + "creationTime": { + "description": "Time offer was first created.", + "format": "google-datetime", + "type": "string" + }, + "clientEmail": { + "description": "Email address for client.", + "type": "string" + }, + "status": { + "description": "Status of the offer.", + "type": "string", + "enumDescriptions": [ + "Unset.", + "Offer distributed.", + "Offer redeemed.", + "Offer awarded.", + "Offer expired." + ], + "enum": [ + "OFFER_STATUS_UNSPECIFIED", + "OFFER_STATUS_DISTRIBUTED", + "OFFER_STATUS_REDEEMED", + "OFFER_STATUS_AWARDED", + "OFFER_STATUS_EXPIRED" + ] } }, "id": "HistoricalOffer" @@ -2044,48 +2785,7 @@ "description": "Request message for\nLogUserEvent.", "type": "object", "properties": { - "eventDatas": { - "description": "List of event data for the event.", - "type": "array", - "items": { - "$ref": "EventData" - } - }, - "eventScope": { - "enumDescriptions": [ - "Unchosen.", - "Based on visitor.", - "Based on session.", - "Based on page visit." - ], - "enum": [ - "EVENT_SCOPE_UNSPECIFIED", - "VISITOR", - "SESSION", - "PAGE" - ], - "description": "The scope of the event.", - "type": "string" - }, "eventCategory": { - "enumDescriptions": [ - "Unchosen.", - "Google Partner Search category.", - "Google Partner sign-up flow category.", - "Google Partner portal category.", - "Google Partner portal my-profile category.", - "Google Partner portal certifications category.", - "Google Partner portal community category.", - "Google Partner portal insights category.", - "Google Partner portal clients category.", - "Google Partner portal public user profile category.", - "Google Partner panel category.", - "Google Partner portal last admin dialog category.", - "Google Partner client category.", - "Google Partner portal company profile category.", - "External links category.", - "Google Partner landing category." - ], "enum": [ "EVENT_CATEGORY_UNSPECIFIED", "GOOGLE_PARTNER_SEARCH", @@ -2105,15 +2805,31 @@ "GOOGLE_PARTNER_LANDING" ], "description": "The category the action belongs to.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unchosen.", + "Google Partner Search category.", + "Google Partner sign-up flow category.", + "Google Partner portal category.", + "Google Partner portal my-profile category.", + "Google Partner portal certifications category.", + "Google Partner portal community category.", + "Google Partner portal insights category.", + "Google Partner portal clients category.", + "Google Partner portal public user profile category.", + "Google Partner panel category.", + "Google Partner portal last admin dialog category.", + "Google Partner client category.", + "Google Partner portal company profile category.", + "External links category.", + "Google Partner landing category." + ] }, "lead": { - "$ref": "Lead", - "description": "Advertiser lead information." + "description": "Advertiser lead information.", + "$ref": "Lead" }, "eventAction": { - "description": "The action that occurred.", - "type": "string", "enumDescriptions": [ "Unchosen.", "Advertiser clicked `Find a partner` bottom button.", @@ -2435,15 +3151,40 @@ "SMB_ENTERED_WEBSITE_IN_CONTACT_PARTNER_FORM", "AGENCY_SELECTED_OPT_IN_AFA_MIGRATION", "AGENCY_SELECTED_OPT_OUT_AFA_MIGRATION" - ] + ], + "description": "The action that occurred.", + "type": "string" }, "url": { "description": "The URL where the event occurred.", "type": "string" }, "requestMetadata": { - "description": "Current request metadata.", - "$ref": "RequestMetadata" + "$ref": "RequestMetadata", + "description": "Current request metadata." + }, + "eventDatas": { + "description": "List of event data for the event.", + "type": "array", + "items": { + "$ref": "EventData" + } + }, + "eventScope": { + "enumDescriptions": [ + "Unchosen.", + "Based on visitor.", + "Based on session.", + "Based on page visit." + ], + "enum": [ + "EVENT_SCOPE_UNSPECIFIED", + "VISITOR", + "SESSION", + "PAGE" + ], + "description": "The scope of the event.", + "type": "string" } }, "id": "LogUserEventRequest" @@ -2452,13 +3193,13 @@ "description": "Values to use instead of the user's respective defaults. These are only\nhonored by whitelisted products.", "type": "object", "properties": { - "userId": { - "description": "Logged-in user ID to impersonate instead of the user's ID.", - "type": "string" - }, "ipAddress": { "description": "IP address to use instead of the user's geo-located IP address.", "type": "string" + }, + "userId": { + "description": "Logged-in user ID to impersonate instead of the user's ID.", + "type": "string" } }, "id": "UserOverrides" @@ -2495,8 +3236,8 @@ "$ref": "Date" }, "profileViews": { - "description": "Instances of users viewing the `Company` profile\non the specified date.", - "$ref": "AnalyticsDataPoint" + "$ref": "AnalyticsDataPoint", + "description": "Instances of users viewing the `Company` profile\non the specified date." }, "searchViews": { "$ref": "AnalyticsDataPoint", @@ -2509,30 +3250,20 @@ "description": "Information about a particular AdWords Manager Account.\nRead more at https://support.google.com/adwords/answer/6139186", "type": "object", "properties": { - "customerName": { - "description": "Name of the customer this account represents.", - "type": "string" - }, "id": { "description": "The AdWords Manager Account id.", "format": "int64", "type": "string" + }, + "customerName": { + "description": "Name of the customer this account represents.", + "type": "string" } }, "id": "AdWordsManagerAccountInfo" }, "PublicProfile": { - "description": "Basic information from a public profile.", - "type": "object", "properties": { - "displayName": { - "description": "The display name of the public profile.", - "type": "string" - }, - "displayImageUrl": { - "description": "The URL to the main display image of the public profile. Being deprecated.", - "type": "string" - }, "id": { "description": "The ID which can be used to retrieve more details about the public profile.", "type": "string" @@ -2544,32 +3275,42 @@ "profileImage": { "description": "The URL to the main profile image of the public profile.", "type": "string" + }, + "displayName": { + "description": "The display name of the public profile.", + "type": "string" + }, + "displayImageUrl": { + "description": "The URL to the main display image of the public profile. Being deprecated.", + "type": "string" } }, - "id": "PublicProfile" + "id": "PublicProfile", + "description": "Basic information from a public profile.", + "type": "object" }, "ResponseMetadata": { - "description": "Common data that is in each API response.", - "type": "object", "properties": { "debugInfo": { "$ref": "DebugInfo", "description": "Debug information about this request." } }, - "id": "ResponseMetadata" + "id": "ResponseMetadata", + "description": "Common data that is in each API response.", + "type": "object" }, "RecaptchaChallenge": { "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.", "type": "object", "properties": { - "id": { - "description": "The ID of the reCaptcha challenge.", - "type": "string" - }, "response": { "description": "The response to the reCaptcha challenge.", "type": "string" + }, + "id": { + "description": "The ID of the reCaptcha challenge.", + "type": "string" } }, "id": "RecaptchaChallenge" @@ -2578,6 +3319,42 @@ "description": "Available Offers to be distributed.", "type": "object", "properties": { + "name": { + "description": "Name of the offer.", + "type": "string" + }, + "id": { + "description": "ID of this offer.", + "format": "int64", + "type": "string" + }, + "qualifiedCustomersComplete": { + "description": "Whether or not the list of qualified customers is definitely complete.", + "type": "boolean" + }, + "countryOfferInfos": { + "description": "Offer info by country.", + "type": "array", + "items": { + "$ref": "CountryOfferInfo" + } + }, + "offerType": { + "enumDescriptions": [ + "Unset.", + "AdWords spend X get Y.", + "Youtube video.", + "Spend Match up to Y." + ], + "enum": [ + "OFFER_TYPE_UNSPECIFIED", + "OFFER_TYPE_SPEND_X_GET_Y", + "OFFER_TYPE_VIDEO", + "OFFER_TYPE_SPEND_MATCH" + ], + "description": "Type of offer.", + "type": "string" + }, "maxAccountAge": { "description": "The maximum age of an account [in days] to be eligible.", "format": "int32", @@ -2608,8 +3385,6 @@ "type": "string" }, "offerLevel": { - "description": "Level of this offer.", - "type": "string", "enumDescriptions": [ "Unset.", "Users/Agencies that have no offers because of a problem.", @@ -2629,68 +3404,37 @@ "OFFER_LEVEL_LIMIT_5", "OFFER_LEVEL_LIMIT_15", "OFFER_LEVEL_LIMIT_50" - ] - }, - "name": { - "description": "Name of the offer.", - "type": "string" - }, - "qualifiedCustomersComplete": { - "description": "Whether or not the list of qualified customers is definitely complete.", - "type": "boolean" - }, - "id": { - "description": "ID of this offer.", - "format": "int64", - "type": "string" - }, - "countryOfferInfos": { - "description": "Offer info by country.", - "type": "array", - "items": { - "$ref": "CountryOfferInfo" - } - }, - "offerType": { - "description": "Type of offer.", - "type": "string", - "enumDescriptions": [ - "Unset.", - "AdWords spend X get Y.", - "Youtube video.", - "Spend Match up to Y." ], - "enum": [ - "OFFER_TYPE_UNSPECIFIED", - "OFFER_TYPE_SPEND_X_GET_Y", - "OFFER_TYPE_VIDEO", - "OFFER_TYPE_SPEND_MATCH" - ] + "description": "Level of this offer.", + "type": "string" } }, "id": "AvailableOffer" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", - "type": "object", "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "format": "double", - "type": "number" - }, "longitude": { "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", "format": "double", "type": "number" + }, + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" } }, - "id": "LatLng" + "id": "LatLng", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", + "type": "object" }, "Money": { - "description": "Represents an amount of money with its currency type.", - "type": "object", "properties": { + "units": { + "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + }, "currencyCode": { "description": "The 3-letter currency code defined in ISO 4217.", "type": "string" @@ -2699,14 +3443,11 @@ "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", "format": "int32", "type": "integer" - }, - "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", - "format": "int64", - "type": "string" } }, - "id": "Money" + "id": "Money", + "description": "Represents an amount of money with its currency type.", + "type": "object" }, "AnalyticsSummary": { "description": "Analytics aggregated data for a `Company` for a given date range.", @@ -2734,7 +3475,29 @@ "description": "Request message for\nLogClientMessage.", "type": "object", "properties": { + "details": { + "description": "Details about the client message.", + "type": "string" + }, + "clientInfo": { + "additionalProperties": { + "type": "string" + }, + "description": "Map of client info, such as URL, browser navigator, browser platform, etc.", + "type": "object" + }, + "requestMetadata": { + "$ref": "RequestMetadata", + "description": "Current request metadata." + }, "level": { + "enum": [ + "MESSAGE_LEVEL_UNSPECIFIED", + "ML_FINE", + "ML_INFO", + "ML_WARNING", + "ML_SEVERE" + ], "description": "Message level of client message.", "type": "string", "enumDescriptions": [ @@ -2743,37 +3506,51 @@ "Message level for informational messages.", "Message level for potential problems.", "Message level for serious failures." - ], - "enum": [ - "MESSAGE_LEVEL_UNSPECIFIED", - "ML_FINE", - "ML_INFO", - "ML_WARNING", - "ML_SEVERE" ] - }, - "details": { - "description": "Details about the client message.", - "type": "string" - }, - "clientInfo": { - "description": "Map of client info, such as URL, browser navigator, browser platform, etc.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "requestMetadata": { - "$ref": "RequestMetadata", - "description": "Current request metadata." } }, "id": "LogMessageRequest" }, "Lead": { - "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).", - "type": "object", "properties": { + "id": { + "description": "ID of the lead.", + "type": "string" + }, + "comments": { + "description": "Comments lead source gave.", + "type": "string" + }, + "adwordsCustomerId": { + "description": "The AdWords Customer ID of the lead.", + "format": "int64", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number of lead source.", + "type": "string" + }, + "createTime": { + "description": "Timestamp of when this lead was created.", + "format": "google-datetime", + "type": "string" + }, + "marketingOptIn": { + "description": "Whether or not the lead signed up for marketing emails", + "type": "boolean" + }, + "type": { + "enum": [ + "LEAD_TYPE_UNSPECIFIED", + "LT_GPS" + ], + "description": "Type of lead.", + "type": "string", + "enumDescriptions": [ + "Unchosen.", + "Google Partner Search." + ] + }, "minMonthlyBudget": { "description": "The minimum monthly budget lead source is willing to spend.", "$ref": "Money" @@ -2782,31 +3559,13 @@ "description": "First name of lead source.", "type": "string" }, - "websiteUrl": { - "description": "Website URL of lead source.", - "type": "string" - }, "languageCode": { "description": "Language code of the lead's language preference, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").", "type": "string" }, - "state": { - "description": "The lead's state in relation to the company.", - "type": "string", - "enumDescriptions": [ - "Unchosen.", - "Lead not yet contacted.", - "Lead has been contacted.", - "Lead has become a client.", - "Lead in a state not covered by other options." - ], - "enum": [ - "LEAD_STATE_UNSPECIFIED", - "LEAD", - "CONTACTED", - "CLIENT", - "OTHER" - ] + "websiteUrl": { + "description": "Website URL of lead source.", + "type": "string" }, "gpsMotivations": { "description": "List of reasons for using Google Partner Search and creating a lead.", @@ -2827,6 +3586,24 @@ "Advertiser does not have a website." ] }, + "state": { + "enumDescriptions": [ + "Unchosen.", + "Lead not yet contacted.", + "Lead has been contacted.", + "Lead has become a client.", + "Lead in a state not covered by other options." + ], + "enum": [ + "LEAD_STATE_UNSPECIFIED", + "LEAD", + "CONTACTED", + "CLIENT", + "OTHER" + ], + "description": "The lead's state in relation to the company.", + "type": "string" + }, "email": { "description": "Email address of lead source.", "type": "string" @@ -2834,56 +3611,16 @@ "familyName": { "description": "Last name of lead source.", "type": "string" - }, - "comments": { - "description": "Comments lead source gave.", - "type": "string" - }, - "id": { - "description": "ID of the lead.", - "type": "string" - }, - "phoneNumber": { - "description": "Phone number of lead source.", - "type": "string" - }, - "adwordsCustomerId": { - "description": "The AdWords Customer ID of the lead.", - "format": "int64", - "type": "string" - }, - "createTime": { - "description": "Timestamp of when this lead was created.", - "format": "google-datetime", - "type": "string" - }, - "marketingOptIn": { - "description": "Whether or not the lead signed up for marketing emails", - "type": "boolean" - }, - "type": { - "enumDescriptions": [ - "Unchosen.", - "Google Partner Search." - ], - "enum": [ - "LEAD_TYPE_UNSPECIFIED", - "LT_GPS" - ], - "description": "Type of lead.", - "type": "string" } }, - "id": "Lead" + "id": "Lead", + "description": "A lead resource that represents an advertiser contact for a `Company`. These\nare usually generated via Google Partner Search (the advertiser portal).", + "type": "object" }, "DebugInfo": { "description": "Debug information about this request.", "type": "object", "properties": { - "serviceUrl": { - "description": "URL of the service that handled this request.", - "type": "string" - }, "serverInfo": { "description": "Info about the server that serviced this request.", "type": "string" @@ -2891,756 +3628,19 @@ "serverTraceInfo": { "description": "Server-side debug stack trace.", "type": "string" + }, + "serviceUrl": { + "description": "URL of the service that handled this request.", + "type": "string" } }, "id": "DebugInfo" - }, - "ListUserStatesResponse": { - "description": "Response message for\nListUserStates.", - "type": "object", - "properties": { - "userStates": { - "enumDescriptions": [ - "Unchosen.", - "User must pass \u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e to\ncontact a Partner via Google Partner Search." - ], - "description": "User's states.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "USER_STATE_UNSPECIFIED", - "US_REQUIRES_RECAPTCHA_FOR_GPS_CONTACT" - ] - } - }, - "responseMetadata": { - "$ref": "ResponseMetadata", - "description": "Current response metadata." - } - }, - "id": "ListUserStatesResponse" - }, - "CompanyRelation": { - "description": "A CompanyRelation resource representing information about a user's\naffiliation and standing with a company in Partners.", - "type": "object", - "properties": { - "logoUrl": { - "description": "A URL to a profile photo, e.g. a G+ profile photo.", - "type": "string" - }, - "resolvedTimestamp": { - "description": "The timestamp when the user was approved.\n@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "companyAdmin": { - "description": "Indicates if the user is an admin for this company.", - "type": "boolean" - }, - "address": { - "description": "The primary address for this company.", - "type": "string" - }, - "isPending": { - "description": "The flag that indicates if the company is pending verification.", - "type": "boolean" - }, - "creationTime": { - "description": "The timestamp of when affiliation was requested.\n@OutputOnly", - "format": "google-datetime", - "type": "string" - }, - "state": { - "enumDescriptions": [ - "Default unspecified value.", - "User has filled in a request to be associated with an company.\nNow waiting email confirmation.", - "Pending approval from company.\nEmail confirmation will not approve this one.", - "Approved by company." - ], - "enum": [ - "USER_COMPANY_REATION_STATE_NONE_SPECIFIED", - "USER_COMPANY_RELATION_STATE_AWAIT_EMAIL", - "USER_COMPANY_RELATION_STATE_AWAIT_ADMIN", - "USER_COMPANY_RELATION_STATE_APPROVED" - ], - "description": "The state of relationship, in terms of approvals.", - "type": "string" - }, - "primaryAddress": { - "$ref": "Location", - "description": "The primary location of the company." - }, - "name": { - "description": "The name (in the company's primary language) for the company.", - "type": "string" - }, - "managerAccount": { - "description": "The AdWords manager account # associated this company.", - "format": "int64", - "type": "string" - }, - "segment": { - "description": "The segment the company is classified as.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "COMPANY_SEGMENT_UNKNOWN", - "COMPANY_SEGMENT_NAL", - "COMPANY_SEGMENT_PSP", - "COMPANY_SEGMENT_PPSP" - ] - }, - "enumDescriptions": [ - "Default segment indicates an unknown.", - "Segment representing a selected group of Partners", - "Segment representing Premier SMB Partners, an AdWords partnership program.", - "A segment of Premier SMB Partners that have relationship with Google." - ] - }, - "internalCompanyId": { - "description": "The internal company ID.\nOnly available for a whitelisted set of api clients.", - "type": "string" - }, - "specializationStatus": { - "description": "The list of Google Partners specialization statuses for the company.", - "type": "array", - "items": { - "$ref": "SpecializationStatus" - } - }, - "badgeTier": { - "enumDescriptions": [ - "Tier badge is not set.", - "Agency has regular partner badge.", - "Agency has premier badge." - ], - "enum": [ - "BADGE_TIER_NONE", - "BADGE_TIER_REGULAR", - "BADGE_TIER_PREMIER" - ], - "description": "Whether the company is a Partner.", - "type": "string" - }, - "phoneNumber": { - "description": "The phone number for the company's primary address.", - "type": "string" - }, - "website": { - "description": "The website URL for this company.", - "type": "string" - }, - "primaryCountryCode": { - "description": "The primary country code of the company.", - "type": "string" - }, - "companyId": { - "description": "The ID of the company. There may be no id if this is a\npending company.5", - "type": "string" - }, - "primaryLanguageCode": { - "description": "The primary language code of the company.", - "type": "string" - } - }, - "id": "CompanyRelation" - }, - "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`.", - "type": "object", - "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" - } - }, - "id": "Date" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "TrafficSource": { - "description": "Source of traffic for the current request.", - "type": "object", - "properties": { - "trafficSourceId": { - "description": "Identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - }, - "trafficSubId": { - "description": "Second level identifier to indicate where the traffic comes from.\nAn identifier has multiple letters created by a team which redirected the\ntraffic to us.", - "type": "string" - } - }, - "id": "TrafficSource" - }, - "RequestMetadata": { - "description": "Common data that is in each API request.", - "type": "object", - "properties": { - "userOverrides": { - "$ref": "UserOverrides", - "description": "Values to use instead of the user's respective defaults for the current\nrequest. These are only honored by whitelisted products." - }, - "partnersSessionId": { - "description": "Google Partners session ID.", - "type": "string" - }, - "experimentIds": { - "description": "Experiment IDs the current request belongs to.", - "type": "array", - "items": { - "type": "string" - } - }, - "trafficSource": { - "description": "Source of traffic for the current request.", - "$ref": "TrafficSource" - }, - "locale": { - "description": "Locale to use for the current request.", - "type": "string" - } - }, - "id": "RequestMetadata" - }, - "CreateLeadRequest": { - "description": "Request message for CreateLead.", - "type": "object", - "properties": { - "requestMetadata": { - "$ref": "RequestMetadata", - "description": "Current request metadata." - }, - "lead": { - "$ref": "Lead", - "description": "The lead resource. The `LeadType` must not be `LEAD_TYPE_UNSPECIFIED`\nand either `email` or `phone_number` must be provided." - }, - "recaptchaChallenge": { - "description": "\u003ca href=\"https://www.google.com/recaptcha/\"\u003ereCaptcha\u003c/a\u003e challenge info.", - "$ref": "RecaptchaChallenge" - } - }, - "id": "CreateLeadRequest" - }, - "EventData": { - "description": "Key value data pair for an event.", - "type": "object", - "properties": { - "values": { - "description": "Data values.", - "type": "array", - "items": { - "type": "string" - } - }, - "key": { - "description": "Data type.", - "type": "string", - "enumDescriptions": [ - "Unchosen.", - "Action data.", - "Agency ID data.", - "Agency name data.", - "Agency phone number data.", - "Agency website data.", - "Budget data.", - "Center-point data.", - "Certification data.", - "Comment data.", - "Country data.", - "Currency data.", - "Currently viewed agency ID data.", - "Distance data.", - "Distance type data.", - "Exam data.", - "History token data.", - "Identifier data.", - "Industry data.", - "Insight tag data.", - "Language data.", - "Location data.", - "Marketing opt-in data.", - "Query data.", - "Search start index data.", - "Service data.", - "Show vow data.", - "Solution data.", - "Traffic source ID data.", - "Traffic sub ID data.", - "Viewport data.", - "Website data.", - "Details data.", - "Experiment ID data.", - "Google Partner Search motivation data.", - "URL data.", - "Element we wanted user to focus on.", - "Progress when viewing an item \\[0-100\\]." - ], - "enum": [ - "EVENT_DATA_TYPE_UNSPECIFIED", - "ACTION", - "AGENCY_ID", - "AGENCY_NAME", - "AGENCY_PHONE_NUMBER", - "AGENCY_WEBSITE", - "BUDGET", - "CENTER_POINT", - "CERTIFICATION", - "COMMENT", - "COUNTRY", - "CURRENCY", - "CURRENTLY_VIEWED_AGENCY_ID", - "DISTANCE", - "DISTANCE_TYPE", - "EXAM", - "HISTORY_TOKEN", - "ID", - "INDUSTRY", - "INSIGHT_TAG", - "LANGUAGE", - "LOCATION", - "MARKETING_OPT_IN", - "QUERY", - "SEARCH_START_INDEX", - "SERVICE", - "SHOW_VOW", - "SOLUTION", - "TRAFFIC_SOURCE_ID", - "TRAFFIC_SUB_ID", - "VIEW_PORT", - "WEBSITE", - "DETAILS", - "EXPERIMENT_ID", - "GPS_MOTIVATION", - "URL", - "ELEMENT_FOCUS", - "PROGRESS" - ] - } - }, - "id": "EventData" - }, - "ExamStatus": { - "description": "A user's information on a specific exam.", - "type": "object", - "properties": { - "warning": { - "description": "Whether this exam is in the state of warning.", - "type": "boolean" - }, - "expiration": { - "description": "Date this exam is due to expire.", - "format": "google-datetime", - "type": "string" - }, - "lastPassed": { - "description": "The date the user last passed this exam.", - "format": "google-datetime", - "type": "string" - }, - "examType": { - "enumDescriptions": [ - "Unchosen.", - "Adwords Fundamentals exam.", - "AdWords advanced search exam.", - "AdWords advanced display exam.", - "VideoAds exam.", - "DoubleClick exam.", - "Analytics exam.", - "Shopping exam.", - "Mobile exam.", - "Digital Sales exam.", - "Mobile Sites exam." - ], - "enum": [ - "CERTIFICATION_EXAM_TYPE_UNSPECIFIED", - "CET_ADWORDS_FUNDAMENTALS", - "CET_ADWORDS_ADVANCED_SEARCH", - "CET_ADWORDS_ADVANCED_DISPLAY", - "CET_VIDEO_ADS", - "CET_DOUBLECLICK", - "CET_ANALYTICS", - "CET_SHOPPING", - "CET_MOBILE", - "CET_DIGITAL_SALES", - "CET_MOBILE_SITES" - ], - "description": "The type of the exam.", - "type": "string" - }, - "passed": { - "description": "Whether this exam has been passed and not expired.", - "type": "boolean" - }, - "taken": { - "description": "The date the user last taken this exam.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "ExamStatus" - }, - "ListOffersResponse": { - "description": "Response for ListOffer.", - "type": "object", - "properties": { - "responseMetadata": { - "description": "Current response metadata.", - "$ref": "ResponseMetadata" - }, - "noOfferReason": { - "enumDescriptions": [ - "Unset.", - "Not an MCC.", - "Offer limit has been reached.", - "Ineligible for offers." - ], - "enum": [ - "NO_OFFER_REASON_UNSPECIFIED", - "NO_OFFER_REASON_NO_MCC", - "NO_OFFER_REASON_LIMIT_REACHED", - "NO_OFFER_REASON_INELIGIBLE" - ], - "description": "Reason why no Offers are available.", - "type": "string" - }, - "availableOffers": { - "description": "Available Offers to be distributed.", - "type": "array", - "items": { - "$ref": "AvailableOffer" - } - } - }, - "id": "ListOffersResponse" - }, - "CountryOfferInfo": { - "description": "Offer info by country.", - "type": "object", - "properties": { - "offerCountryCode": { - "description": "Country code for which offer codes may be requested.", - "type": "string" - }, - "spendXAmount": { - "description": "(localized) Spend X amount for that country's offer.", - "type": "string" - }, - "offerType": { - "description": "Type of offer country is eligible for.", - "type": "string", - "enumDescriptions": [ - "Unset.", - "AdWords spend X get Y.", - "Youtube video.", - "Spend Match up to Y." - ], - "enum": [ - "OFFER_TYPE_UNSPECIFIED", - "OFFER_TYPE_SPEND_X_GET_Y", - "OFFER_TYPE_VIDEO", - "OFFER_TYPE_SPEND_MATCH" - ] - }, - "getYAmount": { - "description": "(localized) Get Y amount for that country's offer.", - "type": "string" - } - }, - "id": "CountryOfferInfo" - }, - "ListCompaniesResponse": { - "description": "Response message for\nListCompanies.", - "type": "object", - "properties": { - "companies": { - "description": "The list of companies.", - "type": "array", - "items": { - "$ref": "Company" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.\nPass this value in the `ListCompaniesRequest.page_token` field in the\nsubsequent call to\nListCompanies to retrieve the\nnext page of results.", - "type": "string" - }, - "responseMetadata": { - "description": "Current response metadata.", - "$ref": "ResponseMetadata" - } - }, - "id": "ListCompaniesResponse" - }, - "OfferCustomer": { - "description": "Customers qualified for an offer.", - "type": "object", - "properties": { - "getYAmount": { - "description": "Formatted Get Y amount with currency code.", - "type": "string" - }, - "name": { - "description": "Name of the customer.", - "type": "string" - }, - "spendXAmount": { - "description": "Formatted Spend X amount with currency code.", - "type": "string" - }, - "adwordsUrl": { - "description": "URL to the customer's AdWords page.", - "type": "string" - }, - "eligibilityDaysLeft": { - "description": "Days the customer is still eligible.", - "format": "int32", - "type": "integer" - }, - "creationTime": { - "description": "Time the customer was created.", - "format": "google-datetime", - "type": "string" - }, - "countryCode": { - "description": "Country code of the customer.", - "type": "string" - }, - "offerType": { - "description": "Type of the offer", - "type": "string", - "enumDescriptions": [ - "Unset.", - "AdWords spend X get Y.", - "Youtube video.", - "Spend Match up to Y." - ], - "enum": [ - "OFFER_TYPE_UNSPECIFIED", - "OFFER_TYPE_SPEND_X_GET_Y", - "OFFER_TYPE_VIDEO", - "OFFER_TYPE_SPEND_MATCH" - ] - }, - "externalCid": { - "description": "External CID for the customer.", - "format": "int64", - "type": "string" - } - }, - "id": "OfferCustomer" - }, - "CertificationStatus": { - "description": "Google Partners certification status.", - "type": "object", - "properties": { - "isCertified": { - "description": "Whether certification is passing.", - "type": "boolean" - }, - "examStatuses": { - "description": "List of certification exam statuses.", - "type": "array", - "items": { - "$ref": "CertificationExamStatus" - } - }, - "type": { - "description": "The type of the certification.", - "type": "string", - "enumDescriptions": [ - "Unchosen.", - "AdWords certified.", - "YouTube certified.", - "VideoAds certified.", - "Analytics certified.", - "DoubleClick certified.", - "Shopping certified.", - "Mobile certified.", - "Digital sales certified.", - "AdWords Search certified.", - "AdWords Display certified.", - "Mobile Sites certified." - ], - "enum": [ - "CERTIFICATION_TYPE_UNSPECIFIED", - "CT_ADWORDS", - "CT_YOUTUBE", - "CT_VIDEOADS", - "CT_ANALYTICS", - "CT_DOUBLECLICK", - "CT_SHOPPING", - "CT_MOBILE", - "CT_DIGITAL_SALES", - "CT_ADWORDS_SEARCH", - "CT_ADWORDS_DISPLAY", - "CT_MOBILE_SITES" - ] - }, - "userCount": { - "description": "Number of people who are certified,", - "format": "int32", - "type": "integer" - } - }, - "id": "CertificationStatus" - }, - "LocalizedCompanyInfo": { - "description": "The localized company information.", - "type": "object", - "properties": { - "displayName": { - "description": "Localized display name.", - "type": "string" - }, - "languageCode": { - "description": "Language code of the localized company info, as defined by\n\u003ca href=\"https://tools.ietf.org/html/bcp47\"\u003eBCP 47\u003c/a\u003e\n(IETF BCP 47, \"Tags for Identifying Languages\").", - "type": "string" - }, - "countryCodes": { - "description": "List of country codes for the localized company info.", - "type": "array", - "items": { - "type": "string" - } - }, - "overview": { - "description": "Localized brief description that the company uses to advertise themselves.", - "type": "string" - } - }, - "id": "LocalizedCompanyInfo" - }, - "LogUserEventResponse": { - "description": "Response message for\nLogUserEvent.", - "type": "object", - "properties": { - "responseMetadata": { - "description": "Current response metadata.", - "$ref": "ResponseMetadata" - } - }, - "id": "LogUserEventResponse" - }, - "ListOffersHistoryResponse": { - "description": "Response for ListOfferHistory.", - "type": "object", - "properties": { - "totalResults": { - "description": "Number of results across all pages.", - "format": "int32", - "type": "integer" - }, - "showingEntireCompany": { - "description": "True if this response is showing entire company history.", - "type": "boolean" - }, - "offers": { - "description": "Historical offers meeting request.", - "type": "array", - "items": { - "$ref": "HistoricalOffer" - } - }, - "nextPageToken": { - "description": "Supply this token in a ListOffersHistoryRequest to retrieve the next page.", - "type": "string" - }, - "responseMetadata": { - "description": "Current response metadata.", - "$ref": "ResponseMetadata" - }, - "canShowEntireCompany": { - "description": "True if the user has the option to show entire company history.", - "type": "boolean" - } - }, - "id": "ListOffersHistoryResponse" - }, - "LogMessageResponse": { - "description": "Response message for\nLogClientMessage.", - "type": "object", - "properties": { - "responseMetadata": { - "$ref": "ResponseMetadata", - "description": "Current response metadata." - } - }, - "id": "LogMessageResponse" - }, - "SpecializationStatus": { - "description": "Agency specialization status", - "type": "object", - "properties": { - "badgeSpecialization": { - "enumDescriptions": [ - "Unknown specialization", - "AdWords Search specialization", - "AdWords Display specialization", - "AdWords Mobile specialization", - "AdWords Video specialization", - "AdWords Shopping specialization" - ], - "enum": [ - "BADGE_SPECIALIZATION_UNKNOWN", - "BADGE_SPECIALIZATION_ADWORDS_SEARCH", - "BADGE_SPECIALIZATION_ADWORDS_DISPLAY", - "BADGE_SPECIALIZATION_ADWORDS_MOBILE", - "BADGE_SPECIALIZATION_ADWORDS_VIDEO", - "BADGE_SPECIALIZATION_ADWORDS_SHOPPING" - ], - "description": "The specialization this status is for.", - "type": "string" - }, - "badgeSpecializationState": { - "description": "State of agency specialization.", - "type": "string", - "enumDescriptions": [ - "Unknown state", - "Specialization passed", - "Specialization not passed", - "Specialization in grace" - ], - "enum": [ - "BADGE_SPECIALIZATION_STATE_UNKNOWN", - "BADGE_SPECIALIZATION_STATE_PASSED", - "BADGE_SPECIALIZATION_STATE_NOT_PASSED", - "BADGE_SPECIALIZATION_STATE_IN_GRACE" - ] - } - }, - "id": "SpecializationStatus" } }, + "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest", - "version": "v2", - "baseUrl": "https://partners.googleapis.com/", - "canonicalName": "Partners", - "kind": "discovery#restDescription", - "description": "Searches certified companies and creates contact leads with them, and also audits the usage of clients.", - "servicePath": "", - "rootUrl": "https://partners.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "partners" + "version": "v2" }
diff --git a/people/v1/people-api.json b/people/v1/people-api.json index 53a91ab..c63e1af 100644 --- a/people/v1/people-api.json +++ b/people/v1/people-api.json
@@ -1,6 +1,84 @@ { + "batchPath": "batch", + "title": "Google People API", + "ownerName": "Google", "resources": { "people": { + "resources": { + "connections": { + "methods": { + "list": { + "response": { + "$ref": "ListConnectionsResponse" + }, + "parameterOrder": [ + "resourceName" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "requestMask.includeField": { + "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "syncToken": { + "location": "query", + "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.", + "type": "string" + }, + "personFields": { + "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "sortOrder": { + "location": "query", + "enum": [ + "LAST_MODIFIED_ASCENDING", + "FIRST_NAME_ASCENDING", + "LAST_NAME_ASCENDING" + ], + "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", + "type": "string" + }, + "requestSyncToken": { + "location": "query", + "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.", + "type": "boolean" + }, + "pageToken": { + "location": "query", + "description": "The token of the page to be returned.", + "type": "string" + }, + "resourceName": { + "description": "The resource name to return connections for. Only `people/me` is valid.", + "required": true, + "type": "string", + "pattern": "^people/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.readonly" + ], + "flatPath": "v1/people/{peopleId}/connections", + "path": "v1/{+resourceName}/connections", + "id": "people.people.connections.list", + "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified." + } + } + } + }, "methods": { "getBatchGet": { "description": "Provides information about a list of specific people by specifying a list\nof requested resource names. Use `people/me` to indicate the authenticated\nuser.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.", @@ -10,22 +88,22 @@ "parameterOrder": [], "httpMethod": "GET", "parameters": { - "requestMask.includeField": { - "location": "query", - "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", + "personFields": { + "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", "format": "google-fieldmask", - "type": "string" - }, - "resourceNames": { - "description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.", "type": "string", - "repeated": true, "location": "query" }, - "personFields": { - "location": "query", - "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", + "requestMask.includeField": { + "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "resourceNames": { + "repeated": true, + "location": "query", + "description": "The resource names of the people to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).\n\nYou can include up to 50 resource names in one request.", "type": "string" } }, @@ -45,6 +123,8 @@ "id": "people.people.getBatchGet" }, "get": { + "path": "v1/{+resourceName}", + "id": "people.people.get", "description": "Provides information about a person by specifying a resource name. Use\n`people/me` to indicate the authenticated user.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.", "response": { "$ref": "Person" @@ -53,27 +133,6 @@ "resourceName" ], "httpMethod": "GET", - "parameters": { - "requestMask.includeField": { - "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", - "format": "google-fieldmask", - "type": "string", - "location": "query" - }, - "resourceName": { - "location": "path", - "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).", - "required": true, - "type": "string", - "pattern": "^people/[^/]+$" - }, - "personFields": { - "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", - "format": "google-fieldmask", - "type": "string", - "location": "query" - } - }, "scopes": [ "https://www.googleapis.com/auth/contacts", "https://www.googleapis.com/auth/contacts.readonly", @@ -85,12 +144,30 @@ "https://www.googleapis.com/auth/userinfo.email", "https://www.googleapis.com/auth/userinfo.profile" ], - "flatPath": "v1/people/{peopleId}", - "path": "v1/{+resourceName}", - "id": "people.people.get" + "parameters": { + "resourceName": { + "location": "path", + "description": "The resource name of the person to provide information about.\n\n- To get information about the authenticated user, specify `people/me`.\n- To get information about a google account, specify\n `people/`\u003cvar\u003eaccount_id\u003c/var\u003e.\n- To get information about a contact, specify the resource name that\n identifies the contact as returned by\n[`people.connections.list`](/people/api/rest/v1/people.connections/list).", + "required": true, + "type": "string", + "pattern": "^people/[^/]+$" + }, + "personFields": { + "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", + "format": "google-fieldmask", + "type": "string", + "location": "query" + }, + "requestMask.includeField": { + "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/people/{peopleId}" }, "updateContact": { - "flatPath": "v1/people/{peopleId}:updateContact", "path": "v1/{+resourceName}:updateContact", "id": "people.people.updateContact", "request": { @@ -106,24 +183,29 @@ "httpMethod": "PATCH", "parameters": { "updatePersonFields": { - "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls", + "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls", "format": "google-fieldmask", "type": "string", "location": "query" }, "resourceName": { - "location": "path", "description": "The resource name for the person, assigned by the server. An ASCII string\nwith a max length of 27 characters, in the form of\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.", "required": true, "type": "string", - "pattern": "^people/[^/]+$" + "pattern": "^people/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/contacts" - ] + ], + "flatPath": "v1/people/{peopleId}:updateContact" }, "createContact": { + "description": "Create a new contact and return the person resource for that contact.", + "request": { + "$ref": "Person" + }, "response": { "$ref": "Person" }, @@ -134,234 +216,48 @@ ], "parameters": { "parent": { + "location": "query", "description": "The resource name of the owning person resource.", - "type": "string", - "location": "query" + "type": "string" } }, "flatPath": "v1/people:createContact", "path": "v1/people:createContact", - "id": "people.people.createContact", - "description": "Create a new contact and return the person resource for that contact.", - "request": { - "$ref": "Person" - } + "id": "people.people.createContact" }, "deleteContact": { + "path": "v1/{+resourceName}:deleteContact", + "id": "people.people.deleteContact", "description": "Delete a contact person. Any non-contact data will not be deleted.", - "httpMethod": "DELETE", - "parameterOrder": [ - "resourceName" - ], "response": { "$ref": "Empty" }, - "parameters": { - "resourceName": { - "location": "path", - "description": "The resource name of the contact to delete.", - "required": true, - "type": "string", - "pattern": "^people/[^/]+$" - } - }, + "parameterOrder": [ + "resourceName" + ], + "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/contacts" ], - "flatPath": "v1/people/{peopleId}:deleteContact", - "id": "people.people.deleteContact", - "path": "v1/{+resourceName}:deleteContact" - } - }, - "resources": { - "connections": { - "methods": { - "list": { - "description": "Provides a list of the authenticated user's contacts merged with any\nconnected profiles.\n\u003cbr\u003e\nThe request throws a 400 error if 'personFields' is not specified.", - "response": { - "$ref": "ListConnectionsResponse" - }, - "parameterOrder": [ - "resourceName" - ], - "httpMethod": "GET", - "parameters": { - "requestSyncToken": { - "location": "query", - "description": "Whether the response should include a sync token, which can be used to get\nall changes since the last request.", - "type": "boolean" - }, - "resourceName": { - "location": "path", - "description": "The resource name to return connections for. Only `people/me` is valid.", - "required": true, - "type": "string", - "pattern": "^people/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "The token of the page to be returned.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The number of connections to include in the response. Valid values are\nbetween 1 and 2000, inclusive. Defaults to 100.", - "format": "int32", - "type": "integer" - }, - "requestMask.includeField": { - "location": "query", - "description": "**Required.** Comma-separated list of person fields to be included in the\nresponse. Each path should start with `person.`: for example,\n`person.names` or `person.photos`.", - "format": "google-fieldmask", - "type": "string" - }, - "syncToken": { - "location": "query", - "description": "A sync token, returned by a previous call to `people.connections.list`.\nOnly resources changed since the sync token was created will be returned.", - "type": "string" - }, - "personFields": { - "location": "query", - "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", - "format": "google-fieldmask", - "type": "string" - }, - "sortOrder": { - "location": "query", - "enum": [ - "LAST_MODIFIED_ASCENDING", - "FIRST_NAME_ASCENDING", - "LAST_NAME_ASCENDING" - ], - "description": "The order in which the connections should be sorted. Defaults to\n`LAST_MODIFIED_ASCENDING`.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/contacts", - "https://www.googleapis.com/auth/contacts.readonly" - ], - "flatPath": "v1/people/{peopleId}/connections", - "path": "v1/{+resourceName}/connections", - "id": "people.people.connections.list" + "parameters": { + "resourceName": { + "description": "The resource name of the contact to delete.", + "required": true, + "type": "string", + "pattern": "^people/[^/]+$", + "location": "path" } - } + }, + "flatPath": "v1/people/{peopleId}:deleteContact" } } }, "contactGroups": { "methods": { - "batchGet": { - "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "BatchGetContactGroupsResponse" - }, - "parameters": { - "resourceNames": { - "description": "The resource names of the contact groups to get.", - "type": "string", - "repeated": true, - "location": "query" - }, - "maxMembers": { - "description": "Specifies the maximum number of members to return for each group.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/contacts", - "https://www.googleapis.com/auth/contacts.readonly" - ], - "flatPath": "v1/contactGroups:batchGet", - "id": "people.contactGroups.batchGet", - "path": "v1/contactGroups:batchGet" - }, - "delete": { + "get": { "flatPath": "v1/contactGroups/{contactGroupsId}", "path": "v1/{+resourceName}", - "id": "people.contactGroups.delete", - "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "resourceName" - ], - "httpMethod": "DELETE", - "parameters": { - "deleteContacts": { - "location": "query", - "description": "Set to true to also delete the contacts in the specified group.", - "type": "boolean" - }, - "resourceName": { - "description": "The resource name of the contact group to delete.", - "required": true, - "type": "string", - "pattern": "^contactGroups/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/contacts" - ] - }, - "list": { - "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListContactGroupsResponse" - }, - "parameters": { - "pageSize": { - "location": "query", - "description": "The maximum number of resources to return.", - "format": "int32", - "type": "integer" - }, - "syncToken": { - "location": "query", - "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.", - "type": "string" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/contacts", - "https://www.googleapis.com/auth/contacts.readonly" - ], - "flatPath": "v1/contactGroups", - "id": "people.contactGroups.list", - "path": "v1/contactGroups" - }, - "create": { - "response": { - "$ref": "ContactGroup" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/contacts" - ], - "parameters": {}, - "flatPath": "v1/contactGroups", - "path": "v1/contactGroups", - "id": "people.contactGroups.create", - "description": "Create a new contact group owned by the authenticated user.", - "request": { - "$ref": "CreateContactGroupRequest" - } - }, - "get": { + "id": "people.contactGroups.get", "description": "Get a specific contact group owned by the authenticated user by specifying\na contact group resource name.", "response": { "$ref": "ContactGroup" @@ -382,18 +278,22 @@ "location": "query" }, "resourceName": { - "location": "path", "description": "The resource name of the contact group to get.", "required": true, "type": "string", - "pattern": "^contactGroups/[^/]+$" + "pattern": "^contactGroups/[^/]+$", + "location": "path" } - }, - "flatPath": "v1/contactGroups/{contactGroupsId}", - "path": "v1/{+resourceName}", - "id": "people.contactGroups.get" + } }, "update": { + "flatPath": "v1/contactGroups/{contactGroupsId}", + "path": "v1/{+resourceName}", + "id": "people.contactGroups.update", + "description": "Update the name of an existing contact group owned by the authenticated\nuser.", + "request": { + "$ref": "UpdateContactGroupRequest" + }, "response": { "$ref": "ContactGroup" }, @@ -401,38 +301,140 @@ "resourceName" ], "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/contacts" + ], "parameters": { "resourceName": { - "location": "path", "description": "The resource name for the contact group, assigned by the server. An ASCII\nstring, in the form of `contactGroups/`\u003cvar\u003econtact_group_id\u003c/var\u003e.", "required": true, "type": "string", + "pattern": "^contactGroups/[^/]+$", + "location": "path" + } + } + }, + "batchGet": { + "description": "Get a list of contact groups owned by the authenticated user by specifying\na list of contact group resource names.", + "response": { + "$ref": "BatchGetContactGroupsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.readonly" + ], + "parameters": { + "maxMembers": { + "location": "query", + "description": "Specifies the maximum number of members to return for each group.", + "format": "int32", + "type": "integer" + }, + "resourceNames": { + "description": "The resource names of the contact groups to get.", + "type": "string", + "repeated": true, + "location": "query" + } + }, + "flatPath": "v1/contactGroups:batchGet", + "path": "v1/contactGroups:batchGet", + "id": "people.contactGroups.batchGet" + }, + "delete": { + "path": "v1/{+resourceName}", + "id": "people.contactGroups.delete", + "description": "Delete an existing contact group owned by the authenticated user by\nspecifying a contact group resource name.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "resourceName" + ], + "httpMethod": "DELETE", + "parameters": { + "resourceName": { + "location": "path", + "description": "The resource name of the contact group to delete.", + "required": true, + "type": "string", "pattern": "^contactGroups/[^/]+$" + }, + "deleteContacts": { + "description": "Set to true to also delete the contacts in the specified group.", + "type": "boolean", + "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/contacts" ], - "flatPath": "v1/contactGroups/{contactGroupsId}", - "path": "v1/{+resourceName}", - "id": "people.contactGroups.update", - "request": { - "$ref": "UpdateContactGroupRequest" + "flatPath": "v1/contactGroups/{contactGroupsId}" + }, + "list": { + "description": "List all contact groups owned by the authenticated user. Members of the\ncontact groups are not populated.", + "response": { + "$ref": "ListContactGroupsResponse" }, - "description": "Update the name of an existing contact group owned by the authenticated\nuser." + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/contacts", + "https://www.googleapis.com/auth/contacts.readonly" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "The maximum number of resources to return.", + "format": "int32", + "type": "integer" + }, + "syncToken": { + "location": "query", + "description": "A sync token, returned by a previous call to `contactgroups.list`.\nOnly resources changed since the sync token was created will be returned.", + "type": "string" + }, + "pageToken": { + "description": "The next_page_token value returned from a previous call to\n[ListContactGroups](/people/api/rest/v1/contactgroups/list).\nRequests the next page of resources.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/contactGroups", + "path": "v1/contactGroups", + "id": "people.contactGroups.list" + }, + "create": { + "path": "v1/contactGroups", + "id": "people.contactGroups.create", + "description": "Create a new contact group owned by the authenticated user.", + "request": { + "$ref": "CreateContactGroupRequest" + }, + "response": { + "$ref": "ContactGroup" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/contacts" + ], + "parameters": {}, + "flatPath": "v1/contactGroups" } }, "resources": { "members": { "methods": { "modify": { - "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify", "path": "v1/{+resourceName}/members:modify", "id": "people.contactGroups.members.modify", - "description": "Modify the members of a contact group owned by the authenticated user.", "request": { "$ref": "ModifyContactGroupMembersRequest" }, + "description": "Modify the members of a contact group owned by the authenticated user.", "response": { "$ref": "ModifyContactGroupMembersResponse" }, @@ -440,18 +442,19 @@ "resourceName" ], "httpMethod": "POST", + "parameters": { + "resourceName": { + "pattern": "^contactGroups/[^/]+$", + "location": "path", + "description": "The resource name of the contact group to modify.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/contacts" ], - "parameters": { - "resourceName": { - "description": "The resource name of the contact group to modify.", - "required": true, - "type": "string", - "pattern": "^contactGroups/[^/]+$", - "location": "path" - } - } + "flatPath": "v1/contactGroups/{contactGroupsId}/members:modify" } } } @@ -459,25 +462,30 @@ } }, "parameters": { - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, "key": { "location": "query", "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.", "type": "string" }, - "quotaUser": { + "access_token": { "location": "query", - "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.", + "description": "OAuth access token.", "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.", + "type": "string", + "location": "query" + }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", + "default": "true" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", "location": "query" }, "oauth_token": { @@ -485,32 +493,32 @@ "type": "string", "location": "query" }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "$.xgafv": { "enumDescriptions": [ "v1 error format", @@ -524,11 +532,6 @@ "description": "V1 error format.", "type": "string" }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, "alt": { "type": "string", "enumDescriptions": [ @@ -548,20 +551,73 @@ }, "version": "v1", "baseUrl": "https://people.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Provides access to information about profiles and contacts.", "servicePath": "", + "description": "Provides access to information about profiles and contacts.", + "kind": "discovery#restDescription", "basePath": "", - "id": "people:v1", "documentationLink": "https://developers.google.com/people/", - "revision": "20180104", + "revision": "20180106", + "id": "people:v1", "discoveryVersion": "v1", "version_module": true, "schemas": { + "Tagline": { + "description": "A read-only brief one-line description of the person.", + "type": "object", + "properties": { + "metadata": { + "description": "Metadata about the tagline.", + "$ref": "FieldMetadata" + }, + "value": { + "description": "The tagline.", + "type": "string" + } + }, + "id": "Tagline" + }, + "Date": { + "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.", + "type": "object", + "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" + } + }, + "id": "Date" + }, "Name": { "description": "A person's name. If the name is a mononym, the family name is empty.", "type": "object", "properties": { + "phoneticFullName": { + "description": "The full name spelled as it sounds.", + "type": "string" + }, + "displayNameLastFirst": { + "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.", + "type": "string" + }, + "displayName": { + "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.", + "type": "string" + }, + "honorificSuffix": { + "description": "The honorific suffixes, such as `Jr.`", + "type": "string" + }, "honorificPrefix": { "description": "The honorific prefixes, such as `Mrs.` or `Dr.`", "type": "string" @@ -570,14 +626,14 @@ "description": "The honorific suffixes spelled as they sound.", "type": "string" }, - "givenName": { - "description": "The given name.", - "type": "string" - }, "middleName": { "description": "The middle name(s).", "type": "string" }, + "givenName": { + "description": "The given name.", + "type": "string" + }, "phoneticHonorificPrefix": { "description": "The honorific prefixes spelled as they sound.", "type": "string" @@ -595,28 +651,12 @@ "type": "string" }, "metadata": { - "description": "Metadata about the name.", - "$ref": "FieldMetadata" + "$ref": "FieldMetadata", + "description": "Metadata about the name." }, "phoneticMiddleName": { "description": "The middle name(s) spelled as they sound.", "type": "string" - }, - "phoneticFullName": { - "description": "The full name spelled as it sounds.", - "type": "string" - }, - "displayNameLastFirst": { - "description": "The read-only display name with the last name first formatted according to\nthe locale specified by the viewer's account or the\n`Accept-Language` HTTP header.", - "type": "string" - }, - "displayName": { - "description": "The read-only display name formatted according to the locale specified by\nthe viewer's account or the `Accept-Language` HTTP header.", - "type": "string" - }, - "honorificSuffix": { - "description": "The honorific suffixes, such as `Jr.`", - "type": "string" } }, "id": "Name" @@ -626,8 +666,8 @@ "type": "object", "properties": { "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the locale." + "description": "Metadata about the locale.", + "$ref": "FieldMetadata" }, "value": { "description": "The well-formed [IETF BCP 47](https://tools.ietf.org/html/bcp47)\nlanguage tag representing the locale.", @@ -637,10 +677,10 @@ "id": "Locale" }, "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 `{}`.", - "type": "object", "properties": {}, - "id": "Empty" + "id": "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 `{}`.", + "type": "object" }, "UserDefined": { "description": "Arbitrary user data that is populated by the end users.", @@ -665,9 +705,11 @@ "description": "A person's short biography.", "type": "object", "properties": { + "value": { + "description": "The short biography.", + "type": "string" + }, "contentType": { - "description": "The content type of the biography.", - "type": "string", "enumDescriptions": [ "Unspecified.", "Plain text.", @@ -677,15 +719,13 @@ "CONTENT_TYPE_UNSPECIFIED", "TEXT_PLAIN", "TEXT_HTML" - ] + ], + "description": "The content type of the biography.", + "type": "string" }, "metadata": { "$ref": "FieldMetadata", "description": "Metadata about the biography." - }, - "value": { - "description": "The short biography.", - "type": "string" } }, "id": "Biography" @@ -713,23 +753,7 @@ "description": "The source of a field.", "type": "object", "properties": { - "profileMetadata": { - "$ref": "ProfileMetadata", - "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE." - }, - "updateTime": { - "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.", - "format": "google-datetime", - "type": "string" - }, "type": { - "enumDescriptions": [ - "Unspecified.", - "[Google Account](https://accounts.google.com).", - "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e is the source id.", - "[Google Apps domain profile](https://admin.google.com).", - "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id." - ], "enum": [ "SOURCE_TYPE_UNSPECIFIED", "ACCOUNT", @@ -738,7 +762,14 @@ "CONTACT" ], "description": "The source type.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified.", + "[Google Account](https://accounts.google.com).", + "[Google profile](https://profiles.google.com). You can view the\nprofile at https://profiles.google.com/\u003cvar\u003eid\u003c/var\u003e where\n\u003cvar\u003eid\u003c/var\u003e is the source id.", + "[Google Apps domain profile](https://admin.google.com).", + "[Google contact](https://contacts.google.com). You can view the\ncontact at https://contact.google.com/\u003cvar\u003eid\u003c/var\u003e where \u003cvar\u003eid\u003c/var\u003e\nis the source id." + ] }, "etag": { "description": "**Only populated in `person.metadata.sources`.**\n\nThe [HTTP entity tag](https://en.wikipedia.org/wiki/HTTP_ETag) of the\nsource. Used for web cache validation.", @@ -747,17 +778,24 @@ "id": { "description": "The unique identifier within the source type generated by the server.", "type": "string" + }, + "profileMetadata": { + "description": "**Only populated in `person.metadata.sources`.**\n\nMetadata about a source of type PROFILE.", + "$ref": "ProfileMetadata" + }, + "updateTime": { + "description": "**Only populated in `person.metadata.sources`.**\n\nLast update timestamp of this source.", + "format": "google-datetime", + "type": "string" } }, "id": "Source" }, "RelationshipInterest": { - "description": "A person's read-only relationship interest .", - "type": "object", "properties": { "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the relationship interest." + "description": "Metadata about the relationship interest.", + "$ref": "FieldMetadata" }, "value": { "description": "The kind of relationship the person is looking for. The value can be custom\nor predefined. Possible values include, but are not limited to, the\nfollowing values:\n\n* `friend`\n* `date`\n* `relationship`\n* `networking`", @@ -768,7 +806,9 @@ "type": "string" } }, - "id": "RelationshipInterest" + "id": "RelationshipInterest", + "description": "A person's read-only relationship interest .", + "type": "object" }, "GetPeopleResponse": { "type": "object", @@ -784,20 +824,10 @@ "id": "GetPeopleResponse" }, "PhoneNumber": { - "description": "A person's phone number.", - "type": "object", "properties": { - "formattedType": { - "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.", - "type": "string" - }, - "canonicalForm": { - "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.", - "type": "string" - }, "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the phone number." + "description": "Metadata about the phone number.", + "$ref": "FieldMetadata" }, "type": { "description": "The type of the phone number. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `mobile`\n* `homeFax`\n* `workFax`\n* `otherFax`\n* `pager`\n* `workMobile`\n* `workPager`\n* `main`\n* `googleVoice`\n* `other`", @@ -806,9 +836,19 @@ "value": { "description": "The phone number.", "type": "string" + }, + "formattedType": { + "description": "The read-only type of the phone number translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.", + "type": "string" + }, + "canonicalForm": { + "description": "The read-only canonicalized [ITU-T E.164](https://law.resource.org/pub/us/cfr/ibr/004/itu-t.E.164.1.2008.pdf)\nform of the phone number.", + "type": "string" } }, - "id": "PhoneNumber" + "id": "PhoneNumber", + "description": "A person's phone number.", + "type": "object" }, "Photo": { "description": "A person's read-only photo. A picture shown next to the person's name to\nhelp others recognize the person.", @@ -830,7 +870,6 @@ "id": "Photo" }, "ListConnectionsResponse": { - "type": "object", "properties": { "totalPeople": { "description": "**DEPRECATED** (Please use totalItems)\nThe total number of people in the list without pagination.", @@ -858,42 +897,47 @@ "type": "integer" } }, - "id": "ListConnectionsResponse" + "id": "ListConnectionsResponse", + "type": "object" }, "Birthday": { "description": "A person's birthday. At least one of the `date` and `text` fields are\nspecified. The `date` and `text` fields typically represent the same\ndate, but are not guaranteed to.", "type": "object", "properties": { + "date": { + "$ref": "Date", + "description": "The date of the birthday." + }, "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the birthday." + "description": "Metadata about the birthday.", + "$ref": "FieldMetadata" }, "text": { "description": "A free-form string representing the user's birthday.", "type": "string" - }, - "date": { - "$ref": "Date", - "description": "The date of the birthday." } }, "id": "Birthday" }, "CreateContactGroupRequest": { - "description": "A request to create a new contact group.", - "type": "object", "properties": { "contactGroup": { "$ref": "ContactGroup", "description": "The contact group to create." } }, - "id": "CreateContactGroupRequest" + "id": "CreateContactGroupRequest", + "description": "A request to create a new contact group.", + "type": "object" }, "Address": { "description": "A person's physical address. May be a P.O. box or street address. All fields\nare optional.", "type": "object", "properties": { + "countryCode": { + "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.", + "type": "string" + }, "formattedType": { "description": "The read-only type of the address translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.", "type": "string" @@ -937,25 +981,10 @@ "metadata": { "$ref": "FieldMetadata", "description": "Metadata about the address." - }, - "countryCode": { - "description": "The [ISO 3166-1 alpha-2](http://www.iso.org/iso/country_codes.htm) country\ncode of the address.", - "type": "string" } }, "id": "Address" }, - "ContactGroupMembership": { - "description": "A Google contact group membership.", - "type": "object", - "properties": { - "contactGroupId": { - "description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.", - "type": "string" - } - }, - "id": "ContactGroupMembership" - }, "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.", "type": "object", @@ -973,23 +1002,32 @@ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "type": "object" } } }, "id": "Status" }, + "ContactGroupMembership": { + "description": "A Google contact group membership.", + "type": "object", + "properties": { + "contactGroupId": { + "description": "The contact group ID for the contact group membership. The contact group\nID can be custom or predefined. Possible values include, but are not\nlimited to, the following:\n\n* `myContacts`\n* `starred`\n* A numerical ID for user-created groups.", + "type": "string" + } + }, + "id": "ContactGroupMembership" + }, "PersonMetadata": { "description": "The read-only metadata about a person.", "type": "object", "properties": { "objectType": { - "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.", - "type": "string", "enumDescriptions": [ "Unspecified.", "Person.", @@ -999,7 +1037,9 @@ "OBJECT_TYPE_UNSPECIFIED", "PERSON", "PAGE" - ] + ], + "description": "**DEPRECATED** (Please use\n`person.metadata.sources.profileMetadata.objectType` instead)\n\nThe type of the person object.", + "type": "string" }, "linkedPeopleResourceNames": { "description": "Resource names of people linked to this resource.", @@ -1030,8 +1070,6 @@ "id": "PersonMetadata" }, "ModifyContactGroupMembersRequest": { - "description": "A request to modify an existing contact group's members.", - "type": "object", "properties": { "resourceNamesToAdd": { "description": "The resource names of the contact people to add in the form of in the form\n`people/`\u003cvar\u003eperson_id\u003c/var\u003e.", @@ -1048,23 +1086,25 @@ } } }, - "id": "ModifyContactGroupMembersRequest" + "id": "ModifyContactGroupMembersRequest", + "description": "A request to modify an existing contact group's members.", + "type": "object" }, "ContactGroupResponse": { "description": "The response for a specific contact group.", "type": "object", "properties": { - "contactGroup": { - "$ref": "ContactGroup", - "description": "The contact group." - }, - "status": { - "description": "The status of the response.", - "$ref": "Status" - }, "requestedResourceName": { "description": "The original requested resource name.", "type": "string" + }, + "contactGroup": { + "description": "The contact group.", + "$ref": "ContactGroup" + }, + "status": { + "$ref": "Status", + "description": "The status of the response." } }, "id": "ContactGroupResponse" @@ -1093,8 +1133,6 @@ "id": "Url" }, "ImClient": { - "description": "A person's instant messaging client.", - "type": "object", "properties": { "formattedProtocol": { "description": "The read-only protocol of the IM client formatted in the viewer's account\nlocale or the `Accept-Language` HTTP header locale.", @@ -1105,8 +1143,8 @@ "type": "string" }, "metadata": { - "description": "Metadata about the IM client.", - "$ref": "FieldMetadata" + "$ref": "FieldMetadata", + "description": "Metadata about the IM client." }, "type": { "description": "The type of the IM client. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`", @@ -1121,18 +1159,20 @@ "type": "string" } }, - "id": "ImClient" + "id": "ImClient", + "description": "A person's instant messaging client.", + "type": "object" }, "DomainMembership": { - "description": "A Google Apps Domain membership.", - "type": "object", "properties": { "inViewerDomain": { "description": "True if the person is in the viewer's Google Apps domain.", "type": "boolean" } }, - "id": "DomainMembership" + "id": "DomainMembership", + "description": "A Google Apps Domain membership.", + "type": "object" }, "BatchGetContactGroupsResponse": { "description": "The response to a batch get contact groups request.", @@ -1152,17 +1192,17 @@ "description": "A person's read-only membership in a group.", "type": "object", "properties": { + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the membership." + }, "contactGroupMembership": { - "description": "The contact group membership.", - "$ref": "ContactGroupMembership" + "$ref": "ContactGroupMembership", + "description": "The contact group membership." }, "domainMembership": { - "$ref": "DomainMembership", - "description": "The domain membership." - }, - "metadata": { - "description": "Metadata about the membership.", - "$ref": "FieldMetadata" + "description": "The domain membership.", + "$ref": "DomainMembership" } }, "id": "Membership" @@ -1205,26 +1245,18 @@ "description": "A person's past or current organization. Overlapping date ranges are\npermitted.", "type": "object", "properties": { - "title": { - "description": "The person's job title at the organization.", - "type": "string" - }, - "location": { - "description": "The location of the organization office the person works at.", - "type": "string" - }, "current": { "description": "True if the organization is the person's current organization;\nfalse if the organization is a past organization.", "type": "boolean" }, + "startDate": { + "description": "The start date when the person joined the organization.", + "$ref": "Date" + }, "formattedType": { "description": "The read-only type of the organization translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.", "type": "string" }, - "startDate": { - "$ref": "Date", - "description": "The start date when the person joined the organization." - }, "domain": { "description": "The domain name associated with the organization; for example, `google.com`.", "type": "string" @@ -1233,21 +1265,21 @@ "description": "The person's department at the organization.", "type": "string" }, - "type": { - "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`", - "type": "string" - }, "phoneticName": { "description": "The phonetic name of the organization.", "type": "string" }, + "type": { + "description": "The type of the organization. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `work`\n* `school`", + "type": "string" + }, "jobDescription": { "description": "The person's job description at the organization.", "type": "string" }, "endDate": { - "description": "The end date when the person left the organization.", - "$ref": "Date" + "$ref": "Date", + "description": "The end date when the person left the organization." }, "symbol": { "description": "The symbol associated with the organization; for example, a stock ticker\nsymbol, abbreviation, or acronym.", @@ -1258,8 +1290,16 @@ "type": "string" }, "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the organization." + "description": "Metadata about the organization.", + "$ref": "FieldMetadata" + }, + "location": { + "description": "The location of the organization office the person works at.", + "type": "string" + }, + "title": { + "description": "The person's job title at the organization.", + "type": "string" } }, "id": "Organization" @@ -1273,6 +1313,8 @@ "description": "Metadata about the age range." }, "ageRange": { + "description": "The age range.", + "type": "string", "enumDescriptions": [ "Unspecified.", "Younger than eighteen.", @@ -1284,9 +1326,7 @@ "LESS_THAN_EIGHTEEN", "EIGHTEEN_TO_TWENTY", "TWENTY_ONE_OR_OLDER" - ], - "description": "The age range.", - "type": "string" + ] } }, "id": "AgeRangeType" @@ -1319,16 +1359,14 @@ "id": "ListContactGroupsResponse" }, "PersonResponse": { - "description": "The response for a single person", - "type": "object", "properties": { "person": { "$ref": "Person", "description": "The person." }, "status": { - "description": "The status of the response.", - "$ref": "Status" + "$ref": "Status", + "description": "The status of the response." }, "httpStatusCode": { "description": "**DEPRECATED** (Please use status instead)\n\n[HTTP 1.1 status code]\n(http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html).", @@ -1340,7 +1378,9 @@ "type": "string" } }, - "id": "PersonResponse" + "id": "PersonResponse", + "description": "The response for a single person", + "type": "object" }, "Relation": { "description": "A person's relation to another person.", @@ -1355,8 +1395,8 @@ "type": "string" }, "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the relation." + "description": "Metadata about the relation.", + "$ref": "FieldMetadata" }, "type": { "description": "The person's relation to the other person. The type can be custom or predefined.\nPossible values include, but are not limited to, the following values:\n\n* `spouse`\n* `child`\n* `mother`\n* `father`\n* `parent`\n* `brother`\n* `sister`\n* `friend`\n* `relative`\n* `domesticPartner`\n* `manager`\n* `assistant`\n* `referredBy`\n* `partner`", @@ -1369,13 +1409,13 @@ "description": "A person's occupation.", "type": "object", "properties": { - "metadata": { - "description": "Metadata about the occupation.", - "$ref": "FieldMetadata" - }, "value": { "description": "The occupation; for example, `carpenter`.", "type": "string" + }, + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the occupation." } }, "id": "Occupation" @@ -1384,6 +1424,17 @@ "description": "A contact group.", "type": "object", "properties": { + "name": { + "description": "The contact group name set by the group owner or a system provided name\nfor system groups.", + "type": "string" + }, + "memberResourceNames": { + "description": "The list of contact person resource names that are members of the contact\ngroup. The field is not populated for LIST requests and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).", + "type": "array", + "items": { + "type": "string" + } + }, "metadata": { "description": "Metadata about the contact group.", "$ref": "ContactGroupMetadata" @@ -1406,8 +1457,6 @@ "type": "string" }, "groupType": { - "description": "The read-only contact group type.", - "type": "string", "enumDescriptions": [ "Unspecified.", "User defined contact group.", @@ -1417,17 +1466,8 @@ "GROUP_TYPE_UNSPECIFIED", "USER_CONTACT_GROUP", "SYSTEM_CONTACT_GROUP" - ] - }, - "memberResourceNames": { - "description": "The list of contact person resource names that are members of the contact\ngroup. The field is not populated for LIST requests and can only be updated\nthrough the\n[ModifyContactGroupMembers](/people/api/rest/v1/contactgroups/members/modify).", - "type": "array", - "items": { - "type": "string" - } - }, - "name": { - "description": "The contact group name set by the group owner or a system provided name\nfor system groups.", + ], + "description": "The read-only contact group type.", "type": "string" } }, @@ -1437,6 +1477,90 @@ "description": "Information about a person merged from various data sources such as the\nauthenticated user's contacts and profile data.\n\nMost fields can have multiple items. The items in a field have no guaranteed\norder, but each non-empty field is guaranteed to have exactly one field with\n`metadata.primary` set to true.", "type": "object", "properties": { + "memberships": { + "description": "The person's read-only group memberships.", + "type": "array", + "items": { + "$ref": "Membership" + } + }, + "phoneNumbers": { + "description": "The person's phone numbers.", + "type": "array", + "items": { + "$ref": "PhoneNumber" + } + }, + "coverPhotos": { + "description": "The person's read-only cover photos.", + "type": "array", + "items": { + "$ref": "CoverPhoto" + } + }, + "imClients": { + "description": "The person's instant messaging clients.", + "type": "array", + "items": { + "$ref": "ImClient" + } + }, + "birthdays": { + "description": "The person's birthdays.", + "type": "array", + "items": { + "$ref": "Birthday" + } + }, + "userDefined": { + "description": "The person's user defined data.", + "type": "array", + "items": { + "$ref": "UserDefined" + } + }, + "locales": { + "description": "The person's locale preferences.", + "type": "array", + "items": { + "$ref": "Locale" + } + }, + "relationshipInterests": { + "description": "The person's read-only relationship interests.", + "type": "array", + "items": { + "$ref": "RelationshipInterest" + } + }, + "urls": { + "description": "The person's associated URLs.", + "type": "array", + "items": { + "$ref": "Url" + } + }, + "nicknames": { + "description": "The person's nicknames.", + "type": "array", + "items": { + "$ref": "Nickname" + } + }, + "names": { + "description": "The person's names.", + "type": "array", + "items": { + "$ref": "Name" + } + }, + "relations": { + "description": "The person's relations.", + "type": "array", + "items": { + "$ref": "Relation" + } + }, "occupations": { "description": "The person's occupations.", "type": "array", @@ -1470,8 +1594,8 @@ } }, "metadata": { - "$ref": "PersonMetadata", - "description": "Read-only metadata about the person." + "description": "Read-only metadata about the person.", + "$ref": "PersonMetadata" }, "residences": { "description": "The person's residences.", @@ -1488,7 +1612,7 @@ } }, "interests": { - "description": "The person's interests.\n**DEPRECATED** (No values will be returned.)", + "description": "The person's interests.", "type": "array", "items": { "$ref": "Interest" @@ -1569,90 +1693,6 @@ "items": { "$ref": "Event" } - }, - "memberships": { - "description": "The person's read-only group memberships.", - "type": "array", - "items": { - "$ref": "Membership" - } - }, - "phoneNumbers": { - "description": "The person's phone numbers.", - "type": "array", - "items": { - "$ref": "PhoneNumber" - } - }, - "coverPhotos": { - "description": "The person's read-only cover photos.", - "type": "array", - "items": { - "$ref": "CoverPhoto" - } - }, - "imClients": { - "description": "The person's instant messaging clients.", - "type": "array", - "items": { - "$ref": "ImClient" - } - }, - "birthdays": { - "description": "The person's birthdays.", - "type": "array", - "items": { - "$ref": "Birthday" - } - }, - "userDefined": { - "description": "The person's user defined data.", - "type": "array", - "items": { - "$ref": "UserDefined" - } - }, - "locales": { - "description": "The person's locale preferences.", - "type": "array", - "items": { - "$ref": "Locale" - } - }, - "relationshipInterests": { - "description": "The person's read-only relationship interests.", - "type": "array", - "items": { - "$ref": "RelationshipInterest" - } - }, - "urls": { - "description": "The person's associated URLs.", - "type": "array", - "items": { - "$ref": "Url" - } - }, - "nicknames": { - "description": "The person's nicknames.", - "type": "array", - "items": { - "$ref": "Nickname" - } - }, - "relations": { - "description": "The person's relations.", - "type": "array", - "items": { - "$ref": "Relation" - } - }, - "names": { - "description": "The person's names.", - "type": "array", - "items": { - "$ref": "Name" - } } }, "id": "Person" @@ -1662,8 +1702,8 @@ "type": "object", "properties": { "contactGroup": { - "description": "The contact group to update.", - "$ref": "ContactGroup" + "$ref": "ContactGroup", + "description": "The contact group to update." } }, "id": "UpdateContactGroupRequest" @@ -1672,25 +1712,23 @@ "description": "The read-only metadata about a contact group.", "type": "object", "properties": { - "deleted": { - "description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.", - "type": "boolean" - }, "updateTime": { "description": "The time the group was last updated.", "format": "google-datetime", "type": "string" + }, + "deleted": { + "description": "True if the contact group resource has been deleted. Populated only for\n[`ListContactGroups`](/people/api/rest/v1/contactgroups/list) requests\nthat include a sync token.", + "type": "boolean" } }, "id": "ContactGroupMetadata" }, "Residence": { - "description": "A person's past or current residence.", - "type": "object", "properties": { "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the residence." + "description": "Metadata about the residence.", + "$ref": "FieldMetadata" }, "current": { "description": "True if the residence is the person's current residence;\nfalse if the residence is a past residence.", @@ -1701,7 +1739,9 @@ "type": "string" } }, - "id": "Residence" + "id": "Residence", + "description": "A person's past or current residence.", + "type": "object" }, "Event": { "description": "An event related to the person.", @@ -1716,8 +1756,8 @@ "type": "string" }, "date": { - "description": "The date of the event.", - "$ref": "Date" + "$ref": "Date", + "description": "The date of the event." }, "formattedType": { "description": "The read-only type of the event translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.", @@ -1745,49 +1785,43 @@ "type": "object", "properties": { "objectType": { - "enumDescriptions": [ - "Unspecified.", - "Person.", - "[Google+ Page.](http://www.google.com/+/brands/)" - ], "enum": [ "OBJECT_TYPE_UNSPECIFIED", "PERSON", "PAGE" ], "description": "The profile object type.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified.", + "Person.", + "[Google+ Page.](http://www.google.com/+/brands/)" + ] }, "userTypes": { - "enumDescriptions": [ - "The user type is not known.", - "The user is a Google user.", - "The user is a Google+ user.", - "The user is a Google Apps for Work user." - ], "description": "The user types.", "type": "array", "items": { - "type": "string", "enum": [ "USER_TYPE_UNKNOWN", "GOOGLE_USER", "GPLUS_USER", "GOOGLE_APPS_USER" - ] - } + ], + "type": "string" + }, + "enumDescriptions": [ + "The user type is not known.", + "The user is a Google user.", + "The user is a Google+ user.", + "The user is a Google Apps for Work user." + ] } }, "id": "ProfileMetadata" }, "Gender": { - "description": "A person's gender.", - "type": "object", "properties": { - "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the gender." - }, "value": { "description": "The gender for the person. The gender can be custom or predefined.\nPossible values include, but are not limited to, the\nfollowing:\n\n* `male`\n* `female`\n* `other`\n* `unknown`", "type": "string" @@ -1795,9 +1829,15 @@ "formattedValue": { "description": "The read-only value of the gender translated and formatted in the viewer's\naccount locale or the `Accept-Language` HTTP header locale.", "type": "string" + }, + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the gender." } }, - "id": "Gender" + "id": "Gender", + "description": "A person's gender.", + "type": "object" }, "CoverPhoto": { "description": "A person's read-only cover photo. A large image shown on the person's\nprofile page that represents who they are or what they care about.", @@ -1819,7 +1859,7 @@ "id": "CoverPhoto" }, "Interest": { - "description": "One of the person's interests.\n**DEPRECATED** (Message will not be returned.)", + "description": "One of the person's interests.", "type": "object", "properties": { "metadata": { @@ -1833,17 +1873,42 @@ }, "id": "Interest" }, + "EmailAddress": { + "description": "A person's email address.", + "type": "object", + "properties": { + "value": { + "description": "The email address.", + "type": "string" + }, + "formattedType": { + "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.", + "type": "string" + }, + "displayName": { + "description": "The display name of the email.", + "type": "string" + }, + "metadata": { + "$ref": "FieldMetadata", + "description": "Metadata about the email address." + }, + "type": { + "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`", + "type": "string" + } + }, + "id": "EmailAddress" + }, "Nickname": { "description": "A person's nickname.", "type": "object", "properties": { "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the nickname." + "description": "Metadata about the nickname.", + "$ref": "FieldMetadata" }, "type": { - "description": "The type of the nickname.", - "type": "string", "enumDescriptions": [ "Generic nickname.", "Maiden name or birth family name. Used when the person's family name has\nchanged as a result of marriage.", @@ -1857,7 +1922,9 @@ "INITIALS", "GPLUS", "OTHER_NAME" - ] + ], + "description": "The type of the nickname.", + "type": "string" }, "value": { "description": "The nickname.", @@ -1866,40 +1933,13 @@ }, "id": "Nickname" }, - "EmailAddress": { - "description": "A person's email address.", - "type": "object", - "properties": { - "formattedType": { - "description": "The read-only type of the email address translated and formatted in the\nviewer's account locale or the `Accept-Language` HTTP header locale.", - "type": "string" - }, - "displayName": { - "description": "The display name of the email.", - "type": "string" - }, - "metadata": { - "description": "Metadata about the email address.", - "$ref": "FieldMetadata" - }, - "type": { - "description": "The type of the email address. The type can be custom or predefined.\nPossible values include, but are not limited to, the following:\n\n* `home`\n* `work`\n* `other`", - "type": "string" - }, - "value": { - "description": "The email address.", - "type": "string" - } - }, - "id": "EmailAddress" - }, "Skill": { "description": "A skill that the person has.", "type": "object", "properties": { "metadata": { - "description": "Metadata about the skill.", - "$ref": "FieldMetadata" + "$ref": "FieldMetadata", + "description": "Metadata about the skill." }, "value": { "description": "The skill; for example, `underwater basket weaving`.", @@ -1907,43 +1947,6 @@ } }, "id": "Skill" - }, - "Tagline": { - "description": "A read-only brief one-line description of the person.", - "type": "object", - "properties": { - "metadata": { - "$ref": "FieldMetadata", - "description": "Metadata about the tagline." - }, - "value": { - "description": "The tagline.", - "type": "string" - } - }, - "id": "Tagline" - }, - "Date": { - "description": "Represents a whole calendar date, for example a date of birth. The time\nof day and time zone are either specified elsewhere or are not\nsignificant. The date is relative to the\n[Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar).\nThe day may be 0 to represent a year and month where the day is not\nsignificant. The year may be 0 to represent a month and day independent\nof year; for example, anniversary date.", - "type": "object", - "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" - } - }, - "id": "Date" } }, "icons": { @@ -1955,6 +1958,12 @@ "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/plus.login": { + "description": "Know the list of people in your circles, your age range, and language" + }, + "https://www.googleapis.com/auth/userinfo.profile": { + "description": "View your basic profile info" + }, "https://www.googleapis.com/auth/user.emails.read": { "description": "View your email addresses" }, @@ -1975,20 +1984,11 @@ }, "https://www.googleapis.com/auth/contacts.readonly": { "description": "View your contacts" - }, - "https://www.googleapis.com/auth/plus.login": { - "description": "Know the list of people in your circles, your age range, and language" - }, - "https://www.googleapis.com/auth/userinfo.profile": { - "description": "View your basic profile info" } } } }, "rootUrl": "https://people.googleapis.com/", "ownerDomain": "google.com", - "name": "people", - "batchPath": "batch", - "title": "Google People API", - "ownerName": "Google" + "name": "people" }
diff --git a/people/v1/people-gen.go b/people/v1/people-gen.go index 9fee382..7a03200 100644 --- a/people/v1/people-gen.go +++ b/people/v1/people-gen.go
@@ -1022,7 +1022,6 @@ } // Interest: One of the person's interests. -// **DEPRECATED** (Message will not be returned.) type Interest struct { // Metadata: Metadata about the interest. Metadata *FieldMetadata `json:"metadata,omitempty"` @@ -1577,7 +1576,6 @@ ImClients []*ImClient `json:"imClients,omitempty"` // Interests: The person's interests. - // **DEPRECATED** (No values will be returned.) Interests []*Interest `json:"interests,omitempty"` // Locales: The person's locale preferences. @@ -3807,6 +3805,7 @@ // * events // * genders // * imClients +// * interests // * locales // * memberships // * metadata @@ -3942,7 +3941,7 @@ // ], // "parameters": { // "personFields": { - // "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", + // "description": "**Required.** A field mask to restrict which fields on the person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -4017,6 +4016,7 @@ // * events // * genders // * imClients +// * interests // * locales // * memberships // * metadata @@ -4166,7 +4166,7 @@ // "parameterOrder": [], // "parameters": { // "personFields": { - // "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", + // "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -4252,6 +4252,7 @@ // * events // * genders // * imClients +// * interests // * locales // * names // * nicknames @@ -4369,7 +4370,7 @@ // "type": "string" // }, // "updatePersonFields": { - // "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls", + // "description": "**Required.** A field mask to restrict which fields on the person are\nupdated. Valid values are:\n\n* addresses\n* biographies\n* birthdays\n* braggingRights\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* relations\n* residences\n* skills\n* urls", // "format": "google-fieldmask", // "location": "query", // "type": "string" @@ -4441,6 +4442,7 @@ // * events // * genders // * imClients +// * interests // * locales // * memberships // * metadata @@ -4619,7 +4621,7 @@ // "type": "string" // }, // "personFields": { - // "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", + // "description": "**Required.** A field mask to restrict which fields on each person are\nreturned. Valid values are:\n\n* addresses\n* ageRanges\n* biographies\n* birthdays\n* braggingRights\n* coverPhotos\n* emailAddresses\n* events\n* genders\n* imClients\n* interests\n* locales\n* memberships\n* metadata\n* names\n* nicknames\n* occupations\n* organizations\n* phoneNumbers\n* photos\n* relations\n* relationshipInterests\n* relationshipStatuses\n* residences\n* skills\n* taglines\n* urls", // "format": "google-fieldmask", // "location": "query", // "type": "string"
diff --git a/plus/v1/plus-api.json b/plus/v1/plus-api.json index ac7e1fb..fb9b539 100644 --- a/plus/v1/plus-api.json +++ b/plus/v1/plus-api.json
@@ -20,7 +20,7 @@ "basePath": "/plus/v1/", "rootUrl": "https://www.googleapis.com/", "servicePath": "plus/v1/", - "batchPath": "batch", + "batchPath": "batch/plus/v1", "parameters": { "alt": { "type": "string",
diff --git a/poly/v1/poly-api.json b/poly/v1/poly-api.json index 68c93ce..e298a70 100644 --- a/poly/v1/poly-api.json +++ b/poly/v1/poly-api.json
@@ -1,25 +1,140 @@ { - "version": "v1", - "baseUrl": "https://poly.googleapis.com/", - "kind": "discovery#restDescription", - "description": "The Poly API provides read-only access to assets hosted on \u003ca href=\"https://poly.google.com\"\u003epoly.google.com\u003c/a\u003e.\n", - "servicePath": "", - "basePath": "", - "revision": "20180103", - "documentationLink": "https://developers.google.com/poly/", - "id": "poly:v1", - "discoveryVersion": "v1", - "version_module": true, "schemas": { - "Quaternion": { - "description": "A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the\nresponse you see \"w: 1\" and nothing else this is the default value of\n[0, 0, 0, 1] where x,y, and z are 0.", + "Format": { + "description": "The same asset can be represented in different formats, for example,\na [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its\ncorresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file\nwith its corresponding .glb binary data. A format refers to a specific\nrepresentation of an asset and contains all information needed to\nretrieve and describe this representation.", "type": "object", "properties": { - "w": { - "description": "The scalar component.", - "format": "double", - "type": "number" + "resources": { + "description": "A list of dependencies of the root element. May include, but is not\nlimited to, materials, textures, and shader programs.", + "type": "array", + "items": { + "$ref": "File" + } }, + "formatComplexity": { + "description": "Complexity stats about this representation of the asset.", + "$ref": "FormatComplexity" + }, + "root": { + "description": "The root of the file hierarchy. This will always be populated.\nFor some format_types - such as `TILT`, which are self-contained -\nthis is all of the data.\n\nOther types - such as `OBJ` - often reference other data elements.\nThese are contained in the resources field.", + "$ref": "File" + }, + "formatType": { + "description": "A short string that identifies the format type of this representation.\nPossible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", + "type": "string" + } + }, + "id": "Format" + }, + "Asset": { + "properties": { + "formats": { + "description": "A list of Formats where each\nformat describes one representation of the asset.", + "type": "array", + "items": { + "$ref": "Format" + } + }, + "presentationParams": { + "description": "Hints for displaying the asset. Note that these parameters are not\nimmutable; the author of an asset may change them post-publication.", + "$ref": "PresentationParams" + }, + "thumbnail": { + "description": "The thumbnail image for the asset.", + "$ref": "File" + }, + "description": { + "description": "The human-readable description, set by the asset's author.", + "type": "string" + }, + "visibility": { + "description": "The visibility of the asset and who can access it.", + "type": "string", + "enumDescriptions": [ + "Unknown (and invalid) visibility.", + "Access to the asset and its underlying files and resources is restricted to\nthe author.\n**Authentication:** You must supply an OAuth token that corresponds to the\nauthor's account.", + "Access to the asset and its underlying files and resources is available to\nanyone with the asset's name. Unlisted assets are **not**\nreturned by List Assets.", + "Access to the asset and its underlying files and resources is available\nto anyone." + ], + "enum": [ + "VISIBILITY_UNSPECIFIED", + "PRIVATE", + "UNLISTED", + "PUBLIC" + ] + }, + "authorName": { + "description": "The author's publicly visible name. Use this name when giving credit to the\nauthor. For more information, see [Licensing](/poly/discover/licensing).", + "type": "string" + }, + "name": { + "description": "The unique identifier for the asset in the form:\n`assets/{ASSET_ID}`.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name, set by the asset's author.", + "type": "string" + }, + "createTime": { + "description": "For published assets, the time when the asset was published.\nFor unpublished assets, the time when the asset was created.", + "format": "google-datetime", + "type": "string" + }, + "updateTime": { + "description": "The time when the asset was last modified. For published assets, whose\ncontents are immutable, the update time changes only when metadata\nproperties, such as visibility, are updated.", + "format": "google-datetime", + "type": "string" + }, + "license": { + "enumDescriptions": [ + "Unknown license value.", + "Creative Commons CC-BY 3.0. https://creativecommons.org/licenses/by/3.0/", + "Unlicensed: All Rights Reserved by the author. Unlicensed assets are\n**not** returned by List Assets." + ], + "enum": [ + "UNKNOWN", + "CREATIVE_COMMONS_BY", + "ALL_RIGHTS_RESERVED" + ], + "description": "The license under which the author has made the asset available\nfor use, if any.", + "type": "string" + }, + "isCurated": { + "description": "Whether this asset has been curated by the Poly team.", + "type": "boolean" + } + }, + "id": "Asset", + "description": "Represents and describes an asset in the Poly library. An asset is a 3D model\nor scene created using [Tilt Brush](//www.tiltbrush.com),\n[Blocks](//vr.google.com/blocks/), or any 3D program that produces a file\nthat can be upload to Poly.", + "type": "object" + }, + "PresentationParams": { + "description": "Hints for displaying the asset, based on information available when the asset\nwas uploaded.", + "type": "object", + "properties": { + "orientingRotation": { + "$ref": "Quaternion", + "description": "A rotation that should be applied to the object root to make it upright.\nMore precisely, this quaternion transforms from \"object space\" (the space\nin which the object is defined) to \"presentation space\", a coordinate\nsystem where +Y is up, +X is right, -Z is forward. For example, if\nthe object is the Eiffel Tower, in its local coordinate system the\nobject might be laid out such that the base of the tower is on the\nYZ plane and the tip of the tower is towards positive X. In this case\nthis quaternion would specify a rotation (of 90 degrees about the Z\naxis) such that in the presentation space the base of the tower is\naligned with the XZ plane, and the tip of the tower lies towards +Y.\n\nThis rotation is unrelated to the object's pose in the web preview,\nwhich is just a camera position setting and is *not* reflected in this\nrotation.\n\nPlease note: this is applicable only to the gLTF." + }, + "colorSpace": { + "enum": [ + "UNKNOWN", + "LINEAR", + "GAMMA" + ], + "description": "The materials' diffuse/albedo color. This does not apply to vertex colors\nor texture maps.", + "type": "string", + "enumDescriptions": [ + "Invalid color value.", + "Linear color values. Default.", + "Colors should be converted to linear by assuming gamma = 2.0." + ] + } + }, + "id": "PresentationParams" + }, + "Quaternion": { + "properties": { "y": { "description": "The y component.", "format": "double", @@ -34,9 +149,16 @@ "description": "The z component.", "format": "double", "type": "number" + }, + "w": { + "description": "The scalar component.", + "format": "double", + "type": "number" } }, - "id": "Quaternion" + "id": "Quaternion", + "description": "A [Quaternion](//en.wikipedia.org/wiki/Quaternion). Please note: if in the\nresponse you see \"w: 1\" and nothing else this is the default value of\n[0, 0, 0, 1] where x,y, and z are 0.", + "type": "object" }, "FormatComplexity": { "properties": { @@ -56,8 +178,6 @@ "type": "object" }, "ListUserAssetsResponse": { - "description": "A response message from a request to list.", - "type": "object", "properties": { "userAssets": { "description": "A list of UserAssets matching the request.", @@ -76,21 +196,27 @@ "type": "integer" } }, - "id": "ListUserAssetsResponse" + "id": "ListUserAssetsResponse", + "description": "A response message from a request to list.", + "type": "object" }, "UserAsset": { "description": "Data about the user's asset.", "type": "object", "properties": { "asset": { - "description": "An Asset.", - "$ref": "Asset" + "$ref": "Asset", + "description": "An Asset." } }, "id": "UserAsset" }, "File": { "properties": { + "url": { + "description": "The URL where the file data can be retrieved.", + "type": "string" + }, "contentType": { "description": "The MIME content-type, such as `image/png`.\nFor more information, see\n[MIME types](//developer.mozilla.org/en-US/docs/Web/HTTP/Basics_of_HTTP/MIME_types).", "type": "string" @@ -98,10 +224,6 @@ "relativePath": { "description": "The path of the resource file relative to the root file.\nFor root or thumbnail files, this is just the filename.", "type": "string" - }, - "url": { - "description": "The URL where the file data can be retrieved.", - "type": "string" } }, "id": "File", @@ -153,144 +275,11 @@ } }, "id": "ListAssetsResponse" - }, - "Format": { - "description": "The same asset can be represented in different formats, for example,\na [WaveFront .obj](//en.wikipedia.org/wiki/Wavefront_.obj_file) file with its\ncorresponding .mtl file or a [Khronos glTF](//www.khronos.org/gltf) file\nwith its corresponding .glb binary data. A format refers to a specific\nrepresentation of an asset and contains all information needed to\nretrieve and describe this representation.", - "type": "object", - "properties": { - "formatComplexity": { - "$ref": "FormatComplexity", - "description": "Complexity stats about this representation of the asset." - }, - "root": { - "description": "The root of the file hierarchy. This will always be populated.\nFor some format_types - such as `TILT`, which are self-contained -\nthis is all of the data.\n\nOther types - such as `OBJ` - often reference other data elements.\nThese are contained in the resources field.", - "$ref": "File" - }, - "formatType": { - "description": "A short string that identifies the format type of this representation.\nPossible values are: `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", - "type": "string" - }, - "resources": { - "description": "A list of dependencies of the root element. May include, but is not\nlimited to, materials, textures, and shader programs.", - "type": "array", - "items": { - "$ref": "File" - } - } - }, - "id": "Format" - }, - "Asset": { - "description": "Represents and describes an asset in the Poly library. An asset is a 3D model\nor scene created using [Tilt Brush](//www.tiltbrush.com),\n[Blocks](//vr.google.com/blocks/), or any 3D program that produces a file\nthat can be upload to Poly.", - "type": "object", - "properties": { - "updateTime": { - "description": "The time when the asset was last modified. For published assets, whose\ncontents are immutable, the update time changes only when metadata\nproperties, such as visibility, are updated.", - "format": "google-datetime", - "type": "string" - }, - "license": { - "description": "The license under which the author has made the asset available\nfor use, if any.", - "type": "string", - "enumDescriptions": [ - "Unknown license value.", - "Creative Commons CC-BY 3.0. https://creativecommons.org/licenses/by/3.0/", - "Unlicensed: All Rights Reserved by the author. Unlicensed assets are\n**not** returned by List Assets." - ], - "enum": [ - "UNKNOWN", - "CREATIVE_COMMONS_BY", - "ALL_RIGHTS_RESERVED" - ] - }, - "isCurated": { - "description": "Whether this asset has been curated by the Poly team.", - "type": "boolean" - }, - "formats": { - "description": "A list of Formats where each\nformat describes one representation of the asset.", - "type": "array", - "items": { - "$ref": "Format" - } - }, - "presentationParams": { - "description": "Hints for displaying the asset. Note that these parameters are not\nimmutable; the author of an asset may change them post-publication.", - "$ref": "PresentationParams" - }, - "thumbnail": { - "description": "The thumbnail image for the asset.", - "$ref": "File" - }, - "description": { - "description": "The human-readable description, set by the asset's author.", - "type": "string" - }, - "visibility": { - "enumDescriptions": [ - "Unknown (and invalid) visibility.", - "Access to the asset and its underlying files and resources is restricted to\nthe author.\n**Authentication:** You must supply an OAuth token that corresponds to the\nauthor's account.", - "Access to the asset and its underlying files and resources is available to\nanyone with the asset's name. Unlisted assets are **not**\nreturned by List Assets.", - "Access to the asset and its underlying files and resources is available\nto anyone." - ], - "enum": [ - "VISIBILITY_UNSPECIFIED", - "PRIVATE", - "UNLISTED", - "PUBLIC" - ], - "description": "The visibility of the asset and who can access it.", - "type": "string" - }, - "authorName": { - "description": "The author's publicly visible name. Use this name when giving credit to the\nauthor. For more information, see [Licensing](/poly/discover/licensing).", - "type": "string" - }, - "name": { - "description": "The unique identifier for the asset in the form:\n`assets/{ASSET_ID}`.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name, set by the asset's author.", - "type": "string" - }, - "createTime": { - "description": "For published assets, the time when the asset was published.\nFor unpublished assets, the time when the asset was created.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "Asset" - }, - "PresentationParams": { - "description": "Hints for displaying the asset, based on information available when the asset\nwas uploaded.", - "type": "object", - "properties": { - "orientingRotation": { - "$ref": "Quaternion", - "description": "A rotation that should be applied to the object root to make it upright.\nMore precisely, this quaternion transforms from \"object space\" (the space\nin which the object is defined) to \"presentation space\", a coordinate\nsystem where +Y is up, +X is right, -Z is forward. For example, if\nthe object is the Eiffel Tower, in its local coordinate system the\nobject might be laid out such that the base of the tower is on the\nYZ plane and the tip of the tower is towards positive X. In this case\nthis quaternion would specify a rotation (of 90 degrees about the Z\naxis) such that in the presentation space the base of the tower is\naligned with the XZ plane, and the tip of the tower lies towards +Y.\n\nThis rotation is unrelated to the object's pose in the web preview,\nwhich is just a camera position setting and is *not* reflected in this\nrotation.\n\nPlease note: this is applicable only to the gLTF." - }, - "colorSpace": { - "enum": [ - "UNKNOWN", - "LINEAR", - "GAMMA" - ], - "description": "The materials' diffuse/albedo color. This does not apply to vertex colors\nor texture maps.", - "type": "string", - "enumDescriptions": [ - "Invalid color value.", - "Linear color values. Default.", - "Colors should be converted to linear by assuming gamma = 2.0." - ] - } - }, - "id": "PresentationParams" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "canonicalName": "Poly Service", @@ -302,92 +291,6 @@ "title": "Poly API", "ownerName": "Google", "resources": { - "assets": { - "methods": { - "get": { - "description": "Returns detailed information about an asset given its name.\nPRIVATE assets are returned only if\n the currently authenticated user (via OAuth token) is the author of the asset.", - "response": { - "$ref": "Asset" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "description": "Required. An asset's name in the form `assets/{ASSET_ID}`.", - "required": true, - "type": "string", - "pattern": "^assets/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/assets/{assetsId}", - "path": "v1/{+name}", - "id": "poly.assets.get" - }, - "list": { - "flatPath": "v1/assets", - "path": "v1/assets", - "id": "poly.assets.list", - "description": "Lists all public, remixable assets. These are assets with an access level of\nPUBLIC and published under the\nCC-By license.", - "response": { - "$ref": "ListAssetsResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from next_page_token.", - "type": "string", - "location": "query" - }, - "maxComplexity": { - "location": "query", - "enum": [ - "COMPLEXITY_UNSPECIFIED", - "COMPLEX", - "MEDIUM", - "SIMPLE" - ], - "description": "Returns assets that are of the specified complexity or less. Defaults to\nCOMPLEX. For example, a request for\nMEDIUM assets also includes\nSIMPLE assets.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.", - "format": "int32", - "type": "integer" - }, - "keywords": { - "description": "One or more search terms to be matched against all text that Poly has\nindexed for assets, which includes display_name,\ndescription, and tags. Multiple keywords should be\nseparated by spaces.", - "type": "string", - "location": "query" - }, - "orderBy": { - "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.", - "type": "string", - "location": "query" - }, - "format": { - "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", - "type": "string", - "location": "query" - }, - "curated": { - "location": "query", - "description": "Return only assets that have been curated by the Poly team.", - "type": "boolean" - }, - "category": { - "location": "query", - "description": "Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`,\n`technology`, and `transport`.", - "type": "string" - } - } - } - } - }, "users": { "resources": { "likedassets": { @@ -420,15 +323,15 @@ "type": "string" }, "pageSize": { - "location": "query", "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "format": { - "location": "query", "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", - "type": "string" + "type": "string", + "location": "query" } }, "flatPath": "v1/users/{usersId}/likedassets", @@ -440,6 +343,9 @@ "assets": { "methods": { "list": { + "flatPath": "v1/users/{usersId}/assets", + "path": "v1/{+name}/assets", + "id": "poly.users.assets.list", "description": "Lists assets authored by the given user. Only the value 'me', representing\nthe currently-authenticated user, is supported. May include assets with an\naccess level of PRIVATE or\nUNLISTED and assets which are\nAll Rights Reserved for the\ncurrently-authenticated user.", "response": { "$ref": "ListUserAssetsResponse" @@ -449,28 +355,6 @@ ], "httpMethod": "GET", "parameters": { - "visibility": { - "enum": [ - "VISIBILITY_UNSPECIFIED", - "PUBLISHED", - "PRIVATE" - ], - "description": "The visibility of the assets to be returned.\nDefaults to VISIBILITY_UNSPECIFIED which returns all assets.", - "type": "string", - "location": "query" - }, - "name": { - "location": "path", - "description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.", - "required": true, - "type": "string", - "pattern": "^users/[^/]+$" - }, - "orderBy": { - "location": "query", - "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.", - "type": "string" - }, "format": { "location": "query", "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, and `TILT`.", @@ -486,19 +370,168 @@ "format": "int32", "type": "integer", "location": "query" + }, + "visibility": { + "location": "query", + "enum": [ + "VISIBILITY_UNSPECIFIED", + "PUBLISHED", + "PRIVATE" + ], + "description": "The visibility of the assets to be returned.\nDefaults to VISIBILITY_UNSPECIFIED which returns all assets.", + "type": "string" + }, + "name": { + "description": "A valid user id. Currently, only the special value 'me', representing the\ncurrently-authenticated user is supported. To use 'me', you must pass\nan OAuth token with the request.", + "required": true, + "type": "string", + "pattern": "^users/[^/]+$", + "location": "path" + }, + "orderBy": { + "location": "query", + "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.", + "type": "string" } - }, - "flatPath": "v1/users/{usersId}/assets", - "path": "v1/{+name}/assets", - "id": "poly.users.assets.list" + } } } } } + }, + "assets": { + "methods": { + "get": { + "flatPath": "v1/assets/{assetsId}", + "path": "v1/{+name}", + "id": "poly.assets.get", + "description": "Returns detailed information about an asset given its name.\nPRIVATE assets are returned only if\n the currently authenticated user (via OAuth token) is the author of the asset.", + "response": { + "$ref": "Asset" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "Required. An asset's name in the form `assets/{ASSET_ID}`.", + "required": true, + "type": "string", + "pattern": "^assets/[^/]+$", + "location": "path" + } + } + }, + "list": { + "response": { + "$ref": "ListAssetsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "keywords": { + "description": "One or more search terms to be matched against all text that Poly has\nindexed for assets, which includes display_name,\ndescription, and tags. Multiple keywords should be\nseparated by spaces.", + "type": "string", + "location": "query" + }, + "orderBy": { + "description": "Specifies an ordering for assets. Acceptable values are:\n`BEST`, `NEWEST`, `OLDEST`. Defaults to `BEST`, which ranks assets\nbased on a combination of popularity and other features.", + "type": "string", + "location": "query" + }, + "format": { + "description": "Return only assets with the matching format. Acceptable values are:\n`BLOCKS`, `FBX`, `GLTF`, `GLTF2`, `OBJ`, `TILT`.", + "type": "string", + "location": "query" + }, + "curated": { + "description": "Return only assets that have been curated by the Poly team.", + "type": "boolean", + "location": "query" + }, + "category": { + "description": "Filter assets based on the specified category. Supported values are:\n`animals`, `architecture`, `art`, `food`, `nature`, `objects`, `people`, `scenes`,\n`technology`, and `transport`.", + "type": "string", + "location": "query" + }, + "pageToken": { + "description": "Specifies a continuation token from a previous search whose results were\nsplit into multiple pages. To get the next page, submit the same request\nspecifying the value from next_page_token.", + "type": "string", + "location": "query" + }, + "maxComplexity": { + "enum": [ + "COMPLEXITY_UNSPECIFIED", + "COMPLEX", + "MEDIUM", + "SIMPLE" + ], + "description": "Returns assets that are of the specified complexity or less. Defaults to\nCOMPLEX. For example, a request for\nMEDIUM assets also includes\nSIMPLE assets.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of assets to be returned. This value must be between `1`\nand `100`. Defaults to `20`.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1/assets", + "path": "v1/assets", + "id": "poly.assets.list", + "description": "Lists all public, remixable assets. These are assets with an access level of\nPUBLIC and published under the\nCC-By license." + } + } } }, "parameters": { + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, "alt": { + "enum": [ + "json", + "media", + "proto" + ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", @@ -507,12 +540,7 @@ ], "location": "query", "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] + "default": "json" }, "key": { "location": "query", @@ -541,48 +569,20 @@ "type": "string" }, "oauth_token": { - "location": "query", "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" } - } + }, + "version": "v1", + "baseUrl": "https://poly.googleapis.com/", + "kind": "discovery#restDescription", + "description": "The Poly API provides read-only access to assets hosted on \u003ca href=\"https://poly.google.com\"\u003epoly.google.com\u003c/a\u003e.\n", + "servicePath": "", + "basePath": "", + "revision": "20180103", + "documentationLink": "https://developers.google.com/poly/", + "id": "poly:v1", + "discoveryVersion": "v1", + "version_module": true }
diff --git a/proximitybeacon/v1beta1/proximitybeacon-api.json b/proximitybeacon/v1beta1/proximitybeacon-api.json index 1051662..bb7c4b0 100644 --- a/proximitybeacon/v1beta1/proximitybeacon-api.json +++ b/proximitybeacon/v1beta1/proximitybeacon-api.json
@@ -1,15 +1,37 @@ { - "discoveryVersion": "v1", + "baseUrl": "https://proximitybeacon.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/userlocation.beacon.registry": { + "description": "View and modify your beacons" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "Registers, manages, indexes, and searches beacons.", + "servicePath": "", + "rootUrl": "https://proximitybeacon.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "proximitybeacon", + "batchPath": "batch", + "revision": "20171112", + "documentationLink": "https://developers.google.com/beacons/proximity/", + "id": "proximitybeacon:v1beta1", + "title": "Google Proximity Beacon API", "ownerName": "Google", + "discoveryVersion": "v1", "version_module": true, "resources": { "beaconinfo": { "methods": { "getforobserved": { + "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.", "request": { "$ref": "GetInfoForObservedBeaconsRequest" }, - "description": "Given one or more beacon observations, returns any beacon information\nand attachments accessible to your application. Authorize by using the\n[API key](https://developers.google.com/beacons/proximity/get-started#request_a_browser_api_key)\nfor the application.", "response": { "$ref": "GetInfoForObservedBeaconsResponse" }, @@ -46,10 +68,10 @@ "path": "v1beta1/namespaces" }, "update": { + "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.", "request": { "$ref": "Namespace" }, - "description": "Updates the information about the specified namespace. Only the namespace\nvisibility can be updated.", "response": { "$ref": "Namespace" }, @@ -57,13 +79,16 @@ "namespaceName" ], "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/userlocation.beacon.registry" + ], "parameters": { "namespaceName": { + "location": "path", "description": "Resource name of this namespace. Namespaces names have the format:\n\u003ccode\u003enamespaces/\u003cvar\u003enamespace\u003c/var\u003e\u003c/code\u003e.", "required": true, "type": "string", - "pattern": "^namespaces/[^/]+$", - "location": "path" + "pattern": "^namespaces/[^/]+$" }, "projectId": { "description": "The project id of the namespace to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", @@ -71,9 +96,6 @@ "location": "query" } }, - "scopes": [ - "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], "flatPath": "v1beta1/namespaces/{namespacesId}", "path": "v1beta1/{+namespaceName}", "id": "proximitybeacon.namespaces.update" @@ -84,18 +106,18 @@ "methods": { "getEidparams": { "flatPath": "v1beta1/eidparams", - "id": "proximitybeacon.getEidparams", "path": "v1beta1/eidparams", + "id": "proximitybeacon.getEidparams", "description": "Gets the Proximity Beacon API's current public key and associated\nparameters used to initiate the Diffie-Hellman key exchange required to\nregister a beacon that broadcasts the Eddystone-EID format. This key\nchanges periodically; clients may cache it and re-use the same public key\nto provision and register multiple beacons. However, clients should be\nprepared to refresh this key when they encounter an error registering an\nEddystone-EID beacon.", - "httpMethod": "GET", "response": { "$ref": "EphemeralIdRegistrationParams" }, "parameterOrder": [], - "parameters": {}, + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/userlocation.beacon.registry" - ] + ], + "parameters": {} } } }, @@ -110,17 +132,17 @@ ], "httpMethod": "POST", "parameters": { + "projectId": { + "location": "query", + "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", + "type": "string" + }, "beaconName": { "description": "Beacon that should be activated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", "required": true, "type": "string", "pattern": "^beacons/[^/]+$", "location": "path" - }, - "projectId": { - "description": "The project id of the beacon to activate. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", - "type": "string", - "location": "query" } }, "scopes": [ @@ -140,51 +162,18 @@ "beaconName" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/userlocation.beacon.registry" + ], "parameters": { - "beaconName": { - "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", - "required": true, - "type": "string", - "pattern": "^beacons/[^/]+$", - "location": "path" - }, "projectId": { "description": "The project id of the beacon to request. If the project id is not specified\nthen the project making the request is used. The project id must match the\nproject that owns the beacon.\nOptional.", "type": "string", "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], - "flatPath": "v1beta1/beacons/{beaconsId}", - "path": "v1beta1/{+beaconName}", - "id": "proximitybeacon.beacons.get" - }, - "update": { - "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", - "request": { - "$ref": "Beacon" - }, - "response": { - "$ref": "Beacon" - }, - "parameterOrder": [ - "beaconName" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], - "parameters": { - "projectId": { - "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", - "type": "string", - "location": "query" }, "beaconName": { "location": "path", - "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.", + "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", "required": true, "type": "string", "pattern": "^beacons/[^/]+$" @@ -192,43 +181,102 @@ }, "flatPath": "v1beta1/beacons/{beaconsId}", "path": "v1beta1/{+beaconName}", - "id": "proximitybeacon.beacons.update" + "id": "proximitybeacon.beacons.get" + }, + "update": { + "flatPath": "v1beta1/beacons/{beaconsId}", + "id": "proximitybeacon.beacons.update", + "path": "v1beta1/{+beaconName}", + "request": { + "$ref": "Beacon" + }, + "description": "Updates the information about the specified beacon. **Any field that you do\nnot populate in the submitted beacon will be permanently erased**, so you\nshould follow the \"read, modify, write\" pattern to avoid inadvertently\ndestroying data.\n\nChanges to the beacon status via this method will be silently ignored.\nTo update beacon status, use the separate methods on this API for\nactivation, deactivation, and decommissioning.\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", + "httpMethod": "PUT", + "parameterOrder": [ + "beaconName" + ], + "response": { + "$ref": "Beacon" + }, + "parameters": { + "beaconName": { + "location": "path", + "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.", + "required": true, + "type": "string", + "pattern": "^beacons/[^/]+$" + }, + "projectId": { + "location": "query", + "description": "The project id of the beacon to update. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/userlocation.beacon.registry" + ] }, "decommission": { + "flatPath": "v1beta1/beacons/{beaconsId}:decommission", + "path": "v1beta1/{+beaconName}:decommission", + "id": "proximitybeacon.beacons.decommission", "description": "Decommissions the specified beacon in the service. This beacon will no\nlonger be returned from `beaconinfo.getforobserved`. This operation is\npermanent -- you will not be able to re-register a beacon with this ID\nagain.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", - "httpMethod": "POST", "response": { "$ref": "Empty" }, "parameterOrder": [ "beaconName" ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/userlocation.beacon.registry" + ], "parameters": { + "projectId": { + "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", + "type": "string", + "location": "query" + }, "beaconName": { + "location": "path", "description": "Beacon that should be decommissioned. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID of the beacon's \"stable\" UID.\nRequired.", "required": true, "type": "string", - "pattern": "^beacons/[^/]+$", - "location": "path" + "pattern": "^beacons/[^/]+$" + } + } + }, + "deactivate": { + "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "beaconName" + ], + "httpMethod": "POST", + "parameters": { + "beaconName": { + "location": "path", + "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", + "required": true, + "type": "string", + "pattern": "^beacons/[^/]+$" }, "projectId": { - "location": "query", - "description": "The project id of the beacon to decommission. If the project id is not\nspecified then the project making the request is used. The project id\nmust match the project that owns the beacon.\nOptional.", - "type": "string" + "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.", + "type": "string", + "location": "query" } }, "scopes": [ "https://www.googleapis.com/auth/userlocation.beacon.registry" ], - "flatPath": "v1beta1/beacons/{beaconsId}:decommission", - "id": "proximitybeacon.beacons.decommission", - "path": "v1beta1/{+beaconName}:decommission" + "flatPath": "v1beta1/beacons/{beaconsId}:deactivate", + "path": "v1beta1/{+beaconName}:deactivate", + "id": "proximitybeacon.beacons.deactivate" }, "delete": { - "flatPath": "v1beta1/beacons/{beaconsId}", - "path": "v1beta1/{+beaconName}", - "id": "proximitybeacon.beacons.delete", - "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "response": { "$ref": "Empty" }, @@ -236,9 +284,6 @@ "beaconName" ], "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], "parameters": { "beaconName": { "description": "Beacon that should be deleted. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", @@ -252,58 +297,28 @@ "type": "string", "location": "query" } - } - }, - "deactivate": { - "flatPath": "v1beta1/beacons/{beaconsId}:deactivate", - "path": "v1beta1/{+beaconName}:deactivate", - "id": "proximitybeacon.beacons.deactivate", - "description": "Deactivates a beacon. Once deactivated, the API will not return\ninformation nor attachment data for the beacon when queried via\n`beaconinfo.getforobserved`. Calling this method on an already inactive\nbeacon will do nothing (but will return a successful response code).\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", - "response": { - "$ref": "Empty" }, - "parameterOrder": [ - "beaconName" - ], - "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/userlocation.beacon.registry" ], - "parameters": { - "projectId": { - "location": "query", - "description": "The project id of the beacon to deactivate. If the project id is not\nspecified then the project making the request is used. The project id must\nmatch the project that owns the beacon.\nOptional.", - "type": "string" - }, - "beaconName": { - "location": "path", - "description": "Beacon that should be deactivated. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", - "required": true, - "type": "string", - "pattern": "^beacons/[^/]+$" - } - } + "flatPath": "v1beta1/beacons/{beaconsId}", + "path": "v1beta1/{+beaconName}", + "id": "proximitybeacon.beacons.delete", + "description": "Deletes the specified beacon including all diagnostics data for the beacon\nas well as any attachments on the beacon (including those belonging to\nother projects). This operation cannot be undone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project." }, "list": { - "httpMethod": "GET", - "parameterOrder": [], + "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.", "response": { "$ref": "ListBeaconsResponse" }, - "scopes": [ - "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], + "parameterOrder": [], + "httpMethod": "GET", "parameters": { - "pageToken": { - "description": "A pagination token obtained from a previous request to list beacons.", + "q": { + "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`", "type": "string", "location": "query" }, - "q": { - "location": "query", - "description": "Filter query string that supports the following field filters:\n\n* **description:`\"\u003cstring\u003e\"`**\n For example: **description:\"Room 3\"**\n Returns beacons whose description matches tokens in the string \"Room 3\"\n (not necessarily that exact string).\n The string must be double-quoted.\n* **status:`\u003cenum\u003e`**\n For example: **status:active**\n Returns beacons whose status matches the given value. Values must be\n one of the Beacon.Status enum values (case insensitive). Accepts\n multiple filters which will be combined with OR logic.\n* **stability:`\u003cenum\u003e`**\n For example: **stability:mobile**\n Returns beacons whose expected stability matches the given value.\n Values must be one of the Beacon.Stability enum values (case\n insensitive). Accepts multiple filters which will be combined with\n OR logic.\n* **place\\_id:`\"\u003cstring\u003e\"`**\n For example: **place\\_id:\"ChIJVSZzVR8FdkgRXGmmm6SslKw=\"**\n Returns beacons explicitly registered at the given place, expressed as\n a Place ID obtained from [Google Places API](/places/place-id). Does not\n match places inside the given place. Does not consider the beacon's\n actual location (which may be different from its registered place).\n Accepts multiple filters that will be combined with OR logic. The place\n ID must be double-quoted.\n* **registration\\_time`[\u003c|\u003e|\u003c=|\u003e=]\u003cinteger\u003e`**\n For example: **registration\\_time\u003e=1433116800**\n Returns beacons whose registration time matches the given filter.\n Supports the operators: \u003c, \u003e, \u003c=, and \u003e=. Timestamp must be expressed as\n an integer number of seconds since midnight January 1, 1970 UTC. Accepts\n at most two filters that will be combined with AND logic, to support\n \"between\" semantics. If more than two are supplied, the latter ones are\n ignored.\n* **lat:`\u003cdouble\u003e lng:\u003cdouble\u003e radius:\u003cinteger\u003e`**\n For example: **lat:51.1232343 lng:-1.093852 radius:1000**\n Returns beacons whose registered location is within the given circle.\n When any of these fields are given, all are required. Latitude and\n longitude must be decimal degrees between -90.0 and 90.0 and between\n -180.0 and 180.0 respectively. Radius must be an integer number of\n meters between 10 and 1,000,000 (1000 km).\n* **property:`\"\u003cstring\u003e=\u003cstring\u003e\"`**\n For example: **property:\"battery-type=CR2032\"**\n Returns beacons which have a property of the given name and value.\n Supports multiple filters which will be combined with OR logic.\n The entire name=value string must be double-quoted as one string.\n* **attachment\\_type:`\"\u003cstring\u003e\"`**\n For example: **attachment_type:\"my-namespace/my-type\"**\n Returns beacons having at least one attachment of the given namespaced\n type. Supports \"any within this namespace\" via the partial wildcard\n syntax: \"my-namespace/*\". Supports multiple filters which will be\n combined with OR logic. The string must be double-quoted.\n* **indoor\\_level:`\"\u003cstring\u003e\"`**\n For example: **indoor\\_level:\"1\"**\n Returns beacons which are located on the given indoor level. Accepts\n multiple filters that will be combined with OR logic.\n\nMultiple filters on the same field are combined with OR logic (except\nregistration_time which is combined with AND logic).\nMultiple filters on different fields are combined with AND logic.\nFilters should be separated by spaces.\n\nAs with any HTTP query string parameter, the whole filter expression must\nbe URL-encoded.\n\nExample REST request:\n`GET /v1beta1/beacons?q=status:active%20lat:51.123%20lng:-1.095%20radius:1000`", - "type": "string" - }, "pageSize": { "location": "query", "description": "The maximum number of records to return for this request, up to a\nserver-defined upper limit.", @@ -311,17 +326,31 @@ "type": "integer" }, "projectId": { - "location": "query", "description": "The project id to list beacons under. If not present then the project\ncredential that made the request is used as the project.\nOptional.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "A pagination token obtained from a previous request to list beacons.", "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/userlocation.beacon.registry" + ], "flatPath": "v1beta1/beacons", - "id": "proximitybeacon.beacons.list", "path": "v1beta1/beacons", - "description": "Searches the beacon registry for beacons that match the given search\ncriteria. Only those beacons that the client has permission to list\nwill be returned.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project." + "id": "proximitybeacon.beacons.list" }, "register": { + "flatPath": "v1beta1/beacons:register", + "id": "proximitybeacon.beacons.register", + "path": "v1beta1/beacons:register", + "request": { + "$ref": "Beacon" + }, + "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "httpMethod": "POST", "parameterOrder": [], "response": { @@ -336,21 +365,13 @@ }, "scopes": [ "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], - "flatPath": "v1beta1/beacons:register", - "id": "proximitybeacon.beacons.register", - "path": "v1beta1/beacons:register", - "request": { - "$ref": "Beacon" - }, - "description": "Registers a previously unregistered beacon given its `advertisedId`.\nThese IDs are unique within the system. An ID can be registered only once.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project." + ] } }, "resources": { "diagnostics": { "methods": { "list": { - "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project.", "response": { "$ref": "ListDiagnosticsResponse" }, @@ -360,10 +381,10 @@ "httpMethod": "GET", "parameters": { "pageSize": { + "location": "query", "description": "Specifies the maximum number of results to return. Defaults to\n10. Maximum 1000. Optional.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" }, "alertFilter": { "location": "query", @@ -377,21 +398,21 @@ "type": "string" }, "projectId": { + "location": "query", "description": "Requests only diagnostic records for the given project id. If not set,\nthen the project making the request will be used for looking up\ndiagnostic records. Optional.", - "type": "string", - "location": "query" + "type": "string" }, "beaconName": { - "location": "path", "description": "Beacon that the diagnostics are for.", "required": true, "type": "string", - "pattern": "^beacons/[^/]+$" + "pattern": "^beacons/[^/]+$", + "location": "path" }, "pageToken": { - "location": "query", "description": "Requests results that occur after the `page_token`, obtained from the\nresponse to a previous request. Optional.", - "type": "string" + "type": "string", + "location": "query" } }, "scopes": [ @@ -399,32 +420,34 @@ ], "flatPath": "v1beta1/beacons/{beaconsId}/diagnostics", "path": "v1beta1/{+beaconName}/diagnostics", - "id": "proximitybeacon.beacons.diagnostics.list" + "id": "proximitybeacon.beacons.diagnostics.list", + "description": "List the diagnostics for a single beacon. You can also list diagnostics for\nall the beacons owned by your Google Developers Console project by using\nthe beacon name `beacons/-`.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project." } } }, "attachments": { "methods": { "delete": { + "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "httpMethod": "DELETE", - "parameterOrder": [ - "attachmentName" - ], "response": { "$ref": "Empty" }, + "parameterOrder": [ + "attachmentName" + ], "parameters": { - "projectId": { - "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.", - "type": "string", - "location": "query" - }, "attachmentName": { - "location": "path", "description": "The attachment name (`attachmentName`) of\nthe attachment to remove. For example:\n`beacons/3!893737abc9/attachments/c5e937-af0-494-959-ec49d12738`. For\nEddystone-EID beacons, the beacon ID portion (`3!893737abc9`) may be the\nbeacon's current EID, or its \"stable\" Eddystone-UID.\nRequired.", "required": true, "type": "string", - "pattern": "^beacons/[^/]+/attachments/[^/]+$" + "pattern": "^beacons/[^/]+/attachments/[^/]+$", + "location": "path" + }, + "projectId": { + "location": "query", + "description": "The project id of the attachment to delete. If not provided, the project\nthat is making the request is used.\nOptional.", + "type": "string" } }, "scopes": [ @@ -432,22 +455,21 @@ ], "flatPath": "v1beta1/beacons/{beaconsId}/attachments/{attachmentsId}", "id": "proximitybeacon.beacons.attachments.delete", - "path": "v1beta1/{+attachmentName}", - "description": "Deletes the specified attachment for the given beacon. Each attachment has\na unique attachment name (`attachmentName`) which is returned when you\nfetch the attachment data via this API. You specify this with the delete\nrequest to control which attachment is removed. This operation cannot be\nundone.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project." + "path": "v1beta1/{+attachmentName}" }, "list": { - "httpMethod": "GET", "response": { "$ref": "ListBeaconAttachmentsResponse" }, "parameterOrder": [ "beaconName" ], + "httpMethod": "GET", "parameters": { "projectId": { + "location": "query", "description": "The project id to list beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.", - "type": "string", - "location": "query" + "type": "string" }, "namespacedType": { "description": "Specifies the namespace and type of attachment to include in response in\n\u003cvar\u003enamespace/type\u003c/var\u003e format. Accepts `*/*` to specify\n\"all types in all namespaces\".", @@ -455,55 +477,58 @@ "location": "query" }, "beaconName": { - "location": "path", "description": "Beacon whose attachments should be fetched. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", "required": true, "type": "string", - "pattern": "^beacons/[^/]+$" + "pattern": "^beacons/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/userlocation.beacon.registry" ], "flatPath": "v1beta1/beacons/{beaconsId}/attachments", - "id": "proximitybeacon.beacons.attachments.list", "path": "v1beta1/{+beaconName}/attachments", + "id": "proximitybeacon.beacons.attachments.list", "description": "Returns the attachments for the specified beacon that match the specified\nnamespaced-type pattern.\n\nTo control which namespaced types are returned, you add the\n`namespacedType` query parameter to the request. You must either use\n`*/*`, to return all attachments, or the namespace must be one of\nthe ones returned from the `namespaces` endpoint.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **viewer**, **Is owner** or **Can edit**\npermissions in the Google Developers Console project." }, "create": { "flatPath": "v1beta1/beacons/{beaconsId}/attachments", - "path": "v1beta1/{+beaconName}/attachments", "id": "proximitybeacon.beacons.attachments.create", - "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", + "path": "v1beta1/{+beaconName}/attachments", "request": { "$ref": "BeaconAttachment" }, - "response": { - "$ref": "BeaconAttachment" - }, + "description": "Associates the given data with the specified beacon. Attachment data must\ncontain two parts:\n\u003cul\u003e\n\u003cli\u003eA namespaced type.\u003c/li\u003e\n\u003cli\u003eThe actual attachment data itself.\u003c/li\u003e\n\u003c/ul\u003e\nThe namespaced type consists of two parts, the namespace and the type.\nThe namespace must be one of the values returned by the `namespaces`\nendpoint, while the type can be a string of any characters except for the\nforward slash (`/`) up to 100 characters in length.\n\nAttachment data can be up to 1024 bytes long.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", + "httpMethod": "POST", "parameterOrder": [ "beaconName" ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/userlocation.beacon.registry" - ], + "response": { + "$ref": "BeaconAttachment" + }, "parameters": { - "projectId": { - "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.", - "type": "string", - "location": "query" - }, "beaconName": { - "location": "path", "description": "Beacon on which the attachment should be created. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", "required": true, "type": "string", - "pattern": "^beacons/[^/]+$" + "pattern": "^beacons/[^/]+$", + "location": "path" + }, + "projectId": { + "location": "query", + "description": "The project id of the project the attachment will belong to. If\nthe project id is not specified then the project making the request\nis used.\nOptional.", + "type": "string" } - } + }, + "scopes": [ + "https://www.googleapis.com/auth/userlocation.beacon.registry" + ] }, "batchDelete": { + "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete", + "path": "v1beta1/{+beaconName}/attachments:batchDelete", + "id": "proximitybeacon.beacons.attachments.batchDelete", "description": "Deletes multiple attachments on a given beacon. This operation is\npermanent and cannot be undone.\n\nYou can optionally specify `namespacedType` to choose which attachments\nshould be deleted. If you do not specify `namespacedType`, all your\nattachments on the given beacon will be deleted. You also may explicitly\nspecify `*/*` to delete all.\n\nAuthenticate using an [OAuth access token](https://developers.google.com/identity/protocols/OAuth2)\nfrom a signed-in user with **Is owner** or **Can edit** permissions in the\nGoogle Developers Console project.", "response": { "$ref": "DeleteAttachmentsResponse" @@ -517,14 +542,14 @@ ], "parameters": { "projectId": { + "location": "query", "description": "The project id to delete beacon attachments under. This field can be\nused when \"*\" is specified to mean all attachment namespaces. Projects\nmay have multiple attachments with multiple namespaces. If \"*\" is\nspecified and the projectId string is empty, then the project\nmaking the request is used.\nOptional.", - "type": "string", - "location": "query" + "type": "string" }, "namespacedType": { + "location": "query", "description": "Specifies the namespace and type of attachments to delete in\n`namespace/type` format. Accepts `*/*` to specify\n\"all types in all namespaces\".\nOptional.", - "type": "string", - "location": "query" + "type": "string" }, "beaconName": { "description": "The beacon whose attachments should be deleted. A beacon name has the\nformat \"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast\nby the beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone-UID, `4` for Eddystone-EID, `1` for iBeacon, or `5`\nfor AltBeacon. For Eddystone-EID beacons, you may use either the\ncurrent EID or the beacon's \"stable\" UID.\nRequired.", @@ -533,10 +558,7 @@ "pattern": "^beacons/[^/]+$", "location": "path" } - }, - "flatPath": "v1beta1/beacons/{beaconsId}/attachments:batchDelete", - "path": "v1beta1/{+beaconName}/attachments:batchDelete", - "id": "proximitybeacon.beacons.attachments.batchDelete" + } } } } @@ -544,36 +566,36 @@ } }, "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.", - "type": "string", - "location": "query" - }, "pp": { "description": "Pretty-print response.", "type": "boolean", "default": "true", "location": "query" }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", + "default": "true" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", "location": "query" }, "fields": { @@ -581,10 +603,10 @@ "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "$.xgafv": { "description": "V1 error format.", @@ -599,12 +621,12 @@ "2" ] }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "alt": { + "enum": [ + "json", + "media", + "proto" + ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", @@ -613,25 +635,141 @@ ], "location": "query", "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" + "default": "json" }, "key": { + "location": "query", "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.", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", "type": "string", "location": "query" } }, "schemas": { + "AttachmentInfo": { + "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.", + "type": "object", + "properties": { + "namespacedType": { + "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e", + "type": "string" + }, + "data": { + "description": "An opaque data container for client-provided data.", + "format": "byte", + "type": "string" + }, + "maxDistanceMeters": { + "description": "The distance away from the beacon at which this attachment should be\ndelivered to a mobile app.\n\nSetting this to a value greater than zero indicates that the app should\nbehave as if the beacon is \"seen\" when the mobile device is less than this\ndistance away from the beacon.\n\nDifferent attachments on the same beacon can have different max distances.\n\nNote that even though this value is expressed with fractional meter\nprecision, real-world behavior is likley to be much less precise than one\nmeter, due to the nature of current Bluetooth radio technology.\n\nOptional. When not set or zero, the attachment should be delivered at the\nbeacon's outer limit of detection.", + "format": "double", + "type": "number" + } + }, + "id": "AttachmentInfo" + }, + "BeaconInfo": { + "description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.", + "type": "object", + "properties": { + "advertisedId": { + "$ref": "AdvertisedId", + "description": "The ID advertised by the beacon." + }, + "attachments": { + "description": "Attachments matching the type(s) requested.\nMay be empty if no attachment types were requested.", + "type": "array", + "items": { + "$ref": "AttachmentInfo" + } + }, + "beaconName": { + "description": "The name under which the beacon is registered.", + "type": "string" + } + }, + "id": "BeaconInfo" + }, + "EphemeralIdRegistrationParams": { + "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.", + "type": "object", + "properties": { + "minRotationPeriodExponent": { + "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", + "format": "uint32", + "type": "integer" + }, + "maxRotationPeriodExponent": { + "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", + "format": "uint32", + "type": "integer" + }, + "serviceEcdhPublicKey": { + "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.", + "format": "byte", + "type": "string" + } + }, + "id": "EphemeralIdRegistrationParams" + }, + "DeleteAttachmentsResponse": { + "description": "Response for a request to delete attachments.", + "type": "object", + "properties": { + "numDeleted": { + "description": "The number of attachments that were deleted.", + "format": "int32", + "type": "integer" + } + }, + "id": "DeleteAttachmentsResponse" + }, + "Observation": { + "description": "Represents one beacon observed once.", + "type": "object", + "properties": { + "telemetry": { + "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.", + "format": "byte", + "type": "string" + }, + "timestampMs": { + "description": "Time when the beacon was observed.", + "format": "google-datetime", + "type": "string" + }, + "advertisedId": { + "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired.", + "$ref": "AdvertisedId" + } + }, + "id": "Observation" + }, + "ListDiagnosticsResponse": { + "description": "Response that contains the requested diagnostics.", + "type": "object", + "properties": { + "diagnostics": { + "description": "The diagnostics matching the given request.", + "type": "array", + "items": { + "$ref": "Diagnostics" + } + }, + "nextPageToken": { + "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.", + "type": "string" + } + }, + "id": "ListDiagnosticsResponse" + }, "GetInfoForObservedBeaconsResponse": { "description": "Information about the requested beacons, optionally including attachment\ndata.", "type": "object", @@ -650,23 +788,6 @@ "description": "Details of a beacon device.", "type": "object", "properties": { - "advertisedId": { - "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.", - "$ref": "AdvertisedId" - }, - "provisioningKey": { - "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.", - "format": "byte", - "type": "string" - }, - "ephemeralIdRegistration": { - "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.", - "$ref": "EphemeralIdRegistration" - }, - "latLng": { - "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional.", - "$ref": "LatLng" - }, "description": { "description": "Free text used to identify and describe the beacon. Maximum length 140\ncharacters.\nOptional.", "type": "string" @@ -675,6 +796,10 @@ "description": "The [Google Places API](/places/place-id) Place ID of the place where\nthe beacon is deployed. This is given when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.", "type": "string" }, + "latLng": { + "$ref": "LatLng", + "description": "The location of the beacon, expressed as a latitude and longitude pair.\nThis location is given when the beacon is registered or updated. It does\nnot necessarily indicate the actual current location of the beacon.\nOptional." + }, "properties": { "additionalProperties": { "type": "string" @@ -699,14 +824,16 @@ ] }, "indoorLevel": { - "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional.", - "$ref": "IndoorLevel" + "$ref": "IndoorLevel", + "description": "The indoor level information for this beacon, if known. As returned by the\nGoogle Maps API.\nOptional." }, "beaconName": { "description": "Resource name of this beacon. A beacon name has the format\n\"beacons/N!beaconId\" where the beaconId is the base16 ID broadcast by\nthe beacon and N is a code for the beacon's type. Possible values are\n`3` for Eddystone, `1` for iBeacon, or `5` for AltBeacon.\n\nThis field must be left empty when registering. After reading a beacon,\nclients can use the name for future operations.", "type": "string" }, "expectedStability": { + "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.", + "type": "string", "enumDescriptions": [ "Do not use this value.", "Not expected to move, for example a store's front door.", @@ -720,8 +847,19 @@ "PORTABLE", "MOBILE", "ROVING" - ], - "description": "Expected location stability. This is set when the beacon is registered or\nupdated, not automatically detected in any way.\nOptional.", + ] + }, + "advertisedId": { + "description": "The identifier of a beacon as advertised by it. This field must be\npopulated when registering. It may be empty when updating a beacon\nrecord because it is ignored in updates.\n\nWhen registering a beacon that broadcasts Eddystone-EID, this field\nshould contain a \"stable\" Eddystone-UID that identifies the beacon and\nlinks it to its attachments. The stable Eddystone-UID is only used for\nadministering the beacon.", + "$ref": "AdvertisedId" + }, + "ephemeralIdRegistration": { + "description": "Write-only registration parameters for beacons using Eddystone-EID\n(remotely resolved ephemeral ID) format. This information will not be\npopulated in API responses. When submitting this data, the `advertised_id`\nfield must contain an ID of type Eddystone-UID. Any other ID type will\nresult in an error.", + "$ref": "EphemeralIdRegistration" + }, + "provisioningKey": { + "description": "Some beacons may require a user to provide an authorization key before\nchanging any of its configuration (e.g. broadcast frames, transmit power).\nThis field provides a place to store and control access to that key.\nThis field is populated in responses to `GET /v1beta1/beacons/3!beaconId`\nfrom users with write access to the given beacon. That is to say: If the\nuser is authorized to write the beacon's confidential data in the service,\nthe service considers them authorized to configure the beacon. Note\nthat this key grants nothing on the service, only on the beacon itself.", + "format": "byte", "type": "string" } }, @@ -831,36 +969,42 @@ "description": "Diagnostics for a single beacon.", "type": "object", "properties": { + "beaconName": { + "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.", + "type": "string" + }, "alerts": { - "enumDescriptions": [ - "Invalid value. Should never appear.", - "The beacon has been reported far from its expected location (the beacon's\nlat_lng field if populated, otherwise, if the beacon's place_id field is\npresent, the center of that place). This may indicate that the beacon has\nbeen moved. This signal is not 100% accurate, but indicates that further\ninvestigation is worthwhile.", - "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon.", - "The beacon has been reported at a very low rate or not at all. This may\nindicate that the beacon is broken or just that no one has gone near the\nbeacon in recent days. If this status appears unexpectedly, the beacon\nowner should investigate further." - ], "description": "An unordered list of Alerts that the beacon has.", "type": "array", "items": { + "type": "string", "enum": [ "ALERT_UNSPECIFIED", "WRONG_LOCATION", "LOW_BATTERY", "LOW_ACTIVITY" - ], - "type": "string" - } + ] + }, + "enumDescriptions": [ + "Invalid value. Should never appear.", + "The beacon has been reported far from its expected location (the beacon's\nlat_lng field if populated, otherwise, if the beacon's place_id field is\npresent, the center of that place). This may indicate that the beacon has\nbeen moved. This signal is not 100% accurate, but indicates that further\ninvestigation is worthwhile.", + "The battery level for the beacon is low enough that, given the beacon's\ncurrent use, its battery will run out with in the next 60 days. This\nindicates that the battery should be replaced soon.", + "The beacon has been reported at a very low rate or not at all. This may\nindicate that the beacon is broken or just that no one has gone near the\nbeacon in recent days. If this status appears unexpectedly, the beacon\nowner should investigate further." + ] }, "estimatedLowBatteryDate": { - "$ref": "Date", - "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date." - }, - "beaconName": { - "description": "Resource name of the beacon. For Eddystone-EID beacons, this may\nbe the beacon's current EID, or the beacon's \"stable\" Eddystone-UID.", - "type": "string" + "description": "The date when the battery is expected to be low. If the value is missing\nthen there is no estimate for when the battery will be low.\nThis value is only an estimate, not an exact date.", + "$ref": "Date" } }, "id": "Diagnostics" }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, "GetInfoForObservedBeaconsRequest": { "description": "Request for beacon and attachment information about beacons that\na mobile client has encountered \"in the wild\".", "type": "object", @@ -882,16 +1026,20 @@ }, "id": "GetInfoForObservedBeaconsRequest" }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, "BeaconAttachment": { "description": "Project-specific data associated with a beacon.", "type": "object", "properties": { + "creationTimeMs": { + "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.", + "format": "google-datetime", + "type": "string" + }, + "maxDistanceMeters": { + "description": "The distance away from the beacon at which this attachment should be\ndelivered to a mobile app.\n\nSetting this to a value greater than zero indicates that the app should\nbehave as if the beacon is \"seen\" when the mobile device is less than this\ndistance away from the beacon.\n\nDifferent attachments on the same beacon can have different max distances.\n\nNote that even though this value is expressed with fractional meter\nprecision, real-world behavior is likley to be much less precise than one\nmeter, due to the nature of current Bluetooth radio technology.\n\nOptional. When not set or zero, the attachment should be delivered at the\nbeacon's outer limit of detection.\n\nNegative values are invalid and return an error.", + "format": "double", + "type": "number" + }, "attachmentName": { "description": "Resource name of this attachment. Attachment names have the format:\n\u003ccode\u003ebeacons/\u003cvar\u003ebeacon_id\u003c/var\u003e/attachments/\u003cvar\u003eattachment_id\u003c/var\u003e\u003c/code\u003e.\nLeave this empty on creation.", "type": "string" @@ -904,16 +1052,6 @@ "description": "An opaque data container for client-provided data. Must be\n[base64](http://tools.ietf.org/html/rfc4648#section-4) encoded in HTTP\nrequests, and will be so encoded (with padding) in responses.\nRequired.", "format": "byte", "type": "string" - }, - "creationTimeMs": { - "description": "The UTC time when this attachment was created, in milliseconds since the\nUNIX epoch.", - "format": "google-datetime", - "type": "string" - }, - "maxDistanceMeters": { - "description": "The distance away from the beacon at which this attachment should be\ndelivered to a mobile app.\n\nSetting this to a value greater than zero indicates that the app should\nbehave as if the beacon is \"seen\" when the mobile device is less than this\ndistance away from the beacon.\n\nDifferent attachments on the same beacon can have different max distances.\n\nNote that even though this value is expressed with fractional meter\nprecision, real-world behavior is likley to be much less precise than one\nmeter, due to the nature of current Bluetooth radio technology.\n\nOptional. When not set or zero, the attachment should be delivered at the\nbeacon's outer limit of detection.\n\nNegative values are invalid and return an error.", - "format": "double", - "type": "number" } }, "id": "BeaconAttachment" @@ -922,11 +1060,6 @@ "description": "Write-only registration parameters for beacons using Eddystone-EID format.\nTwo ways of securely registering an Eddystone-EID beacon with the service\nare supported:\n\n1. Perform an ECDH key exchange via this API, including a previous call\n to `GET /v1beta1/eidparams`. In this case the fields\n `beacon_ecdh_public_key` and `service_ecdh_public_key` should be\n populated and `beacon_identity_key` should not be populated. This\n method ensures that only the two parties in the ECDH key exchange can\n compute the identity key, which becomes a secret between them.\n2. Derive or obtain the beacon's identity key via other secure means\n (perhaps an ECDH key exchange between the beacon and a mobile device\n or any other secure method), and then submit the resulting identity key\n to the service. In this case `beacon_identity_key` field should be\n populated, and neither of `beacon_ecdh_public_key` nor\n `service_ecdh_public_key` fields should be. The security of this method\n depends on how securely the parties involved (in particular the\n bluetooth client) handle the identity key, and obviously on how\n securely the identity key was generated.\n\nSee [the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.", "type": "object", "properties": { - "rotationPeriodExponent": { - "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.", - "format": "uint32", - "type": "integer" - }, "serviceEcdhPublicKey": { "description": "The service's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `beacon_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", "format": "byte", @@ -942,15 +1075,20 @@ "format": "byte", "type": "string" }, + "initialClockValue": { + "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.", + "format": "uint64", + "type": "string" + }, "beaconEcdhPublicKey": { "description": "The beacon's public key used for the Elliptic curve Diffie-Hellman\nkey exchange. When this field is populated, `service_ecdh_public_key`\nmust also be populated, and `beacon_identity_key` must not be.", "format": "byte", "type": "string" }, - "initialClockValue": { - "description": "The initial clock value of the beacon. The beacon's clock must have\nbegun counting at this value immediately prior to transmitting this\nvalue to the resolving service. Significant delay in transmitting this\nvalue to the service risks registration or resolution failures. If a\nvalue is not provided, the default is zero.", - "format": "uint64", - "type": "string" + "rotationPeriodExponent": { + "description": "Indicates the nominal period between each rotation of the beacon's\nephemeral ID. \"Nominal\" because the beacon should randomize the\nactual interval. See [the spec at github](https://github.com/google/eddystone/tree/master/eddystone-eid)\nfor details. This value corresponds to a power-of-two scaler on the\nbeacon's clock: when the scaler value is K, the beacon will begin\nbroadcasting a new ephemeral ID on average every 2^K seconds.", + "format": "uint32", + "type": "integer" } }, "id": "EphemeralIdRegistration" @@ -995,8 +1133,6 @@ "type": "string" }, "servingVisibility": { - "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.", - "type": "string", "enumDescriptions": [ "Do not use this value.", "Served only to the project that owns the namespace.", @@ -1006,126 +1142,12 @@ "VISIBILITY_UNSPECIFIED", "UNLISTED", "PUBLIC" - ] + ], + "description": "Specifies what clients may receive attachments under this namespace\nvia `beaconinfo.getforobserved`.", + "type": "string" } }, "id": "Namespace" - }, - "BeaconInfo": { - "description": "A subset of beacon information served via the `beaconinfo.getforobserved`\nmethod, which you call when users of your app encounter your beacons.", - "type": "object", - "properties": { - "advertisedId": { - "$ref": "AdvertisedId", - "description": "The ID advertised by the beacon." - }, - "attachments": { - "description": "Attachments matching the type(s) requested.\nMay be empty if no attachment types were requested.", - "type": "array", - "items": { - "$ref": "AttachmentInfo" - } - }, - "beaconName": { - "description": "The name under which the beacon is registered.", - "type": "string" - } - }, - "id": "BeaconInfo" - }, - "AttachmentInfo": { - "description": "A subset of attachment information served via the\n`beaconinfo.getforobserved` method, used when your users encounter your\nbeacons.", - "type": "object", - "properties": { - "namespacedType": { - "description": "Specifies what kind of attachment this is. Tells a client how to\ninterpret the `data` field. Format is \u003cvar\u003enamespace/type\u003c/var\u003e, for\nexample \u003ccode\u003escrupulous-wombat-12345/welcome-message\u003c/code\u003e", - "type": "string" - }, - "data": { - "description": "An opaque data container for client-provided data.", - "format": "byte", - "type": "string" - }, - "maxDistanceMeters": { - "description": "The distance away from the beacon at which this attachment should be\ndelivered to a mobile app.\n\nSetting this to a value greater than zero indicates that the app should\nbehave as if the beacon is \"seen\" when the mobile device is less than this\ndistance away from the beacon.\n\nDifferent attachments on the same beacon can have different max distances.\n\nNote that even though this value is expressed with fractional meter\nprecision, real-world behavior is likley to be much less precise than one\nmeter, due to the nature of current Bluetooth radio technology.\n\nOptional. When not set or zero, the attachment should be delivered at the\nbeacon's outer limit of detection.", - "format": "double", - "type": "number" - } - }, - "id": "AttachmentInfo" - }, - "DeleteAttachmentsResponse": { - "description": "Response for a request to delete attachments.", - "type": "object", - "properties": { - "numDeleted": { - "description": "The number of attachments that were deleted.", - "format": "int32", - "type": "integer" - } - }, - "id": "DeleteAttachmentsResponse" - }, - "EphemeralIdRegistrationParams": { - "description": "Information a client needs to provision and register beacons that\nbroadcast Eddystone-EID format beacon IDs, using Elliptic curve\nDiffie-Hellman key exchange. See\n[the Eddystone specification](https://github.com/google/eddystone/tree/master/eddystone-eid) at GitHub.", - "type": "object", - "properties": { - "minRotationPeriodExponent": { - "description": "Indicates the minimum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", - "format": "uint32", - "type": "integer" - }, - "maxRotationPeriodExponent": { - "description": "Indicates the maximum rotation period supported by the service.\nSee EddystoneEidRegistration.rotation_period_exponent", - "format": "uint32", - "type": "integer" - }, - "serviceEcdhPublicKey": { - "description": "The beacon service's public key for use by a beacon to derive its\nIdentity Key using Elliptic Curve Diffie-Hellman key exchange.", - "format": "byte", - "type": "string" - } - }, - "id": "EphemeralIdRegistrationParams" - }, - "Observation": { - "description": "Represents one beacon observed once.", - "type": "object", - "properties": { - "advertisedId": { - "$ref": "AdvertisedId", - "description": "The ID advertised by the beacon the client has encountered.\n\nIf the submitted `advertised_id` type is Eddystone-EID, then the client\nmust be authorized to resolve the given beacon. Otherwise no data will be\nreturned for that beacon.\nRequired." - }, - "telemetry": { - "description": "The array of telemetry bytes received from the beacon. The server is\nresponsible for parsing it. This field may frequently be empty, as\nwith a beacon that transmits telemetry only occasionally.", - "format": "byte", - "type": "string" - }, - "timestampMs": { - "description": "Time when the beacon was observed.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "Observation" - }, - "ListDiagnosticsResponse": { - "description": "Response that contains the requested diagnostics.", - "type": "object", - "properties": { - "diagnostics": { - "description": "The diagnostics matching the given request.", - "type": "array", - "items": { - "$ref": "Diagnostics" - } - }, - "nextPageToken": { - "description": "Token that can be used for pagination. Returned only if the\nrequest matches more beacons than can be returned in this response.", - "type": "string" - } - }, - "id": "ListDiagnosticsResponse" } }, "icons": { @@ -1133,27 +1155,5 @@ "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", - "version": "v1beta1", - "baseUrl": "https://proximitybeacon.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/userlocation.beacon.registry": { - "description": "View and modify your beacons" - } - } - } - }, - "servicePath": "", - "description": "Registers, manages, indexes, and searches beacons.", - "kind": "discovery#restDescription", - "rootUrl": "https://proximitybeacon.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "proximitybeacon", - "batchPath": "batch", - "revision": "20171112", - "documentationLink": "https://developers.google.com/beacons/proximity/", - "id": "proximitybeacon:v1beta1", - "title": "Google Proximity Beacon API" + "version": "v1beta1" }
diff --git a/pubsub/v1/pubsub-api.json b/pubsub/v1/pubsub-api.json index 3d9c8a6..c465624 100644 --- a/pubsub/v1/pubsub-api.json +++ b/pubsub/v1/pubsub-api.json
@@ -1,31 +1,4 @@ { - "version": "v1", - "baseUrl": "https://pubsub.googleapis.com/", - "canonicalName": "Pubsub", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/pubsub": { - "description": "View and manage Pub/Sub topics and subscriptions" - } - } - } - }, - "kind": "discovery#restDescription", - "servicePath": "", - "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n", - "rootUrl": "https://pubsub.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "pubsub", - "batchPath": "batch", - "revision": "20171220", - "documentationLink": "https://cloud.google.com/pubsub/docs", - "id": "pubsub:v1", - "title": "Google Cloud Pub/Sub API", "discoveryVersion": "v1", "ownerName": "Google", "resources": { @@ -33,90 +6,6 @@ "resources": { "subscriptions": { "methods": { - "acknowledge": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "subscription" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": { - "subscription": { - "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge", - "path": "v1/{+subscription}:acknowledge", - "id": "pubsub.projects.subscriptions.acknowledge", - "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.", - "request": { - "$ref": "AcknowledgeRequest" - } - }, - "get": { - "response": { - "$ref": "Subscription" - }, - "parameterOrder": [ - "subscription" - ], - "httpMethod": "GET", - "parameters": { - "subscription": { - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path", - "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}", - "path": "v1/{+subscription}", - "id": "pubsub.projects.subscriptions.get", - "description": "Gets the configuration details of a subscription." - }, - "patch": { - "description": "Updates an existing subscription. Note that certain properties of a\nsubscription, such as its topic, are not modifiable.", - "request": { - "$ref": "UpdateSubscriptionRequest" - }, - "response": { - "$ref": "Subscription" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": { - "name": { - "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}", - "path": "v1/{+name}", - "id": "pubsub.projects.subscriptions.patch" - }, "testIamPermissions": { "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "request": { @@ -135,11 +24,11 @@ ], "parameters": { "resource": { + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path", "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" + "type": "string" } }, "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions", @@ -147,6 +36,12 @@ "id": "pubsub.projects.subscriptions.testIamPermissions" }, "modifyPushConfig": { + "path": "v1/{+subscription}:modifyPushConfig", + "id": "pubsub.projects.subscriptions.modifyPushConfig", + "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.", + "request": { + "$ref": "ModifyPushConfigRequest" + }, "response": { "$ref": "Empty" }, @@ -154,35 +49,35 @@ "subscription" ], "httpMethod": "POST", - "parameters": { - "subscription": { - "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig", - "path": "v1/{+subscription}:modifyPushConfig", - "id": "pubsub.projects.subscriptions.modifyPushConfig", - "request": { - "$ref": "ModifyPushConfigRequest" + "parameters": { + "subscription": { + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path", + "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", + "required": true, + "type": "string" + } }, - "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`." + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig" }, "seek": { - "httpMethod": "POST", - "parameterOrder": [ - "subscription" - ], + "path": "v1/{+subscription}:seek", + "id": "pubsub.projects.subscriptions.seek", + "request": { + "$ref": "SeekRequest" + }, + "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request.", "response": { "$ref": "SeekResponse" }, + "parameterOrder": [ + "subscription" + ], + "httpMethod": "POST", "parameters": { "subscription": { "description": "The subscription to affect.", @@ -196,23 +91,19 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:seek", - "id": "pubsub.projects.subscriptions.seek", - "path": "v1/{+subscription}:seek", - "request": { - "$ref": "SeekRequest" - }, - "description": "Seeks an existing subscription to a point in time or to a given snapshot,\nwhichever is provided in the request." + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:seek" }, "delete": { + "id": "pubsub.projects.subscriptions.delete", + "path": "v1/{+subscription}", "description": "Deletes an existing subscription. All messages retained in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription or its topic unless the same topic is specified.", "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, "parameterOrder": [ "subscription" ], + "response": { + "$ref": "Empty" + }, "parameters": { "subscription": { "pattern": "^projects/[^/]+/subscriptions/[^/]+$", @@ -226,24 +117,22 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}", - "id": "pubsub.projects.subscriptions.delete", - "path": "v1/{+subscription}" + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}" }, "setIamPolicy": { - "path": "v1/{+resource}:setIamPolicy", "id": "pubsub.projects.subscriptions.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", - "response": { - "$ref": "Policy" - }, + "httpMethod": "POST", "parameterOrder": [ "resource" ], - "httpMethod": "POST", + "response": { + "$ref": "Policy" + }, "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", @@ -260,48 +149,18 @@ "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy" }, "modifyAckDeadline": { - "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.", - "request": { - "$ref": "ModifyAckDeadlineRequest" - }, - "response": { - "$ref": "Empty" - }, + "httpMethod": "POST", "parameterOrder": [ "subscription" ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], + "response": { + "$ref": "Empty" + }, "parameters": { "subscription": { - "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline", - "path": "v1/{+subscription}:modifyAckDeadline", - "id": "pubsub.projects.subscriptions.modifyAckDeadline" - }, - "getIamPolicy": { - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "GET", - "parameters": { - "resource": { "pattern": "^projects/[^/]+/subscriptions/[^/]+$", "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "The name of the subscription.\nFormat is `projects/{project}/subscriptions/{sub}`.", "required": true, "type": "string" } @@ -310,17 +169,41 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline", + "id": "pubsub.projects.subscriptions.modifyAckDeadline", + "path": "v1/{+subscription}:modifyAckDeadline", + "request": { + "$ref": "ModifyAckDeadlineRequest" + }, + "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages." + }, + "getIamPolicy": { + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path" + } + }, "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy", "path": "v1/{+resource}:getIamPolicy", - "id": "pubsub.projects.subscriptions.getIamPolicy" + "id": "pubsub.projects.subscriptions.getIamPolicy", + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." }, "pull": { - "path": "v1/{+subscription}:pull", - "id": "pubsub.projects.subscriptions.pull", - "request": { - "$ref": "PullRequest" - }, - "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.", "response": { "$ref": "PullResponse" }, @@ -341,11 +224,15 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull" + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:pull", + "path": "v1/{+subscription}:pull", + "id": "pubsub.projects.subscriptions.pull", + "request": { + "$ref": "PullRequest" + }, + "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription." }, "list": { - "id": "pubsub.projects.subscriptions.list", - "path": "v1/{+project}/subscriptions", "description": "Lists matching subscriptions.", "httpMethod": "GET", "response": { @@ -361,10 +248,10 @@ "location": "query" }, "pageSize": { + "location": "query", "description": "Maximum number of subscriptions to return.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" }, "project": { "pattern": "^projects/[^/]+$", @@ -378,15 +265,11 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/subscriptions" + "flatPath": "v1/projects/{projectsId}/subscriptions", + "id": "pubsub.projects.subscriptions.list", + "path": "v1/{+project}/subscriptions" }, "create": { - "path": "v1/{+name}", - "id": "pubsub.projects.subscriptions.create", - "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request.", - "request": { - "$ref": "Subscription" - }, "response": { "$ref": "Subscription" }, @@ -394,10 +277,90 @@ "name" ], "httpMethod": "PUT", + "parameters": { + "name": { + "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}", + "path": "v1/{+name}", + "id": "pubsub.projects.subscriptions.create", + "request": { + "$ref": "Subscription" + }, + "description": "Creates a subscription to a given topic.\nIf the subscription already exists, returns `ALREADY_EXISTS`.\nIf the corresponding topic doesn't exist, returns `NOT_FOUND`.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic, conforming\nto the\n[resource name format](https://cloud.google.com/pubsub/docs/overview#names).\nThe generated name is populated in the returned Subscription object.\nNote that for REST API requests, you must specify a name in the request." + }, + "acknowledge": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "subscription" + ], + "httpMethod": "POST", + "parameters": { + "subscription": { + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path", + "description": "The subscription whose message is being acknowledged.\nFormat is `projects/{project}/subscriptions/{sub}`.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge", + "path": "v1/{+subscription}:acknowledge", + "id": "pubsub.projects.subscriptions.acknowledge", + "request": { + "$ref": "AcknowledgeRequest" + }, + "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error." + }, + "get": { + "response": { + "$ref": "Subscription" + }, + "parameterOrder": [ + "subscription" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "subscription": { + "description": "The name of the subscription to get.\nFormat is `projects/{project}/subscriptions/{sub}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}", + "path": "v1/{+subscription}", + "id": "pubsub.projects.subscriptions.get", + "description": "Gets the configuration details of a subscription." + }, + "patch": { + "response": { + "$ref": "Subscription" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", "parameters": { "name": { "pattern": "^projects/[^/]+/subscriptions/[^/]+$", @@ -407,27 +370,31 @@ "type": "string" } }, - "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1/projects/{projectsId}/subscriptions/{subscriptionsId}", + "path": "v1/{+name}", + "id": "pubsub.projects.subscriptions.patch", + "request": { + "$ref": "UpdateSubscriptionRequest" + }, + "description": "Updates an existing subscription. Note that certain properties of a\nsubscription, such as its topic, are not modifiable." } } }, "snapshots": { "methods": { "delete": { - "path": "v1/{+snapshot}", - "id": "pubsub.projects.snapshots.delete", "description": "Removes an existing snapshot. All messages retained in the snapshot\nare immediately dropped. After a snapshot is deleted, a new one may be\ncreated with the same name, but the new one has no association with the old\nsnapshot or its subscription, unless the same subscription is specified.", - "response": { - "$ref": "Empty" - }, + "httpMethod": "DELETE", "parameterOrder": [ "snapshot" ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], + "response": { + "$ref": "Empty" + }, "parameters": { "snapshot": { "pattern": "^projects/[^/]+/snapshots/[^/]+$", @@ -437,9 +404,18 @@ "type": "string" } }, - "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}", + "id": "pubsub.projects.snapshots.delete", + "path": "v1/{+snapshot}" }, "list": { + "path": "v1/{+project}/snapshots", + "id": "pubsub.projects.snapshots.list", + "description": "Lists the existing snapshots.", "response": { "$ref": "ListSnapshotsResponse" }, @@ -447,10 +423,6 @@ "project" ], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "parameters": { "pageToken": { "location": "query", @@ -471,14 +443,13 @@ "type": "string" } }, - "flatPath": "v1/projects/{projectsId}/snapshots", - "path": "v1/{+project}/snapshots", - "id": "pubsub.projects.snapshots.list", - "description": "Lists the existing snapshots." + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1/projects/{projectsId}/snapshots" }, "setIamPolicy": { - "path": "v1/{+resource}:setIamPolicy", - "id": "pubsub.projects.snapshots.setIamPolicy", "request": { "$ref": "SetIamPolicyRequest" }, @@ -492,73 +463,75 @@ "httpMethod": "POST", "parameters": { "resource": { - "pattern": "^projects/[^/]+/snapshots/[^/]+$", - "location": "path", "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/snapshots/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy" + "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "id": "pubsub.projects.snapshots.setIamPolicy" }, "create": { - "httpMethod": "PUT", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Snapshot" - }, - "parameters": { - "name": { - "pattern": "^projects/[^/]+/snapshots/[^/]+$", - "location": "path", - "description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name.\nFormat is `projects/{project}/snapshots/{snap}`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}", - "id": "pubsub.projects.snapshots.create", "path": "v1/{+name}", + "id": "pubsub.projects.snapshots.create", + "description": "Creates a snapshot from the requested subscription.\nIf the snapshot already exists, returns `ALREADY_EXISTS`.\nIf the requested subscription doesn't exist, returns `NOT_FOUND`.\nIf the backlog in the subscription is too old -- and the resulting snapshot\nwould expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.\nSee also the `Snapshot.expire_time` field.\n\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription, conforming\nto the\n[resource name\nformat](https://cloud.google.com/pubsub/docs/overview#names). The generated\nname is populated in the returned Snapshot object. Note that for REST API\nrequests, you must specify a name in the request.", "request": { "$ref": "CreateSnapshotRequest" }, - "description": "Creates a snapshot from the requested subscription.\nIf the snapshot already exists, returns `ALREADY_EXISTS`.\nIf the requested subscription doesn't exist, returns `NOT_FOUND`.\nIf the backlog in the subscription is too old -- and the resulting snapshot\nwould expire in less than 1 hour -- then `FAILED_PRECONDITION` is returned.\nSee also the `Snapshot.expire_time` field.\n\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription, conforming\nto the\n[resource name\nformat](https://cloud.google.com/pubsub/docs/overview#names). The generated\nname is populated in the returned Snapshot object. Note that for REST API\nrequests, you must specify a name in the request." + "response": { + "$ref": "Snapshot" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "name": { + "description": "Optional user-provided name for this snapshot.\nIf the name is not provided in the request, the server will assign a random\nname for this snapshot on the same project as the subscription.\nNote that for REST API requests, you must specify a name.\nFormat is `projects/{project}/snapshots/{snap}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/snapshots/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}" }, "getIamPolicy": { + "id": "pubsub.projects.snapshots.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "httpMethod": "GET", "response": { "$ref": "Policy" }, "parameterOrder": [ "resource" ], - "httpMethod": "GET", "parameters": { "resource": { - "pattern": "^projects/[^/]+/snapshots/[^/]+$", - "location": "path", "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/snapshots/[^/]+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "pubsub.projects.snapshots.getIamPolicy" + "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:getIamPolicy" }, "patch": { "response": { @@ -597,10 +570,6 @@ "resource" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", @@ -610,53 +579,57 @@ "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "flatPath": "v1/projects/{projectsId}/snapshots/{snapshotsId}:testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "id": "pubsub.projects.snapshots.testIamPermissions", - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "request": { "$ref": "TestIamPermissionsRequest" - } + }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." } } }, "topics": { "methods": { "getIamPolicy": { - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "response": { - "$ref": "Policy" - }, + "httpMethod": "GET", "parameterOrder": [ "resource" ], - "httpMethod": "GET", + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path" - } - }, "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:getIamPolicy", + "id": "pubsub.projects.topics.getIamPolicy", "path": "v1/{+resource}:getIamPolicy", - "id": "pubsub.projects.topics.getIamPolicy" + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." }, "get": { "description": "Gets the configuration of a topic.", - "httpMethod": "GET", "response": { "$ref": "Topic" }, "parameterOrder": [ "topic" ], + "httpMethod": "GET", "parameters": { "topic": { "description": "The name of the topic to get.\nFormat is `projects/{project}/topics/{topic}`.", @@ -671,37 +644,37 @@ "https://www.googleapis.com/auth/pubsub" ], "flatPath": "v1/projects/{projectsId}/topics/{topicsId}", - "id": "pubsub.projects.topics.get", - "path": "v1/{+topic}" + "path": "v1/{+topic}", + "id": "pubsub.projects.topics.get" }, "publish": { - "httpMethod": "POST", - "parameterOrder": [ - "topic" - ], + "path": "v1/{+topic}:publish", + "id": "pubsub.projects.topics.publish", + "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.", + "request": { + "$ref": "PublishRequest" + }, "response": { "$ref": "PublishResponse" }, - "parameters": { - "topic": { - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path", - "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", - "required": true, - "type": "string" - } - }, + "parameterOrder": [ + "topic" + ], + "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish", - "id": "pubsub.projects.topics.publish", - "path": "v1/{+topic}:publish", - "request": { - "$ref": "PublishRequest" + "parameters": { + "topic": { + "description": "The messages in the request will be published on this topic.\nFormat is `projects/{project}/topics/{topic}`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path" + } }, - "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute." + "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:publish" }, "testIamPermissions": { "response": { @@ -711,6 +684,10 @@ "resource" ], "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", @@ -720,33 +697,25 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:testIamPermissions", "path": "v1/{+resource}:testIamPermissions", "id": "pubsub.projects.topics.testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "request": { "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." + } }, "delete": { - "path": "v1/{+topic}", "id": "pubsub.projects.topics.delete", + "path": "v1/{+topic}", "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", - "response": { - "$ref": "Empty" - }, + "httpMethod": "DELETE", "parameterOrder": [ "topic" ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], + "response": { + "$ref": "Empty" + }, "parameters": { "topic": { "description": "Name of the topic to delete.\nFormat is `projects/{project}/topics/{topic}`.", @@ -756,21 +725,28 @@ "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "flatPath": "v1/projects/{projectsId}/topics/{topicsId}" }, "list": { + "id": "pubsub.projects.topics.list", + "path": "v1/{+project}/topics", + "description": "Lists matching topics.", + "httpMethod": "GET", "response": { "$ref": "ListTopicsResponse" }, "parameterOrder": [ "project" ], - "httpMethod": "GET", "parameters": { "pageToken": { - "location": "query", "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", @@ -779,29 +755,20 @@ "type": "integer" }, "project": { + "pattern": "^projects/[^/]+$", + "location": "path", "description": "The name of the cloud project that topics belong to.\nFormat is `projects/{project}`.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1/projects/{projectsId}/topics", - "path": "v1/{+project}/topics", - "id": "pubsub.projects.topics.list", - "description": "Lists matching topics." + "flatPath": "v1/projects/{projectsId}/topics" }, "create": { - "path": "v1/{+name}", - "id": "pubsub.projects.topics.create", - "request": { - "$ref": "Topic" - }, - "description": "Creates the given topic with the given name.", "response": { "$ref": "Topic" }, @@ -809,6 +776,10 @@ "name" ], "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "parameters": { "name": { "pattern": "^projects/[^/]+/topics/[^/]+$", @@ -818,19 +789,21 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1/projects/{projectsId}/topics/{topicsId}" + "flatPath": "v1/projects/{projectsId}/topics/{topicsId}", + "path": "v1/{+name}", + "id": "pubsub.projects.topics.create", + "description": "Creates the given topic with the given name.", + "request": { + "$ref": "Topic" + } }, "setIamPolicy": { "path": "v1/{+resource}:setIamPolicy", "id": "pubsub.projects.topics.setIamPolicy", + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "request": { "$ref": "SetIamPolicyRequest" }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "response": { "$ref": "Policy" }, @@ -838,6 +811,10 @@ "resource" ], "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "parameters": { "resource": { "pattern": "^projects/[^/]+/topics/[^/]+$", @@ -847,10 +824,6 @@ "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "flatPath": "v1/projects/{projectsId}/topics/{topicsId}:setIamPolicy" } }, @@ -858,13 +831,14 @@ "subscriptions": { "methods": { "list": { + "description": "Lists the names of the subscriptions on this topic.", "httpMethod": "GET", - "response": { - "$ref": "ListTopicSubscriptionsResponse" - }, "parameterOrder": [ "topic" ], + "response": { + "$ref": "ListTopicSubscriptionsResponse" + }, "parameters": { "pageToken": { "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.", @@ -891,39 +865,31 @@ ], "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/subscriptions", "id": "pubsub.projects.topics.subscriptions.list", - "path": "v1/{+topic}/subscriptions", - "description": "Lists the names of the subscriptions on this topic." + "path": "v1/{+topic}/subscriptions" } } }, "snapshots": { "methods": { "list": { - "path": "v1/{+topic}/snapshots", - "id": "pubsub.projects.topics.snapshots.list", - "description": "Lists the names of the snapshots on this topic.", - "response": { - "$ref": "ListTopicSnapshotsResponse" - }, + "httpMethod": "GET", "parameterOrder": [ "topic" ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], + "response": { + "$ref": "ListTopicSnapshotsResponse" + }, "parameters": { "pageToken": { + "location": "query", "description": "The value returned by the last `ListTopicSnapshotsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSnapshots` call, and\nthat the system should return the next page of data.", - "type": "string", - "location": "query" + "type": "string" }, "pageSize": { + "location": "query", "description": "Maximum number of snapshot names to return.", "format": "int32", - "type": "integer", - "location": "query" + "type": "integer" }, "topic": { "pattern": "^projects/[^/]+/topics/[^/]+$", @@ -933,7 +899,14 @@ "type": "string" } }, - "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/snapshots" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1/projects/{projectsId}/topics/{topicsId}/snapshots", + "id": "pubsub.projects.topics.snapshots.list", + "path": "v1/{+topic}/snapshots", + "description": "Lists the names of the snapshots on this topic." } } } @@ -943,13 +916,13 @@ } }, "parameters": { - "access_token": { - "description": "OAuth access 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.", "type": "string", "location": "query" }, - "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.", + "access_token": { + "description": "OAuth access token.", "type": "string", "location": "query" }, @@ -975,47 +948,45 @@ "type": "string" }, "upload_protocol": { - "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, "fields": { "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], "location": "query" }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, "alt": { - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -1027,145 +998,13 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], - "location": "query" + "location": "query", + "description": "Data format for response.", + "default": "json" } }, "schemas": { - "SeekResponse": { - "properties": {}, - "id": "SeekResponse", - "type": "object" - }, - "ModifyAckDeadlineRequest": { - "properties": { - "ackDeadlineSeconds": { - "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).", - "format": "int32", - "type": "integer" - }, - "ackIds": { - "description": "List of acknowledgment IDs.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "ModifyAckDeadlineRequest", - "description": "Request for the ModifyAckDeadline method.", - "type": "object" - }, - "Snapshot": { - "description": "A snapshot resource.", - "type": "object", - "properties": { - "expireTime": { - "description": "The snapshot is guaranteed to exist up until this time.\nA newly-created snapshot expires no later than 7 days from the time of its\ncreation. Its exact lifetime is determined at creation by the existing\nbacklog in the source subscription. Specifically, the lifetime of the\nsnapshot is `7 days - (age of oldest unacked message in the subscription)`.\nFor example, consider a subscription whose oldest unacked message is 3 days\nold. If a snapshot is created from this subscription, the snapshot -- which\nwill always capture this 3-day-old backlog as long as the snapshot\nexists -- will expire in 4 days. The service will refuse to create a\nsnapshot that would expire in less than 1 hour after creation.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "The name of the snapshot.", - "type": "string" - }, - "topic": { - "description": "The name of the topic from which this snapshot is retaining messages.", - "type": "string" - } - }, - "id": "Snapshot" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" - } - }, - "id": "SetIamPolicyRequest" - }, - "PubsubMessage": { - "properties": { - "attributes": { - "additionalProperties": { - "type": "string" - }, - "description": "Optional attributes for this message.", - "type": "object" - }, - "messageId": { - "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.", - "type": "string" - }, - "publishTime": { - "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.", - "format": "google-datetime", - "type": "string" - }, - "data": { - "description": "The message payload.", - "format": "byte", - "type": "string" - } - }, - "id": "PubsubMessage", - "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.", - "type": "object" - }, - "ModifyPushConfigRequest": { - "description": "Request for the ModifyPushConfig method.", - "type": "object", - "properties": { - "pushConfig": { - "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` or `StreamingPull` is not called.", - "$ref": "PushConfig" - } - }, - "id": "ModifyPushConfigRequest" - }, - "AcknowledgeRequest": { - "description": "Request for the Acknowledge method.", - "type": "object", - "properties": { - "ackIds": { - "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "AcknowledgeRequest" - }, - "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" - }, - "ListTopicsResponse": { - "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.", - "type": "string" - }, - "topics": { - "description": "The resulting topics.", - "type": "array", - "items": { - "$ref": "Topic" - } - } - }, - "id": "ListTopicsResponse", - "description": "Response for the `ListTopics` method.", - "type": "object" - }, "ListTopicSubscriptionsResponse": { - "description": "Response for the `ListTopicSubscriptions` method.", - "type": "object", "properties": { "nextPageToken": { "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.", @@ -1179,7 +1018,9 @@ } } }, - "id": "ListTopicSubscriptionsResponse" + "id": "ListTopicSubscriptionsResponse", + "description": "Response for the `ListTopicSubscriptions` method.", + "type": "object" }, "PullResponse": { "properties": { @@ -1199,19 +1040,21 @@ "description": "Request for the UpdateSnapshot method.", "type": "object", "properties": { + "snapshot": { + "description": "The updated snpashot object.", + "$ref": "Snapshot" + }, "updateMask": { "description": "Indicates which fields in the provided snapshot to update.\nMust be specified and non-empty.", "format": "google-fieldmask", "type": "string" - }, - "snapshot": { - "$ref": "Snapshot", - "description": "The updated snpashot object." } }, "id": "UpdateSnapshotRequest" }, "ListSnapshotsResponse": { + "description": "Response for the `ListSnapshots` method.", + "type": "object", "properties": { "nextPageToken": { "description": "If not empty, indicates that there may be more snapshot that match the\nrequest; this value should be passed in a new `ListSnapshotsRequest`.", @@ -1225,11 +1068,11 @@ } } }, - "id": "ListSnapshotsResponse", - "description": "Response for the `ListSnapshots` method.", - "type": "object" + "id": "ListSnapshotsResponse" }, "ListSubscriptionsResponse": { + "description": "Response for the `ListSubscriptions` method.", + "type": "object", "properties": { "nextPageToken": { "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.", @@ -1243,20 +1086,18 @@ } } }, - "id": "ListSubscriptionsResponse", - "description": "Response for the `ListSubscriptions` method.", - "type": "object" + "id": "ListSubscriptionsResponse" }, "CreateSnapshotRequest": { + "description": "Request for the `CreateSnapshot` method.", + "type": "object", "properties": { "subscription": { "description": "The subscription whose backlog the snapshot retains.\nSpecifically, the created snapshot is guaranteed to retain:\n (a) The existing backlog on the subscription. More precisely, this is\n defined as the messages in the subscription's backlog that are\n unacknowledged upon the successful completion of the\n `CreateSnapshot` request; as well as:\n (b) Any messages published to the subscription's topic following the\n successful completion of the CreateSnapshot request.\nFormat is `projects/{project}/subscriptions/{sub}`.", "type": "string" } }, - "id": "CreateSnapshotRequest", - "description": "Request for the `CreateSnapshot` method.", - "type": "object" + "id": "CreateSnapshotRequest" }, "ListTopicSnapshotsResponse": { "description": "Response for the `ListTopicSnapshots` method.", @@ -1290,18 +1131,9 @@ "description": "Request message for `TestIamPermissions` method.", "type": "object" }, - "Topic": { - "properties": { - "name": { - "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.", - "type": "string" - } - }, - "id": "Topic", - "description": "A topic resource.", - "type": "object" - }, "Policy": { + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", + "type": "object", "properties": { "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", @@ -1321,13 +1153,20 @@ } } }, - "id": "Policy", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", + "id": "Policy" + }, + "Topic": { + "properties": { + "name": { + "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.", + "type": "string" + } + }, + "id": "Topic", + "description": "A topic resource.", "type": "object" }, "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", "properties": { "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -1341,11 +1180,11 @@ "type": "string" } }, - "id": "Binding" + "id": "Binding", + "description": "Associates `members` with a `role`.", + "type": "object" }, "SeekRequest": { - "description": "Request for the `Seek` method.", - "type": "object", "properties": { "time": { "description": "The time to seek to.\nMessages retained in the subscription that were published before this\ntime are marked as acknowledged, and messages retained in the\nsubscription that were published after this time are marked as\nunacknowledged. Note that this operation affects only those messages\nretained in the subscription (configured by the combination of\n`message_retention_duration` and `retain_acked_messages`). For example,\nif `time` corresponds to a point before the message retention\nwindow (or to a point before the system's notion of the subscription\ncreation time), only retained messages will be marked as unacknowledged,\nand already-expunged messages will not be restored.", @@ -1357,13 +1196,15 @@ "type": "string" } }, - "id": "SeekRequest" + "id": "SeekRequest", + "description": "Request for the `Seek` method.", + "type": "object" }, "ReceivedMessage": { "properties": { "message": { - "$ref": "PubsubMessage", - "description": "The message." + "description": "The message.", + "$ref": "PubsubMessage" }, "ackId": { "description": "This ID can be used to acknowledge the received message.", @@ -1410,19 +1251,21 @@ "description": "Request for the `Pull` method.", "type": "object", "properties": { + "returnImmediately": { + "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.", + "type": "boolean" + }, "maxMessages": { "description": "The maximum number of messages returned for this request. The Pub/Sub\nsystem may return fewer than the number specified.", "format": "int32", "type": "integer" - }, - "returnImmediately": { - "description": "If this field set to true, the system will respond immediately even if\nit there are no messages available to return in the `Pull` response.\nOtherwise, the system may wait (for a bounded amount of time) until at\nleast one message is available, rather than returning no messages. The\nclient may cancel the request if it does not wish to wait any longer for\nthe response.", - "type": "boolean" } }, "id": "PullRequest" }, "PublishRequest": { + "description": "Request for the Publish method.", + "type": "object", "properties": { "messages": { "description": "The messages to publish.", @@ -1432,13 +1275,9 @@ } } }, - "id": "PublishRequest", - "description": "Request for the Publish method.", - "type": "object" + "id": "PublishRequest" }, "UpdateSubscriptionRequest": { - "description": "Request for the UpdateSubscription method.", - "type": "object", "properties": { "subscription": { "description": "The updated subscription object.", @@ -1450,7 +1289,9 @@ "type": "string" } }, - "id": "UpdateSubscriptionRequest" + "id": "UpdateSubscriptionRequest", + "description": "Request for the UpdateSubscription method.", + "type": "object" }, "PublishResponse": { "description": "Response for the `Publish` method.", @@ -1467,21 +1308,7 @@ "id": "PublishResponse" }, "Subscription": { - "description": "A subscription resource.", - "type": "object", "properties": { - "name": { - "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", - "type": "string" - }, - "topic": { - "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.", - "type": "string" - }, - "pushConfig": { - "$ref": "PushConfig", - "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods." - }, "ackDeadlineSeconds": { "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using\nnon-streaming pull or send the `ack_id` in a\n`StreamingModifyAckDeadlineRequest` if using streaming pull.\nThe minimum custom deadline you can specify is 10 seconds.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\nIf this parameter is 0, a default value of 10 seconds is used.\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.", "format": "int32", @@ -1495,14 +1322,187 @@ "retainAckedMessages": { "description": "Indicates whether to retain acknowledged messages. If true, then\nmessages are not expunged from the subscription's backlog, even if they are\nacknowledged, until they fall out of the `message_retention_duration`\nwindow.", "type": "boolean" + }, + "name": { + "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", + "type": "string" + }, + "topic": { + "description": "The name of the topic from which this subscription is receiving messages.\nFormat is `projects/{project}/topics/{topic}`.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.", + "type": "string" + }, + "pushConfig": { + "$ref": "PushConfig", + "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods." } }, - "id": "Subscription" + "id": "Subscription", + "description": "A subscription resource.", + "type": "object" + }, + "SeekResponse": { + "properties": {}, + "id": "SeekResponse", + "type": "object" + }, + "ModifyAckDeadlineRequest": { + "properties": { + "ackDeadlineSeconds": { + "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.\nThe minimum deadline you can specify is 0 seconds.\nThe maximum deadline you can specify is 600 seconds (10 minutes).", + "format": "int32", + "type": "integer" + }, + "ackIds": { + "description": "List of acknowledgment IDs.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "ModifyAckDeadlineRequest", + "description": "Request for the ModifyAckDeadline method.", + "type": "object" + }, + "Snapshot": { + "properties": { + "expireTime": { + "description": "The snapshot is guaranteed to exist up until this time.\nA newly-created snapshot expires no later than 7 days from the time of its\ncreation. Its exact lifetime is determined at creation by the existing\nbacklog in the source subscription. Specifically, the lifetime of the\nsnapshot is `7 days - (age of oldest unacked message in the subscription)`.\nFor example, consider a subscription whose oldest unacked message is 3 days\nold. If a snapshot is created from this subscription, the snapshot -- which\nwill always capture this 3-day-old backlog as long as the snapshot\nexists -- will expire in 4 days. The service will refuse to create a\nsnapshot that would expire in less than 1 hour after creation.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the snapshot.", + "type": "string" + }, + "topic": { + "description": "The name of the topic from which this snapshot is retaining messages.", + "type": "string" + } + }, + "id": "Snapshot", + "description": "A snapshot resource.", + "type": "object" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest" + }, + "ModifyPushConfigRequest": { + "properties": { + "pushConfig": { + "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` or `StreamingPull` is not called.", + "$ref": "PushConfig" + } + }, + "id": "ModifyPushConfigRequest", + "description": "Request for the ModifyPushConfig method.", + "type": "object" + }, + "PubsubMessage": { + "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.", + "type": "object", + "properties": { + "data": { + "description": "The message payload.", + "format": "byte", + "type": "string" + }, + "attributes": { + "additionalProperties": { + "type": "string" + }, + "description": "Optional attributes for this message.", + "type": "object" + }, + "messageId": { + "description": "ID of this message, assigned by the server when the message is published.\nGuaranteed to be unique within the topic. This value may be read by a\nsubscriber that receives a `PubsubMessage` via a `Pull` call or a push\ndelivery. It must not be populated by the publisher in a `Publish` call.", + "type": "string" + }, + "publishTime": { + "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "PubsubMessage" + }, + "AcknowledgeRequest": { + "properties": { + "ackIds": { + "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "AcknowledgeRequest", + "description": "Request for the Acknowledge method.", + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "ListTopicsResponse": { + "description": "Response for the `ListTopics` method.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.", + "type": "string" + }, + "topics": { + "description": "The resulting topics.", + "type": "array", + "items": { + "$ref": "Topic" + } + } + }, + "id": "ListTopicsResponse" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, - "protocol": "rest" + "protocol": "rest", + "version": "v1", + "baseUrl": "https://pubsub.googleapis.com/", + "canonicalName": "Pubsub", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/pubsub": { + "description": "View and manage Pub/Sub topics and subscriptions" + } + } + } + }, + "servicePath": "", + "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n", + "kind": "discovery#restDescription", + "rootUrl": "https://pubsub.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "pubsub", + "batchPath": "batch", + "revision": "20171220", + "documentationLink": "https://cloud.google.com/pubsub/docs", + "id": "pubsub:v1", + "title": "Google Cloud Pub/Sub API" }
diff --git a/pubsub/v1beta1a/pubsub-api.json b/pubsub/v1beta1a/pubsub-api.json index 3a8961e..b5d8c4a 100644 --- a/pubsub/v1beta1a/pubsub-api.json +++ b/pubsub/v1beta1a/pubsub-api.json
@@ -1,8 +1,61 @@ { + "canonicalName": "Pubsub", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/pubsub": { + "description": "View and manage Pub/Sub topics and subscriptions" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n", + "servicePath": "", + "rootUrl": "https://pubsub.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "pubsub", + "batchPath": "batch", + "id": "pubsub:v1beta1a", + "documentationLink": "https://cloud.google.com/pubsub/docs", + "revision": "20171220", + "title": "Google Cloud Pub/Sub API", + "ownerName": "Google", + "discoveryVersion": "v1", "resources": { "subscriptions": { "methods": { + "modifyPushConfig": { + "id": "pubsub.subscriptions.modifyPushConfig", + "path": "v1beta1a/subscriptions/modifyPushConfig", + "request": { + "$ref": "ModifyPushConfigRequest" + }, + "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "Empty" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta1a/subscriptions/modifyPushConfig" + }, "delete": { + "httpMethod": "DELETE", + "parameterOrder": [ + "subscription" + ], + "response": { + "$ref": "Empty" + }, "parameters": { "subscription": { "pattern": "^.+$", @@ -17,16 +70,9 @@ "https://www.googleapis.com/auth/pubsub" ], "flatPath": "v1beta1a/subscriptions/{subscriptionsId}", - "path": "v1beta1a/subscriptions/{+subscription}", "id": "pubsub.subscriptions.delete", - "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "subscription" - ], - "httpMethod": "DELETE" + "path": "v1beta1a/subscriptions/{+subscription}", + "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to Pull after deletion will return\nNOT_FOUND." }, "pull": { "response": { @@ -34,53 +80,55 @@ }, "parameterOrder": [], "httpMethod": "POST", + "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "parameters": {}, "flatPath": "v1beta1a/subscriptions/pull", "path": "v1beta1a/subscriptions/pull", "id": "pubsub.subscriptions.pull", - "description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load).", "request": { "$ref": "PullRequest" - } + }, + "description": "Pulls a single message from the server.\nIf return_immediately is true, and no messages are available in the\nsubscription, this method returns FAILED_PRECONDITION. The system is free\nto return an UNAVAILABLE error if no messages are available in a\nreasonable amount of time (to reduce system load)." }, "list": { - "parameters": { - "pageToken": { - "location": "query", - "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.", - "type": "string" - }, - "query": { - "description": "A valid label query expression.", - "type": "string", - "location": "query" - }, - "maxResults": { - "location": "query", - "description": "Maximum number of subscriptions to return.", - "format": "int32", - "type": "integer" - } + "path": "v1beta1a/subscriptions", + "id": "pubsub.subscriptions.list", + "description": "Lists matching subscriptions.", + "response": { + "$ref": "ListSubscriptionsResponse" }, + "parameterOrder": [], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1beta1a/subscriptions", - "id": "pubsub.subscriptions.list", - "path": "v1beta1a/subscriptions", - "description": "Lists matching subscriptions.", - "httpMethod": "GET", - "response": { - "$ref": "ListSubscriptionsResponse" + "parameters": { + "pageToken": { + "description": "The value obtained in the last \u003ccode\u003eListSubscriptionsResponse\u003c/code\u003e\nfor continuation.", + "type": "string", + "location": "query" + }, + "query": { + "location": "query", + "description": "A valid label query expression.", + "type": "string" + }, + "maxResults": { + "description": "Maximum number of subscriptions to return.", + "format": "int32", + "type": "integer", + "location": "query" + } }, - "parameterOrder": [] + "flatPath": "v1beta1a/subscriptions" }, "create": { + "path": "v1beta1a/subscriptions", + "id": "pubsub.subscriptions.create", "description": "Creates a subscription on a given topic for a given subscriber.\nIf the subscription already exists, returns ALREADY_EXISTS.\nIf the corresponding topic doesn't exist, returns NOT_FOUND.\n\nIf the name is not provided in the request, the server will assign a random\nname for this subscription on the same project as the topic.", "request": { "$ref": "Subscription" @@ -95,69 +143,66 @@ "https://www.googleapis.com/auth/pubsub" ], "parameters": {}, - "flatPath": "v1beta1a/subscriptions", - "path": "v1beta1a/subscriptions", - "id": "pubsub.subscriptions.create" + "flatPath": "v1beta1a/subscriptions" }, "acknowledge": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta1a/subscriptions/acknowledge", "path": "v1beta1a/subscriptions/acknowledge", "id": "pubsub.subscriptions.acknowledge", "request": { "$ref": "AcknowledgeRequest" }, - "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta1a/subscriptions/acknowledge" + "description": "Acknowledges a particular received message: the Pub/Sub system can remove\nthe given message from the subscription. Acknowledging a message whose\nAck deadline has expired may succeed, but the message could have been\nalready redelivered. Acknowledging a message more than once will not\nresult in an error. This is only used for messages received via pull." }, "modifyAckDeadline": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "Empty" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta1a/subscriptions/modifyAckDeadline", - "id": "pubsub.subscriptions.modifyAckDeadline", "path": "v1beta1a/subscriptions/modifyAckDeadline", + "id": "pubsub.subscriptions.modifyAckDeadline", "request": { "$ref": "ModifyAckDeadlineRequest" }, - "description": "Modifies the Ack deadline for a message received from a pull request." - }, - "pullBatch": { - "id": "pubsub.subscriptions.pullBatch", - "path": "v1beta1a/subscriptions/pullBatch", - "request": { - "$ref": "PullBatchRequest" - }, - "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.", - "httpMethod": "POST", - "parameterOrder": [], + "description": "Modifies the Ack deadline for a message received from a pull request.", "response": { - "$ref": "PullBatchResponse" + "$ref": "Empty" }, + "parameterOrder": [], + "httpMethod": "POST", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1beta1a/subscriptions/pullBatch" + "flatPath": "v1beta1a/subscriptions/modifyAckDeadline" + }, + "pullBatch": { + "response": { + "$ref": "PullBatchResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": {}, + "flatPath": "v1beta1a/subscriptions/pullBatch", + "path": "v1beta1a/subscriptions/pullBatch", + "id": "pubsub.subscriptions.pullBatch", + "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The system is free to return UNAVAILABLE\nif there are too many pull requests outstanding for the given subscription.", + "request": { + "$ref": "PullBatchRequest" + } }, "get": { - "description": "Gets the configuration details of a subscription.", "response": { "$ref": "Subscription" }, @@ -180,40 +225,21 @@ ], "flatPath": "v1beta1a/subscriptions/{subscriptionsId}", "path": "v1beta1a/subscriptions/{+subscription}", - "id": "pubsub.subscriptions.get" - }, - "modifyPushConfig": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": {}, - "flatPath": "v1beta1a/subscriptions/modifyPushConfig", - "path": "v1beta1a/subscriptions/modifyPushConfig", - "id": "pubsub.subscriptions.modifyPushConfig", - "description": "Modifies the \u003ccode\u003ePushConfig\u003c/code\u003e for a specified subscription.\nThis method can be used to suspend the flow of messages to an endpoint\nby clearing the \u003ccode\u003ePushConfig\u003c/code\u003e field in the request. Messages\nwill be accumulated for delivery even if no push configuration is\ndefined or while the configuration is modified.", - "request": { - "$ref": "ModifyPushConfigRequest" - } + "id": "pubsub.subscriptions.get", + "description": "Gets the configuration details of a subscription." } } }, "topics": { "methods": { "get": { - "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here.", - "response": { - "$ref": "Topic" - }, + "httpMethod": "GET", "parameterOrder": [ "topic" ], - "httpMethod": "GET", + "response": { + "$ref": "Topic" + }, "parameters": { "topic": { "pattern": "^.+$", @@ -228,8 +254,9 @@ "https://www.googleapis.com/auth/pubsub" ], "flatPath": "v1beta1a/topics/{topicsId}", + "id": "pubsub.topics.get", "path": "v1beta1a/topics/{+topic}", - "id": "pubsub.topics.get" + "description": "Gets the configuration of a topic. Since the topic only has the name\nattribute, this method is only useful to check the existence of a topic.\nIf other attributes are added in the future, they will be returned here." }, "publish": { "path": "v1beta1a/topics/publish", @@ -251,61 +278,56 @@ "flatPath": "v1beta1a/topics/publish" }, "delete": { - "path": "v1beta1a/topics/{+topic}", - "id": "pubsub.topics.delete", - "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name.", - "response": { - "$ref": "Empty" - }, + "httpMethod": "DELETE", "parameterOrder": [ "topic" ], - "httpMethod": "DELETE", + "response": { + "$ref": "Empty" + }, + "parameters": { + "topic": { + "pattern": "^.+$", + "location": "path", + "description": "Name of the topic to delete.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "parameters": { - "topic": { - "description": "Name of the topic to delete.", - "required": true, - "type": "string", - "pattern": "^.+$", - "location": "path" - } - }, - "flatPath": "v1beta1a/topics/{topicsId}" + "flatPath": "v1beta1a/topics/{topicsId}", + "id": "pubsub.topics.delete", + "path": "v1beta1a/topics/{+topic}", + "description": "Deletes the topic with the given name. Returns NOT_FOUND if the topic does\nnot exist. After a topic is deleted, a new topic may be created with the\nsame name." }, "publishBatch": { + "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.", "request": { "$ref": "PublishBatchRequest" }, - "description": "Adds one or more messages to the topic. Returns NOT_FOUND if the topic does\nnot exist.", "response": { "$ref": "PublishBatchResponse" }, "parameterOrder": [], "httpMethod": "POST", - "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], + "parameters": {}, "flatPath": "v1beta1a/topics/publishBatch", "path": "v1beta1a/topics/publishBatch", "id": "pubsub.topics.publishBatch" }, "list": { - "description": "Lists matching topics.", + "httpMethod": "GET", "response": { "$ref": "ListTopicsResponse" }, "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "parameters": { "pageToken": { "description": "The value obtained in the last \u003ccode\u003eListTopicsResponse\u003c/code\u003e\nfor continuation.", @@ -313,9 +335,9 @@ "location": "query" }, "query": { + "location": "query", "description": "A valid label query expression.", - "type": "string", - "location": "query" + "type": "string" }, "maxResults": { "description": "Maximum number of topics to return.", @@ -324,38 +346,54 @@ "location": "query" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "flatPath": "v1beta1a/topics", + "id": "pubsub.topics.list", "path": "v1beta1a/topics", - "id": "pubsub.topics.list" + "description": "Lists matching topics." }, "create": { - "description": "Creates the given topic with the given name.", - "request": { - "$ref": "Topic" - }, "response": { "$ref": "Topic" }, "parameterOrder": [], "httpMethod": "POST", + "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "parameters": {}, "flatPath": "v1beta1a/topics", "path": "v1beta1a/topics", - "id": "pubsub.topics.create" + "id": "pubsub.topics.create", + "request": { + "$ref": "Topic" + }, + "description": "Creates the given topic with the given name." } } } }, "parameters": { - "oauth_token": { + "quotaUser": { "location": "query", - "description": "OAuth 2.0 token for the current user.", + "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.", "type": "string" }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", @@ -367,15 +405,15 @@ "type": "string" }, "prettyPrint": { - "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true" + "default": "true", + "location": "query" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "type": "string", + "location": "query" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", @@ -383,30 +421,24 @@ "location": "query" }, "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" }, "callback": { - "location": "query", "description": "JSONP", - "type": "string" + "type": "string", + "location": "query" }, "alt": { - "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -414,7 +446,13 @@ "media", "proto" ], - "type": "string" + "type": "string", + "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" }, "access_token": { "description": "OAuth access token.", @@ -422,44 +460,94 @@ "location": "query" }, "key": { + "location": "query", "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" + "type": "string" } }, "schemas": { - "ListTopicsResponse": { - "id": "ListTopicsResponse", - "description": "Response for the ListTopics method.", + "PullBatchRequest": { + "description": "Request for the PullBatch method.", "type": "object", "properties": { + "maxEvents": { + "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.", + "format": "int32", + "type": "integer" + }, + "subscription": { + "description": "The subscription from which messages should be pulled.", + "type": "string" + }, + "returnImmediately": { + "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.", + "type": "boolean" + } + }, + "id": "PullBatchRequest" + }, + "ModifyPushConfigRequest": { + "properties": { + "pushConfig": { + "$ref": "PushConfig", + "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription." + }, + "subscription": { + "description": "The name of the subscription.", + "type": "string" + } + }, + "id": "ModifyPushConfigRequest", + "description": "Request for the ModifyPushConfig method.", + "type": "object" + }, + "PubsubMessage": { + "description": "A message data and its labels.", + "type": "object", + "properties": { + "data": { + "description": "The message payload.", + "format": "byte", + "type": "string" + }, + "messageId": { + "description": "ID of this message assigned by the server at publication time. Guaranteed\nto be unique within the topic. This value may be read by a subscriber\nthat receives a PubsubMessage via a Pull call or a push delivery. It must\nnot be populated by a publisher in a Publish call.", + "type": "string" + }, + "label": { + "description": "Optional list of labels for this message. Keys in this collection must\nbe unique.", + "type": "array", + "items": { + "$ref": "Label" + } + }, + "publishTime": { + "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.", + "format": "int64", + "type": "string" + } + }, + "id": "PubsubMessage" + }, + "ListTopicsResponse": { + "properties": { + "nextPageToken": { + "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.", + "type": "string" + }, "topic": { "description": "The resulting topics.", "type": "array", "items": { "$ref": "Topic" } - }, - "nextPageToken": { - "description": "If not empty, indicates that there are more topics that match the request,\nand this value should be passed to the next \u003ccode\u003eListTopicsRequest\u003c/code\u003e\nto continue.", - "type": "string" } - } + }, + "id": "ListTopicsResponse", + "description": "Response for the ListTopics method.", + "type": "object" }, "PublishBatchRequest": { - "description": "Request for the PublishBatch method.", - "type": "object", "properties": { "messages": { "description": "The messages to publish.", @@ -473,10 +561,11 @@ "type": "string" } }, - "id": "PublishBatchRequest" + "id": "PublishBatchRequest", + "description": "Request for the PublishBatch method.", + "type": "object" }, "AcknowledgeRequest": { - "id": "AcknowledgeRequest", "description": "Request for the Acknowledge method.", "type": "object", "properties": { @@ -491,10 +580,10 @@ "type": "string" } } - } + }, + "id": "AcknowledgeRequest" }, "PullBatchResponse": { - "id": "PullBatchResponse", "description": "Response for the PullBatch method.", "type": "object", "properties": { @@ -505,7 +594,8 @@ "$ref": "PullResponse" } } - } + }, + "id": "PullBatchResponse" }, "Empty": { "description": "An empty message that you can re-use to avoid defining duplicated empty\nmessages in your project. A typical example is to use it as argument or the\nreturn value of a service API. For instance:\n\n service Foo {\n rpc Bar (proto2.Empty) returns (proto2.Empty) { };\n };\n\nBEGIN GOOGLE-INTERNAL\nThe difference between this one and net/rpc/empty-message.proto is that\n1) The generated message here is in proto2 C++ API.\n2) The proto2.Empty has minimum dependencies\n (no message_set or net/rpc dependencies)\nEND GOOGLE-INTERNAL", @@ -517,19 +607,18 @@ "description": "Either a \u003ccode\u003ePubsubMessage\u003c/code\u003e or a truncation event. One of these two\nmust be populated.", "type": "object", "properties": { - "ackId": { - "description": "This ID must be used to acknowledge the received event or message.", - "type": "string" - }, "pubsubEvent": { "description": "A pubsub message or truncation event.", "$ref": "PubsubEvent" + }, + "ackId": { + "description": "This ID must be used to acknowledge the received event or message.", + "type": "string" } }, "id": "PullResponse" }, "PushConfig": { - "id": "PushConfig", "description": "Configuration for a push delivery endpoint.", "type": "object", "properties": { @@ -537,10 +626,10 @@ "description": "A URL locating the endpoint to which messages should be pushed.\nFor example, a Webhook endpoint might use \"https://example.com/push\".", "type": "string" } - } + }, + "id": "PushConfig" }, "PullRequest": { - "id": "PullRequest", "description": "Request for the Pull method.", "type": "object", "properties": { @@ -552,7 +641,8 @@ "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning FAILED_PRECONDITION. The client may cancel the request if\nit does not wish to wait any longer for the response.", "type": "boolean" } - } + }, + "id": "PullRequest" }, "ListSubscriptionsResponse": { "description": "Response for the ListSubscriptions method.", @@ -573,13 +663,12 @@ "id": "ListSubscriptionsResponse" }, "PubsubEvent": { - "id": "PubsubEvent", "description": "An event indicating a received message or truncation event.", "type": "object", "properties": { "message": { - "description": "A received message.", - "$ref": "PubsubMessage" + "$ref": "PubsubMessage", + "description": "A received message." }, "subscription": { "description": "The subscription that received the event.", @@ -593,22 +682,23 @@ "description": "Indicates that this subscription has been deleted. (Note that pull\nsubscribers will always receive NOT_FOUND in response in their pull\nrequest on the subscription, rather than seeing this boolean.)", "type": "boolean" } - } + }, + "id": "PubsubEvent" }, "PublishRequest": { - "description": "Request for the Publish method.", - "type": "object", "properties": { - "message": { - "description": "The message to publish.", - "$ref": "PubsubMessage" - }, "topic": { "description": "The message in the request will be published on this topic.", "type": "string" + }, + "message": { + "description": "The message to publish.", + "$ref": "PubsubMessage" } }, - "id": "PublishRequest" + "id": "PublishRequest", + "description": "Request for the Publish method.", + "type": "object" }, "Subscription": { "description": "A subscription resource.", @@ -635,9 +725,6 @@ "id": "Subscription" }, "PublishBatchResponse": { - "id": "PublishBatchResponse", - "description": "Response for the PublishBatch method.", - "type": "object", "properties": { "messageIds": { "description": "The server-assigned ID of each published message, in the same order as\nthe messages in the request. IDs are guaranteed to be unique within\nthe topic.", @@ -646,7 +733,10 @@ "type": "string" } } - } + }, + "id": "PublishBatchResponse", + "description": "Response for the PublishBatch method.", + "type": "object" }, "Topic": { "description": "A topic resource.", @@ -660,9 +750,12 @@ "id": "Topic" }, "Label": { - "description": "A key-value pair applied to a given object.", - "type": "object", "properties": { + "numValue": { + "description": "An integer value.", + "format": "int64", + "type": "string" + }, "key": { "description": "The key of a label is a syntactically valid URL (as per RFC 1738) with\nthe \"scheme\" and initial slashes omitted and with the additional\nrestrictions noted below. Each key should be globally unique. The\n\"host\" portion is called the \"namespace\" and is not necessarily\nresolvable to a network endpoint. Instead, the namespace indicates what\nsystem or entity defines the semantics of the label. Namespaces do not\nrestrict the set of objects to which a label may be associated.\n\nKeys are defined by the following grammar:\n\n key = hostname \"/\" kpath\n kpath = ksegment *[ \"/\" ksegment ]\n ksegment = alphadigit | *[ alphadigit | \"-\" | \"_\" | \".\" ]\n\nwhere \"hostname\" and \"alphadigit\" are defined as in RFC 1738.\n\nExample key:\n spanner.google.com/universe", "type": "string" @@ -670,27 +763,14 @@ "strValue": { "description": "A string value.", "type": "string" - }, - "numValue": { - "description": "An integer value.", - "format": "int64", - "type": "string" } }, - "id": "Label" + "id": "Label", + "description": "A key-value pair applied to a given object.", + "type": "object" }, "ModifyAckDeadlineRequest": { - "description": "Request for the ModifyAckDeadline method.", - "type": "object", "properties": { - "subscription": { - "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.", - "type": "string" - }, - "ackId": { - "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both.", - "type": "string" - }, "ackDeadlineSeconds": { "description": "The new ack deadline with respect to the time this request was sent to the\nPub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new ack\ndeadline will expire 10 seconds after the ModifyAckDeadline call was made.\nSpecifying zero may immediately make the message available for another pull\nrequest.", "format": "int32", @@ -702,72 +782,19 @@ "items": { "type": "string" } - } - }, - "id": "ModifyAckDeadlineRequest" - }, - "PullBatchRequest": { - "id": "PullBatchRequest", - "description": "Request for the PullBatch method.", - "type": "object", - "properties": { - "maxEvents": { - "description": "The maximum number of PubsubEvents returned for this request. The Pub/Sub\nsystem may return fewer than the number of events specified.", - "format": "int32", - "type": "integer" }, "subscription": { - "description": "The subscription from which messages should be pulled.", + "description": "Next Index: 5\nThe name of the subscription from which messages are being pulled.", "type": "string" }, - "returnImmediately": { - "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the Pull response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.", - "type": "boolean" - } - } - }, - "ModifyPushConfigRequest": { - "id": "ModifyPushConfigRequest", - "description": "Request for the ModifyPushConfig method.", - "type": "object", - "properties": { - "pushConfig": { - "description": "An empty \u003ccode\u003epush_config\u003c/code\u003e indicates that the Pub/Sub system should\npause pushing messages from the given subscription.", - "$ref": "PushConfig" - }, - "subscription": { - "description": "The name of the subscription.", - "type": "string" - } - } - }, - "PubsubMessage": { - "description": "A message data and its labels.", - "type": "object", - "properties": { - "messageId": { - "description": "ID of this message assigned by the server at publication time. Guaranteed\nto be unique within the topic. This value may be read by a subscriber\nthat receives a PubsubMessage via a Pull call or a push delivery. It must\nnot be populated by a publisher in a Publish call.", - "type": "string" - }, - "label": { - "description": "Optional list of labels for this message. Keys in this collection must\nbe unique.", - "type": "array", - "items": { - "$ref": "Label" - } - }, - "publishTime": { - "description": "The time at which the message was published.\nThe time is milliseconds since the UNIX epoch.", - "format": "int64", - "type": "string" - }, - "data": { - "description": "The message payload.", - "format": "byte", + "ackId": { + "description": "The acknowledgment ID. Either this or ack_ids must be populated,\nnot both.", "type": "string" } }, - "id": "PubsubMessage" + "id": "ModifyAckDeadlineRequest", + "description": "Request for the ModifyAckDeadline method.", + "type": "object" } }, "icons": { @@ -776,32 +803,5 @@ }, "protocol": "rest", "version": "v1beta1a", - "baseUrl": "https://pubsub.googleapis.com/", - "canonicalName": "Pubsub", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/pubsub": { - "description": "View and manage Pub/Sub topics and subscriptions" - }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - } - } - } - }, - "servicePath": "", - "description": "Provides reliable, many-to-many, asynchronous messaging between applications.\n", - "kind": "discovery#restDescription", - "rootUrl": "https://pubsub.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "pubsub", - "batchPath": "batch", - "revision": "20171220", - "documentationLink": "https://cloud.google.com/pubsub/docs", - "id": "pubsub:v1beta1a", - "title": "Google Cloud Pub/Sub API", - "discoveryVersion": "v1", - "ownerName": "Google" + "baseUrl": "https://pubsub.googleapis.com/" }
diff --git a/pubsub/v1beta2/pubsub-api.json b/pubsub/v1beta2/pubsub-api.json index b967f47..3a86941 100644 --- a/pubsub/v1beta2/pubsub-api.json +++ b/pubsub/v1beta2/pubsub-api.json
@@ -1,4 +1,8 @@ { + "revision": "20171220", + "documentationLink": "https://cloud.google.com/pubsub/docs", + "id": "pubsub:v1beta2", + "title": "Google Cloud Pub/Sub API", "discoveryVersion": "v1", "ownerName": "Google", "resources": { @@ -6,119 +10,7 @@ "resources": { "subscriptions": { "methods": { - "acknowledge": { - "path": "v1beta2/{+subscription}:acknowledge", - "id": "pubsub.projects.subscriptions.acknowledge", - "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.", - "request": { - "$ref": "AcknowledgeRequest" - }, - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "subscription" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": { - "subscription": { - "description": "The subscription whose message is being acknowledged.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge" - }, - "modifyAckDeadline": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "subscription" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": { - "subscription": { - "description": "The name of the subscription.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline", - "path": "v1beta2/{+subscription}:modifyAckDeadline", - "id": "pubsub.projects.subscriptions.modifyAckDeadline", - "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.", - "request": { - "$ref": "ModifyAckDeadlineRequest" - } - }, - "getIamPolicy": { - "path": "v1beta2/{+resource}:getIamPolicy", - "id": "pubsub.projects.subscriptions.getIamPolicy", - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "GET", - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy" - }, - "get": { - "id": "pubsub.projects.subscriptions.get", - "path": "v1beta2/{+subscription}", - "description": "Gets the configuration details of a subscription.", - "httpMethod": "GET", - "response": { - "$ref": "Subscription" - }, - "parameterOrder": [ - "subscription" - ], - "parameters": { - "subscription": { - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path", - "description": "The name of the subscription to get.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}" - }, "testIamPermissions": { - "path": "v1beta2/{+resource}:testIamPermissions", - "id": "pubsub.projects.subscriptions.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, @@ -143,7 +35,9 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions" + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:testIamPermissions", + "path": "v1beta2/{+resource}:testIamPermissions", + "id": "pubsub.projects.subscriptions.testIamPermissions" }, "modifyPushConfig": { "response": { @@ -153,6 +47,10 @@ "subscription" ], "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "parameters": { "subscription": { "description": "The name of the subscription.", @@ -162,19 +60,18 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyPushConfig", "path": "v1beta2/{+subscription}:modifyPushConfig", "id": "pubsub.projects.subscriptions.modifyPushConfig", + "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`.", "request": { "$ref": "ModifyPushConfigRequest" - }, - "description": "Modifies the `PushConfig` for a specified subscription.\n\nThis may be used to change a push subscription to a pull one (signified by\nan empty `PushConfig`) or vice versa, or change the endpoint URL and other\nattributes of a push subscription. Messages will accumulate for delivery\ncontinuously through the call regardless of changes to the `PushConfig`." + } }, "delete": { + "path": "v1beta2/{+subscription}", + "id": "pubsub.projects.subscriptions.delete", + "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified.", "response": { "$ref": "Empty" }, @@ -195,29 +92,9 @@ "type": "string" } }, - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}", - "path": "v1beta2/{+subscription}", - "id": "pubsub.projects.subscriptions.delete", - "description": "Deletes an existing subscription. All pending messages in the subscription\nare immediately dropped. Calls to `Pull` after deletion will return\n`NOT_FOUND`. After a subscription is deleted, a new one may be created with\nthe same name, but the new one has no association with the old\nsubscription, or its topic unless the same topic is specified." + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}" }, "pull": { - "path": "v1beta2/{+subscription}:pull", - "id": "pubsub.projects.subscriptions.pull", - "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.", - "request": { - "$ref": "PullRequest" - }, - "response": { - "$ref": "PullResponse" - }, - "parameterOrder": [ - "subscription" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "parameters": { "subscription": { "description": "The subscription from which messages should be pulled.", @@ -227,10 +104,26 @@ "location": "path" } }, - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:pull", + "path": "v1beta2/{+subscription}:pull", + "id": "pubsub.projects.subscriptions.pull", + "request": { + "$ref": "PullRequest" + }, + "description": "Pulls messages from the server. Returns an empty list if there are no\nmessages available in the backlog. The server may return `UNAVAILABLE` if\nthere are too many concurrent pull requests pending for the given\nsubscription.", + "response": { + "$ref": "PullResponse" + }, + "parameterOrder": [ + "subscription" + ], + "httpMethod": "POST" }, "list": { - "description": "Lists matching subscriptions.", "response": { "$ref": "ListSubscriptionsResponse" }, @@ -244,9 +137,9 @@ ], "parameters": { "pageToken": { - "location": "query", "description": "The value returned by the last `ListSubscriptionsResponse`; indicates that\nthis is a continuation of a prior `ListSubscriptions` call, and that the\nsystem should return the next page of data.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", @@ -264,7 +157,8 @@ }, "flatPath": "v1beta2/projects/{projectsId}/subscriptions", "path": "v1beta2/{+project}/subscriptions", - "id": "pubsub.projects.subscriptions.list" + "id": "pubsub.projects.subscriptions.list", + "description": "Lists matching subscriptions." }, "create": { "path": "v1beta2/{+name}", @@ -282,8 +176,119 @@ "httpMethod": "PUT", "parameters": { "name": { + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path", "description": "The name of the subscription. It must have the format\n`\"projects/{project}/subscriptions/{subscription}\"`. `{subscription}` must\nstart with a letter, and contain only letters (`[A-Za-z]`), numbers\n(`[0-9]`), dashes (`-`), underscores (`_`), periods (`.`), tildes (`~`),\nplus (`+`) or percent signs (`%`). It must be between 3 and 255 characters\nin length, and it must not start with `\"goog\"`.", "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}" + }, + "setIamPolicy": { + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy", + "id": "pubsub.projects.subscriptions.setIamPolicy", + "path": "v1beta2/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + } + }, + "acknowledge": { + "description": "Acknowledges the messages associated with the `ack_ids` in the\n`AcknowledgeRequest`. The Pub/Sub system can remove the relevant messages\nfrom the subscription.\n\nAcknowledging a message whose ack deadline has expired may succeed,\nbut such a message may be redelivered later. Acknowledging a message more\nthan once will not result in an error.", + "request": { + "$ref": "AcknowledgeRequest" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "subscription" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "subscription": { + "description": "The subscription whose message is being acknowledged.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:acknowledge", + "path": "v1beta2/{+subscription}:acknowledge", + "id": "pubsub.projects.subscriptions.acknowledge" + }, + "modifyAckDeadline": { + "httpMethod": "POST", + "parameterOrder": [ + "subscription" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "subscription": { + "description": "The name of the subscription.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:modifyAckDeadline", + "id": "pubsub.projects.subscriptions.modifyAckDeadline", + "path": "v1beta2/{+subscription}:modifyAckDeadline", + "description": "Modifies the ack deadline for a specific message. This method is useful\nto indicate that more time is needed to process a message by the\nsubscriber, or to make the message available for redelivery if the\nprocessing was interrupted. Note that this does not modify the\nsubscription-level `ackDeadlineSeconds` used for subsequent messages.", + "request": { + "$ref": "ModifyAckDeadlineRequest" + } + }, + "getIamPolicy": { + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "GET", + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, "type": "string", "pattern": "^projects/[^/]+/subscriptions/[^/]+$", "location": "path" @@ -293,9 +298,164 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/pubsub" ], - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}" + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:getIamPolicy", + "path": "v1beta2/{+resource}:getIamPolicy", + "id": "pubsub.projects.subscriptions.getIamPolicy" + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "subscription" + ], + "response": { + "$ref": "Subscription" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "subscription": { + "pattern": "^projects/[^/]+/subscriptions/[^/]+$", + "location": "path", + "description": "The name of the subscription to get.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}", + "id": "pubsub.projects.subscriptions.get", + "path": "v1beta2/{+subscription}", + "description": "Gets the configuration details of a subscription." + } + } + }, + "topics": { + "methods": { + "publish": { + "path": "v1beta2/{+topic}:publish", + "id": "pubsub.projects.topics.publish", + "request": { + "$ref": "PublishRequest" + }, + "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.", + "response": { + "$ref": "PublishResponse" + }, + "parameterOrder": [ + "topic" + ], + "httpMethod": "POST", + "parameters": { + "topic": { + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path", + "description": "The messages in the request will be published on this topic.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish" + }, + "testIamPermissions": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions", + "path": "v1beta2/{+resource}:testIamPermissions", + "id": "pubsub.projects.topics.testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST" + }, + "delete": { + "id": "pubsub.projects.topics.delete", + "path": "v1beta2/{+topic}", + "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", + "httpMethod": "DELETE", + "parameterOrder": [ + "topic" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "parameters": { + "topic": { + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path", + "description": "Name of the topic to delete.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}" + }, + "list": { + "parameters": { + "pageToken": { + "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Maximum number of topics to return.", + "format": "int32", + "type": "integer" + }, + "project": { + "pattern": "^projects/[^/]+$", + "location": "path", + "description": "The name of the cloud project that topics belong to.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], + "flatPath": "v1beta2/projects/{projectsId}/topics", + "path": "v1beta2/{+project}/topics", + "id": "pubsub.projects.topics.list", + "description": "Lists matching topics.", + "response": { + "$ref": "ListTopicsResponse" + }, + "parameterOrder": [ + "project" + ], + "httpMethod": "GET" }, "setIamPolicy": { + "path": "v1beta2/{+resource}:setIamPolicy", + "id": "pubsub.projects.topics.setIamPolicy", "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", "request": { "$ref": "SetIamPolicyRequest" @@ -313,21 +473,15 @@ ], "parameters": { "resource": { + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path", "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/subscriptions/[^/]+$", - "location": "path" + "type": "string" } }, - "flatPath": "v1beta2/projects/{projectsId}/subscriptions/{subscriptionsId}:setIamPolicy", - "path": "v1beta2/{+resource}:setIamPolicy", - "id": "pubsub.projects.subscriptions.setIamPolicy" - } - } - }, - "topics": { - "methods": { + "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy" + }, "create": { "path": "v1beta2/{+name}", "id": "pubsub.projects.topics.create", @@ -357,36 +511,8 @@ ], "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}" }, - "setIamPolicy": { - "path": "v1beta2/{+resource}:setIamPolicy", - "id": "pubsub.projects.topics.setIamPolicy", - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:setIamPolicy" - }, "getIamPolicy": { + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", "response": { "$ref": "Policy" }, @@ -394,6 +520,10 @@ "resource" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" + ], "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", @@ -403,14 +533,9 @@ "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:getIamPolicy", "path": "v1beta2/{+resource}:getIamPolicy", - "id": "pubsub.projects.topics.getIamPolicy", - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." + "id": "pubsub.projects.topics.getIamPolicy" }, "get": { "response": { @@ -422,11 +547,11 @@ "httpMethod": "GET", "parameters": { "topic": { + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path", "description": "The name of the topic to get.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ @@ -437,145 +562,21 @@ "path": "v1beta2/{+topic}", "id": "pubsub.projects.topics.get", "description": "Gets the configuration of a topic." - }, - "publish": { - "description": "Adds one or more messages to the topic. Returns `NOT_FOUND` if the topic\ndoes not exist. The message payload must not be empty; it must contain\n either a non-empty data field, or at least one attribute.", - "request": { - "$ref": "PublishRequest" - }, - "response": { - "$ref": "PublishResponse" - }, - "parameterOrder": [ - "topic" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "parameters": { - "topic": { - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path", - "description": "The messages in the request will be published on this topic.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:publish", - "path": "v1beta2/{+topic}:publish", - "id": "pubsub.projects.topics.publish" - }, - "testIamPermissions": { - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}:testIamPermissions", - "id": "pubsub.projects.topics.testIamPermissions", - "path": "v1beta2/{+resource}:testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." - }, - "delete": { - "description": "Deletes the topic with the given name. Returns `NOT_FOUND` if the topic\ndoes not exist. After a topic is deleted, a new topic may be created with\nthe same name; this is an entirely new topic with none of the old\nconfiguration or subscriptions. Existing subscriptions to this topic are\nnot deleted, but their `topic` field is set to `_deleted-topic_`.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "topic" - ], - "parameters": { - "topic": { - "description": "Name of the topic to delete.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}", - "id": "pubsub.projects.topics.delete", - "path": "v1beta2/{+topic}" - }, - "list": { - "description": "Lists matching topics.", - "response": { - "$ref": "ListTopicsResponse" - }, - "parameterOrder": [ - "project" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "description": "The value returned by the last `ListTopicsResponse`; indicates that this is\na continuation of a prior `ListTopics` call, and that the system should\nreturn the next page of data.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Maximum number of topics to return.", - "format": "int32", - "type": "integer" - }, - "project": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The name of the cloud project that topics belong to.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], - "flatPath": "v1beta2/projects/{projectsId}/topics", - "path": "v1beta2/{+project}/topics", - "id": "pubsub.projects.topics.list" } }, "resources": { "subscriptions": { "methods": { "list": { - "response": { - "$ref": "ListTopicSubscriptionsResponse" - }, - "parameterOrder": [ - "topic" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/pubsub" ], - "httpMethod": "GET", "parameters": { "pageToken": { - "location": "query", "description": "The value returned by the last `ListTopicSubscriptionsResponse`; indicates\nthat this is a continuation of a prior `ListTopicSubscriptions` call, and\nthat the system should return the next page of data.", - "type": "string" + "type": "string", + "location": "query" }, "pageSize": { "location": "query", @@ -584,21 +585,24 @@ "type": "integer" }, "topic": { - "pattern": "^projects/[^/]+/topics/[^/]+$", - "location": "path", "description": "The name of the topic that subscriptions are attached to.", "required": true, - "type": "string" + "type": "string", + "pattern": "^projects/[^/]+/topics/[^/]+$", + "location": "path" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/pubsub" - ], "flatPath": "v1beta2/projects/{projectsId}/topics/{topicsId}/subscriptions", "path": "v1beta2/{+topic}/subscriptions", "id": "pubsub.projects.topics.subscriptions.list", - "description": "Lists the name of the subscriptions for this topic." + "description": "Lists the name of the subscriptions for this topic.", + "response": { + "$ref": "ListTopicSubscriptionsResponse" + }, + "parameterOrder": [ + "topic" + ], + "httpMethod": "GET" } } } @@ -608,47 +612,16 @@ } }, "parameters": { - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "uploadType": { "location": "query", @@ -656,12 +629,7 @@ "type": "string" }, "fields": { - "location": "query", "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "callback": { - "description": "JSONP", "type": "string", "location": "query" }, @@ -678,7 +646,14 @@ "description": "V1 error format.", "type": "string" }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "alt": { + "description": "Data format for response.", + "default": "json", "enum": [ "json", "media", @@ -690,31 +665,119 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], + "location": "query" + }, + "key": { "location": "query", - "description": "Data format for response.", - "default": "json" + "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.", + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" } }, "schemas": { - "ListTopicSubscriptionsResponse": { + "Binding": { + "description": "Associates `members` with a `role`.", + "type": "object", + "properties": { + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + } + }, + "id": "Binding" + }, + "AcknowledgeRequest": { + "id": "AcknowledgeRequest", + "description": "Request for the Acknowledge method.", + "type": "object", + "properties": { + "ackIds": { + "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "ListTopicsResponse": { + "description": "Response for the `ListTopics` method.", + "type": "object", "properties": { "nextPageToken": { - "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.", + "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.", "type": "string" }, + "topics": { + "description": "The resulting topics.", + "type": "array", + "items": { + "$ref": "Topic" + } + } + }, + "id": "ListTopicsResponse" + }, + "ListTopicSubscriptionsResponse": { + "description": "Response for the `ListTopicSubscriptions` method.", + "type": "object", + "properties": { "subscriptions": { "description": "The names of the subscriptions that match the request.", "type": "array", "items": { "type": "string" } + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListTopicSubscriptionsRequest` to get more subscriptions.", + "type": "string" } }, - "id": "ListTopicSubscriptionsResponse", - "description": "Response for the `ListTopicSubscriptions` method.", - "type": "object" + "id": "ListTopicSubscriptionsResponse" }, "PullResponse": { + "id": "PullResponse", + "description": "Response for the `Pull` method.", + "type": "object", "properties": { "receivedMessages": { "description": "Received Pub/Sub messages. The Pub/Sub system will return zero messages if\nthere are no more available in the backlog. The Pub/Sub system may return\nfewer than the `maxMessages` requested even if there are more messages\navailable in the backlog.", @@ -723,12 +786,11 @@ "$ref": "ReceivedMessage" } } - }, - "id": "PullResponse", - "description": "Response for the `Pull` method.", - "type": "object" + } }, "ReceivedMessage": { + "description": "A message and its corresponding acknowledgment ID.", + "type": "object", "properties": { "message": { "description": "The message.", @@ -739,9 +801,7 @@ "type": "string" } }, - "id": "ReceivedMessage", - "description": "A message and its corresponding acknowledgment ID.", - "type": "object" + "id": "ReceivedMessage" }, "PushConfig": { "description": "Configuration for a push delivery endpoint.", @@ -776,6 +836,9 @@ "id": "TestIamPermissionsResponse" }, "PullRequest": { + "id": "PullRequest", + "description": "Request for the `Pull` method.", + "type": "object", "properties": { "returnImmediately": { "description": "If this is specified as true the system will respond immediately even if\nit is not able to return a message in the `Pull` response. Otherwise the\nsystem is allowed to wait until at least one message is available rather\nthan returning no messages. The client may cancel the request if it does\nnot wish to wait any longer for the response.", @@ -786,30 +849,30 @@ "format": "int32", "type": "integer" } - }, - "id": "PullRequest", - "description": "Request for the `Pull` method.", - "type": "object" + } }, "ListSubscriptionsResponse": { + "id": "ListSubscriptionsResponse", + "description": "Response for the `ListSubscriptions` method.", + "type": "object", "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.", - "type": "string" - }, "subscriptions": { "description": "The subscriptions that match the request.", "type": "array", "items": { "$ref": "Subscription" } + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more subscriptions that match\nthe request; this value should be passed in a new\n`ListSubscriptionsRequest` to get more subscriptions.", + "type": "string" } - }, - "id": "ListSubscriptionsResponse", - "description": "Response for the `ListSubscriptions` method.", - "type": "object" + } }, "PublishRequest": { + "id": "PublishRequest", + "description": "Request for the Publish method.", + "type": "object", "properties": { "messages": { "description": "The messages to publish.", @@ -818,12 +881,10 @@ "$ref": "PubsubMessage" } } - }, - "id": "PublishRequest", - "description": "Request for the Publish method.", - "type": "object" + } }, "PublishResponse": { + "id": "PublishResponse", "description": "Response for the `Publish` method.", "type": "object", "properties": { @@ -834,14 +895,16 @@ "type": "string" } } - }, - "id": "PublishResponse" + } }, "Subscription": { + "id": "Subscription", + "description": "A subscription resource.", + "type": "object", "properties": { "pushConfig": { - "$ref": "PushConfig", - "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods." + "description": "If push delivery is used with this subscription, this field is\nused to configure it. An empty `pushConfig` signifies that the subscriber\nwill pull and ack messages using API methods.", + "$ref": "PushConfig" }, "ackDeadlineSeconds": { "description": "This value is the maximum time after a subscriber receives a message\nbefore the subscriber should acknowledge the message. After message\ndelivery but before the ack deadline expires and before the message is\nacknowledged, it is an outstanding message and will not be delivered\nagain during that time (on a best-effort basis).\n\nFor pull subscriptions, this value is used as the initial value for the ack\ndeadline. To override this value for a given message, call\n`ModifyAckDeadline` with the corresponding `ack_id` if using pull.\nThe maximum custom deadline you can specify is 600 seconds (10 minutes).\n\nFor push delivery, this value is also used to set the request timeout for\nthe call to the push endpoint.\n\nIf the subscriber never acknowledges the message, the Pub/Sub\nsystem will eventually redeliver the message.\n\nIf this parameter is 0, a default value of 10 seconds is used.", @@ -856,12 +919,11 @@ "description": "The name of the topic from which this subscription is receiving messages.\nThe value of this field will be `_deleted-topic_` if the topic has been\ndeleted.", "type": "string" } - }, - "id": "Subscription", - "description": "A subscription resource.", - "type": "object" + } }, "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", "properties": { "permissions": { "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", @@ -871,22 +933,22 @@ } } }, - "id": "TestIamPermissionsRequest", - "description": "Request message for `TestIamPermissions` method.", - "type": "object" + "id": "TestIamPermissionsRequest" }, "Topic": { + "id": "Topic", + "description": "A topic resource.", + "type": "object", "properties": { "name": { "description": "The name of the topic. It must have the format\n`\"projects/{project}/topics/{topic}\"`. `{topic}` must start with a letter,\nand contain only letters (`[A-Za-z]`), numbers (`[0-9]`), dashes (`-`),\nunderscores (`_`), periods (`.`), tildes (`~`), plus (`+`) or percent\nsigns (`%`). It must be between 3 and 255 characters in length, and it\nmust not start with `\"goog\"`.", "type": "string" } - }, - "id": "Topic", - "description": "A topic resource.", - "type": "object" + } }, "Policy": { + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", + "type": "object", "properties": { "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", @@ -906,14 +968,16 @@ } } }, - "id": "Policy", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", - "type": "object" + "id": "Policy" }, "ModifyAckDeadlineRequest": { "description": "Request for the ModifyAckDeadline method.", "type": "object", "properties": { + "ackId": { + "description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.", + "type": "string" + }, "ackDeadlineSeconds": { "description": "The new ack deadline with respect to the time this request was sent to\nthe Pub/Sub system. Must be \u003e= 0. For example, if the value is 10, the new\nack deadline will expire 10 seconds after the `ModifyAckDeadline` call\nwas made. Specifying zero may immediately make the message available for\nanother pull request.", "format": "int32", @@ -925,32 +989,25 @@ "items": { "type": "string" } - }, - "ackId": { - "description": "The acknowledgment ID. Either this or ack_ids must be populated, but not\nboth.", - "type": "string" } }, "id": "ModifyAckDeadlineRequest" }, "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", "properties": { "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", + "$ref": "Policy" } }, - "id": "SetIamPolicyRequest", - "description": "Request message for `SetIamPolicy` method.", - "type": "object" + "id": "SetIamPolicyRequest" }, "PubsubMessage": { + "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.", + "type": "object", "properties": { - "data": { - "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).", - "format": "byte", - "type": "string" - }, "attributes": { "additionalProperties": { "type": "string" @@ -966,96 +1023,43 @@ "description": "The time at which the message was published, populated by the server when\nit receives the `Publish` call. It must not be populated by the\npublisher in a `Publish` call.", "format": "google-datetime", "type": "string" + }, + "data": { + "description": "The message payload. For JSON requests, the value of this field must be\n[base64-encoded](https://tools.ietf.org/html/rfc4648).", + "format": "byte", + "type": "string" } }, - "id": "PubsubMessage", - "description": "A message data and its attributes. The message payload must not be empty;\nit must contain either a non-empty data field, or at least one attribute.", - "type": "object" + "id": "PubsubMessage" }, "ModifyPushConfigRequest": { "description": "Request for the ModifyPushConfig method.", "type": "object", "properties": { "pushConfig": { - "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called.", - "$ref": "PushConfig" + "$ref": "PushConfig", + "description": "The push configuration for future deliveries.\n\nAn empty `pushConfig` indicates that the Pub/Sub system should\nstop pushing messages from the given subscription and allow\nmessages to be pulled and acknowledged - effectively pausing\nthe subscription if `Pull` is not called." } }, "id": "ModifyPushConfigRequest" - }, - "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - } - }, - "id": "Binding" - }, - "AcknowledgeRequest": { - "properties": { - "ackIds": { - "description": "The acknowledgment ID for the messages being acknowledged that was returned\nby the Pub/Sub system in the `Pull` response. Must not be empty.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "AcknowledgeRequest", - "description": "Request for the Acknowledge method.", - "type": "object" - }, - "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" - }, - "ListTopicsResponse": { - "description": "Response for the `ListTopics` method.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more topics that match the\nrequest; this value should be passed in a new `ListTopicsRequest`.", - "type": "string" - }, - "topics": { - "description": "The resulting topics.", - "type": "array", - "items": { - "$ref": "Topic" - } - } - }, - "id": "ListTopicsResponse" } }, - "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" - }, "protocol": "rest", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, "version": "v1beta2", "baseUrl": "https://pubsub.googleapis.com/", "canonicalName": "Pubsub", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, "https://www.googleapis.com/auth/pubsub": { "description": "View and manage Pub/Sub topics and subscriptions" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" } } } @@ -1067,9 +1071,5 @@ "basePath": "", "ownerDomain": "google.com", "name": "pubsub", - "batchPath": "batch", - "revision": "20171220", - "documentationLink": "https://cloud.google.com/pubsub/docs", - "id": "pubsub:v1beta2", - "title": "Google Cloud Pub/Sub API" + "batchPath": "batch" }
diff --git a/runtimeconfig/v1/runtimeconfig-api.json b/runtimeconfig/v1/runtimeconfig-api.json index d7f5bd7..2de7286 100644 --- a/runtimeconfig/v1/runtimeconfig-api.json +++ b/runtimeconfig/v1/runtimeconfig-api.json
@@ -1,8 +1,102 @@ { + "schemas": { + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "type": "object", + "properties": {}, + "id": "CancelOperationRequest" + }, + "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.", + "type": "object", + "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 is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + } + }, + "id": "Status" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "properties": { + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Operation" + } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "id": "ListOperationsResponse" + }, + "Operation": { + "properties": { + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "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" + } + }, + "id": "Operation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + } + }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Cloud RuntimeConfig", "auth": { @@ -28,6 +122,13 @@ "operations": { "methods": { "cancel": { + "flatPath": "v1/operations/{operationsId}:cancel", + "path": "v1/{+name}:cancel", + "id": "runtimeconfig.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "request": { + "$ref": "CancelOperationRequest" + }, "response": { "$ref": "Empty" }, @@ -41,22 +142,16 @@ ], "parameters": { "name": { - "required": true, - "type": "string", "pattern": "^operations/.+$", "location": "path", - "description": "The name of the operation resource to be cancelled." + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string" } - }, - "flatPath": "v1/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "runtimeconfig.operations.cancel", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "request": { - "$ref": "CancelOperationRequest" } }, "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", "response": { "$ref": "Empty" }, @@ -70,17 +165,16 @@ ], "parameters": { "name": { + "description": "The name of the operation resource to be deleted.", "required": true, "type": "string", "pattern": "^operations/.+$", - "location": "path", - "description": "The name of the operation resource to be deleted." + "location": "path" } }, "flatPath": "v1/operations/{operationsId}", "path": "v1/{+name}", - "id": "runtimeconfig.operations.delete", - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`." + "id": "runtimeconfig.operations.delete" }, "list": { "response": { @@ -90,18 +184,17 @@ "name" ], "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], "parameters": { - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, "name": { - "location": "path", "description": "The name of the operation's parent resource.", "required": true, "type": "string", - "pattern": "^operations$" + "pattern": "^operations$", + "location": "path" }, "pageToken": { "location": "query", @@ -109,16 +202,17 @@ "type": "string" }, "pageSize": { - "type": "integer", - "location": "query", "description": "The standard list page size.", - "format": "int32" + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], "flatPath": "v1/operations", "path": "v1/{+name}", "id": "runtimeconfig.operations.list", @@ -128,36 +222,67 @@ } }, "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "uploadType": { - "type": "string", - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." - }, - "callback": { - "type": "string", - "location": "query", - "description": "JSONP" - }, "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ] + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" }, "alt": { - "location": "query", "description": "Data format for response.", "default": "json", "enum": [ @@ -170,7 +295,8 @@ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" - ] + ], + "location": "query" }, "access_token": { "location": "query", @@ -178,41 +304,9 @@ "type": "string" }, "key": { - "type": "string", "location": "query", - "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." - }, - "quotaUser": { - "type": "string", - "location": "query", - "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." - }, - "pp": { - "type": "boolean", - "default": "true", - "location": "query", - "description": "Pretty-print response." - }, - "bearer_token": { - "type": "string", - "location": "query", - "description": "OAuth bearer token." - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "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.", "type": "string" - }, - "prettyPrint": { - "type": "boolean", - "default": "true", - "location": "query", - "description": "Returns response with indentations and line breaks." } }, "version": "v1", @@ -225,99 +319,5 @@ "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", "id": "runtimeconfig:v1", "discoveryVersion": "v1", - "version_module": true, - "schemas": { - "CancelOperationRequest": { - "type": "object", - "properties": {}, - "id": "CancelOperationRequest", - "description": "The request message for Operations.CancelOperation." - }, - "Status": { - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "type": "integer", - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" - }, - "message": { - "type": "string", - "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." - } - }, - "id": "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." - }, - "ListOperationsResponse": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "items": { - "$ref": "Operation" - }, - "description": "A list of operations that matches the specified filter in the request." - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations." - }, - "Operation": { - "type": "object", - "properties": { - "response": { - "type": "object", - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "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`." - }, - "name": { - "type": "string", - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`." - }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" - }, - "done": { - "type": "boolean", - "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." - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." - }, - "Empty": { - "type": "object", - "properties": {}, - "id": "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 `{}`." - } - } + "version_module": true }
diff --git a/runtimeconfig/v1beta1/runtimeconfig-api.json b/runtimeconfig/v1beta1/runtimeconfig-api.json index d6cf303..412d074 100644 --- a/runtimeconfig/v1beta1/runtimeconfig-api.json +++ b/runtimeconfig/v1beta1/runtimeconfig-api.json
@@ -1,353 +1,4 @@ { - "servicePath": "", - "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", - "kind": "discovery#restDescription", - "basePath": "", - "revision": "20171219", - "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", - "id": "runtimeconfig:v1beta1", - "discoveryVersion": "v1", - "version_module": true, - "schemas": { - "Operation": { - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "properties": { - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - }, - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "Status" - }, - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "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": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - } - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" - } - }, - "id": "SetIamPolicyRequest" - }, - "Status": { - "id": "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.", - "type": "object", - "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 is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" - } - } - }, - "Binding": { - "id": "Binding", - "description": "Associates `members` with a `role`.", - "type": "object", - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - } - } - }, - "Cardinality": { - "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.", - "type": "object", - "properties": { - "path": { - "description": "The root of the variable subtree to monitor. For example, `/foo`.", - "type": "string" - }, - "number": { - "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.", - "format": "int32", - "type": "integer" - } - }, - "id": "Cardinality" - }, - "Empty": { - "id": "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 `{}`.", - "type": "object", - "properties": {} - }, - "ListConfigsResponse": { - "id": "ListConfigsResponse", - "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", - "type": "object", - "properties": { - "configs": { - "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", - "type": "array", - "items": { - "$ref": "RuntimeConfig" - } - }, - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", - "type": "string" - } - } - }, - "EndCondition": { - "description": "The condition that a Waiter resource is waiting for.", - "type": "object", - "properties": { - "cardinality": { - "$ref": "Cardinality", - "description": "The cardinality of the `EndCondition`." - } - }, - "id": "EndCondition" - }, - "TestIamPermissionsResponse": { - "id": "TestIamPermissionsResponse", - "description": "Response message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", - "type": "array", - "items": { - "type": "string" - } - } - } - }, - "ListVariablesResponse": { - "description": "Response for the `ListVariables()` method.", - "type": "object", - "properties": { - "variables": { - "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.", - "type": "array", - "items": { - "$ref": "Variable" - } - }, - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", - "type": "string" - } - }, - "id": "ListVariablesResponse" - }, - "RuntimeConfig": { - "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.", - "type": "object", - "properties": { - "name": { - "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches the\n`[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.\nThe length of `[CONFIG_NAME]` must be less than 64 characters.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.", - "type": "string" - }, - "description": { - "description": "An optional description of the RuntimeConfig object.", - "type": "string" - } - }, - "id": "RuntimeConfig" - }, - "WatchVariableRequest": { - "id": "WatchVariableRequest", - "description": "Request for the `WatchVariable()` method.", - "type": "object", - "properties": { - "newerThan": { - "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.", - "format": "google-datetime", - "type": "string" - } - } - }, - "ListWaitersResponse": { - "id": "ListWaitersResponse", - "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", - "type": "string" - }, - "waiters": { - "description": "Found waiters in the project.", - "type": "array", - "items": { - "$ref": "Waiter" - } - } - } - }, - "Waiter": { - "id": "Waiter", - "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.", - "type": "object", - "properties": { - "name": { - "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.", - "type": "string" - }, - "error": { - "$ref": "Status", - "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set." - }, - "failure": { - "$ref": "EndCondition", - "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout." - }, - "success": { - "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.", - "$ref": "EndCondition" - }, - "done": { - "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.", - "type": "boolean" - }, - "createTime": { - "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.", - "format": "google-datetime", - "type": "string" - }, - "timeout": { - "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.", - "format": "google-duration", - "type": "string" - } - } - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" - }, - "Variable": { - "id": "Variable", - "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).", - "type": "object", - "properties": { - "value": { - "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.", - "format": "byte", - "type": "string" - }, - "updateTime": { - "description": "[Output Only] The time of the last variable update.", - "format": "google-datetime", - "type": "string" - }, - "state": { - "enumDescriptions": [ - "Default variable state.", - "The variable was updated, while `variables().watch` was executing.", - "The variable was deleted, while `variables().watch` was executing." - ], - "enum": [ - "VARIABLE_STATE_UNSPECIFIED", - "UPDATED", - "DELETED" - ], - "description": "[Ouput only] The current state of the variable. The variable state indicates\nthe outcome of the `variables().watch` call and is visible through the\n`get` and `list` calls.", - "type": "string" - }, - "name": { - "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should match\n[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.\nThe length of a `[VARIABLE_NAME]` must be less than 256 characters.\n\nOnce you create a variable, you cannot change the variable name.", - "type": "string" - }, - "text": { - "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.", - "type": "string" - } - } - }, - "Policy": { - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", - "type": "object", - "properties": { - "version": { - "description": "Version of the `Policy`. The default version is 0.", - "format": "int32", - "type": "integer" - }, - "bindings": { - "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", - "type": "array", - "items": { - "$ref": "Binding" - } - }, - "etag": { - "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte", - "type": "string" - } - }, - "id": "Policy" - } - }, - "protocol": "rest", - "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" - }, "canonicalName": "Cloud RuntimeConfig", "auth": { "oauth2": { @@ -372,316 +23,23 @@ "projects": { "resources": { "configs": { - "methods": { - "create": { - "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project.", - "request": { - "$ref": "RuntimeConfig" - }, - "response": { - "$ref": "RuntimeConfig" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "parent": { - "pattern": "^projects/[^/]+$", - "location": "path", - "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", - "required": true, - "type": "string" - }, - "requestId": { - "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs", - "path": "v1beta1/{+parent}/configs", - "id": "runtimeconfig.projects.configs.create" - }, - "setIamPolicy": { - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy", - "path": "v1beta1/{+resource}:setIamPolicy", - "id": "runtimeconfig.projects.configs.setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST" - }, - "getIamPolicy": { - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy", - "path": "v1beta1/{+resource}:getIamPolicy", - "id": "runtimeconfig.projects.configs.getIamPolicy", - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "GET" - }, - "get": { - "id": "runtimeconfig.projects.configs.get", - "path": "v1beta1/{+name}", - "description": "Gets information about a RuntimeConfig resource.", - "httpMethod": "GET", - "response": { - "$ref": "RuntimeConfig" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}" - }, - "update": { - "parameters": { - "name": { - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path", - "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}", - "path": "v1beta1/{+name}", - "id": "runtimeconfig.projects.configs.update", - "request": { - "$ref": "RuntimeConfig" - }, - "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand.", - "response": { - "$ref": "RuntimeConfig" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PUT" - }, - "testIamPermissions": { - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions", - "path": "v1beta1/{+resource}:testIamPermissions", - "id": "runtimeconfig.projects.configs.testIamPermissions" - }, - "delete": { - "path": "v1beta1/{+name}", - "id": "runtimeconfig.projects.configs.delete", - "description": "Deletes a RuntimeConfig resource.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path", - "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}" - }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "parent": { - "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs", - "path": "v1beta1/{+parent}/configs", - "id": "runtimeconfig.projects.configs.list", - "description": "Lists all the RuntimeConfig resources within project.", - "response": { - "$ref": "ListConfigsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET" - } - }, "resources": { "variables": { "methods": { - "get": { - "response": { - "$ref": "Variable" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", - "location": "path", - "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}", - "path": "v1beta1/{+name}", - "id": "runtimeconfig.projects.configs.variables.get", - "description": "Gets information about a single variable." - }, - "watch": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", - "location": "path", - "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch", - "path": "v1beta1/{+name}:watch", - "id": "runtimeconfig.projects.configs.variables.watch", - "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation.", - "request": { - "$ref": "WatchVariableRequest" - }, - "response": { - "$ref": "Variable" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST" - }, "update": { - "path": "v1beta1/{+name}", "id": "runtimeconfig.projects.configs.variables.update", + "path": "v1beta1/{+name}", "request": { "$ref": "Variable" }, "description": "Updates an existing variable with a new value.", - "response": { - "$ref": "Variable" - }, + "httpMethod": "PUT", "parameterOrder": [ "name" ], - "httpMethod": "PUT", + "response": { + "$ref": "Variable" + }, "parameters": { "name": { "description": "The name of the variable to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", @@ -698,67 +56,66 @@ "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}" }, "testIamPermissions": { - "parameters": { - "resource": { - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions", - "id": "runtimeconfig.projects.configs.variables.testIamPermissions", - "path": "v1beta1/{+resource}:testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", "request": { "$ref": "TestIamPermissionsRequest" }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "httpMethod": "POST", + "response": { + "$ref": "TestIamPermissionsResponse" + }, "parameterOrder": [ "resource" ], - "response": { - "$ref": "TestIamPermissionsResponse" - } + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:testIamPermissions", + "path": "v1beta1/{+resource}:testIamPermissions", + "id": "runtimeconfig.projects.configs.variables.testIamPermissions" }, "delete": { + "id": "runtimeconfig.projects.configs.variables.delete", + "path": "v1beta1/{+name}", "description": "Deletes a variable or multiple variables.\n\nIf you specify a variable name, then that variable is deleted. If you\nspecify a prefix and `recursive` is true, then all variables with that\nprefix are deleted. You must set a `recursive` to true if you delete\nvariables by prefix.", "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, "parameterOrder": [ "name" ], + "response": { + "$ref": "Empty" + }, "parameters": { + "recursive": { + "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.", + "type": "boolean", + "location": "query" + }, "name": { - "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", - "location": "path", "description": "The name of the variable to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]`", "required": true, - "type": "string" - }, - "recursive": { - "location": "query", - "description": "Set to `true` to recursively delete multiple variables with the same\nprefix.", - "type": "boolean" + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudruntimeconfig" ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}", - "id": "runtimeconfig.projects.configs.variables.delete", - "path": "v1beta1/{+name}" + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}" }, "list": { - "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned.", "response": { "$ref": "ListVariablesResponse" }, @@ -767,33 +124,33 @@ ], "httpMethod": "GET", "parameters": { - "parent": { - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path", - "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "required": true, - "type": "string" - }, - "filter": { - "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.", - "type": "string", - "location": "query" - }, "pageToken": { "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", "type": "string", "location": "query" }, "returnValues": { + "location": "query", "description": "The flag indicates whether the user wants to return values of variables.\nIf true, then only those variables that user has IAM GetVariable permission\nwill be returned along with their values.", - "type": "boolean", - "location": "query" + "type": "boolean" }, "pageSize": { "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", "format": "int32", "type": "integer", "location": "query" + }, + "parent": { + "description": "The path to the RuntimeConfig resource for which you want to list variables.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path" + }, + "filter": { + "description": "Filters variables by matching the specified filter. For example:\n\n`projects/example-project/config/[CONFIG_NAME]/variables/example-variable`.", + "type": "string", + "location": "query" } }, "scopes": [ @@ -802,7 +159,8 @@ ], "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables", "path": "v1beta1/{+parent}/variables", - "id": "runtimeconfig.projects.configs.variables.list" + "id": "runtimeconfig.projects.configs.variables.list", + "description": "Lists variables within given a configuration, matching any provided filters.\nThis only lists variable names, not the values, unless `return_values` is\ntrue, in which case only variables that user has IAM permission to GetVariable\nwill be returned." }, "create": { "response": { @@ -817,17 +175,17 @@ "https://www.googleapis.com/auth/cloudruntimeconfig" ], "parameters": { + "requestId": { + "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", + "type": "string", + "location": "query" + }, "parent": { "pattern": "^projects/[^/]+/configs/[^/]+$", "location": "path", "description": "The path to the RutimeConfig resource that this variable should belong to.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "required": true, "type": "string" - }, - "requestId": { - "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", - "type": "string", - "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables", @@ -837,24 +195,20 @@ "request": { "$ref": "Variable" } - } - } - }, - "operations": { - "methods": { - "testIamPermissions": { - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], + }, + "watch": { "response": { - "$ref": "TestIamPermissionsResponse" + "$ref": "Variable" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", "parameters": { - "resource": { - "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$", + "name": { + "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "description": "The name of the variable to watch, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", "required": true, "type": "string" } @@ -863,15 +217,76 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudruntimeconfig" ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}:watch", + "path": "v1beta1/{+name}:watch", + "id": "runtimeconfig.projects.configs.variables.watch", + "request": { + "$ref": "WatchVariableRequest" + }, + "description": "Watches a specific variable and waits for a change in the variable's value.\nWhen there is a change, this method returns the new value or times out.\n\nIf a variable is deleted while being watched, the `variableState` state is\nset to `DELETED` and the method returns the last known variable `value`.\n\nIf you set the deadline for watching to a larger value than internal timeout\n(60 seconds), the current variable value is returned and the `variableState`\nwill be `VARIABLE_STATE_UNSPECIFIED`.\n\nTo learn more about creating a watcher, read the\n[Watching a Variable for Changes](/deployment-manager/runtime-configurator/watching-a-variable)\ndocumentation." + }, + "get": { + "description": "Gets information about a single variable.", + "response": { + "$ref": "Variable" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "parameters": { + "name": { + "description": "The name of the variable to return, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIBLE_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+/variables/.+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/variables/{variablesId}", + "path": "v1beta1/{+name}", + "id": "runtimeconfig.projects.configs.variables.get" + } + } + }, + "operations": { + "methods": { + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+/operations/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}:testIamPermissions", - "id": "runtimeconfig.projects.configs.operations.testIamPermissions", "path": "v1beta1/{+resource}:testIamPermissions", + "id": "runtimeconfig.projects.configs.operations.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." }, "get": { + "path": "v1beta1/{+name}", + "id": "runtimeconfig.projects.configs.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.", "response": { "$ref": "Operation" @@ -893,104 +308,17 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/cloudruntimeconfig" ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}", - "path": "v1beta1/{+name}", - "id": "runtimeconfig.projects.configs.operations.get" + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/operations/{operationsId}" } } }, "waiters": { "methods": { - "delete": { - "description": "Deletes the waiter with the specified name.", - "httpMethod": "DELETE", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}", - "id": "runtimeconfig.projects.configs.waiters.delete", - "path": "v1beta1/{+name}" - }, - "list": { - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", - "format": "int32", - "type": "integer" - }, - "parent": { - "pattern": "^projects/[^/]+/configs/[^/]+$", - "location": "path", - "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", - "required": true, - "type": "string" - } - }, - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters", - "path": "v1beta1/{+parent}/waiters", - "id": "runtimeconfig.projects.configs.waiters.list", - "description": "List waiters within the given configuration.", - "response": { - "$ref": "ListWaitersResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET" - }, - "get": { - "parameters": { - "name": { - "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", - "location": "path", - "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloudruntimeconfig" - ], - "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}", - "path": "v1beta1/{+name}", - "id": "runtimeconfig.projects.configs.waiters.get", - "description": "Gets information about a single waiter.", - "response": { + "create": { + "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.", + "request": { "$ref": "Waiter" }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET" - }, - "create": { "response": { "$ref": "Operation" }, @@ -1003,28 +331,31 @@ "https://www.googleapis.com/auth/cloudruntimeconfig" ], "parameters": { + "requestId": { + "location": "query", + "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", + "type": "string" + }, "parent": { "pattern": "^projects/[^/]+/configs/[^/]+$", "location": "path", "description": "The path to the configuration that will own the waiter.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`.", "required": true, "type": "string" - }, - "requestId": { - "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", - "type": "string", - "location": "query" } }, "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters", "path": "v1beta1/{+parent}/waiters", - "id": "runtimeconfig.projects.configs.waiters.create", - "description": "Creates a Waiter resource. This operation returns a long-running Operation\nresource which can be polled for completion. However, a waiter with the\ngiven name will exist (and can be retrieved) prior to the operation\ncompleting. If the operation fails, the failed Waiter resource will\nstill exist and must be deleted prior to subsequent creation attempts.", - "request": { - "$ref": "Waiter" - } + "id": "runtimeconfig.projects.configs.waiters.create" }, "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", "parameters": { "resource": { "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", @@ -1039,47 +370,411 @@ "https://www.googleapis.com/auth/cloudruntimeconfig" ], "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}:testIamPermissions", - "id": "runtimeconfig.projects.configs.waiters.testIamPermissions", "path": "v1beta1/{+resource}:testIamPermissions", + "id": "runtimeconfig.projects.configs.waiters.testIamPermissions", "request": { "$ref": "TestIamPermissionsRequest" }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." + }, + "delete": { + "description": "Deletes the waiter with the specified name.", "response": { - "$ref": "TestIamPermissionsResponse" - } + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The Waiter resource to delete, in the format:\n\n `projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}", + "path": "v1beta1/{+name}", + "id": "runtimeconfig.projects.configs.waiters.delete" + }, + "list": { + "response": { + "$ref": "ListWaitersResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "The path to the configuration for which you want to get a list of waiters.\nThe configuration must exist beforehand; the path must be in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters", + "path": "v1beta1/{+parent}/waiters", + "id": "runtimeconfig.projects.configs.waiters.list", + "description": "List waiters within the given configuration." + }, + "get": { + "path": "v1beta1/{+name}", + "id": "runtimeconfig.projects.configs.waiters.get", + "description": "Gets information about a single waiter.", + "response": { + "$ref": "Waiter" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The fully-qualified name of the Waiter resource object to retrieve, in the\nformat:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+/waiters/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}/waiters/{waitersId}" } } } + }, + "methods": { + "update": { + "httpMethod": "PUT", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "RuntimeConfig" + }, + "parameters": { + "name": { + "description": "The name of the RuntimeConfig resource to update, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}", + "id": "runtimeconfig.projects.configs.update", + "path": "v1beta1/{+name}", + "request": { + "$ref": "RuntimeConfig" + }, + "description": "Updates a RuntimeConfig resource. The configuration must exist beforehand." + }, + "testIamPermissions": { + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:testIamPermissions", + "id": "runtimeconfig.projects.configs.testIamPermissions", + "path": "v1beta1/{+resource}:testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." + }, + "delete": { + "path": "v1beta1/{+name}", + "id": "runtimeconfig.projects.configs.delete", + "description": "Deletes a RuntimeConfig resource.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "description": "The RuntimeConfig resource to delete, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}" + }, + "list": { + "response": { + "$ref": "ListConfigsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "parameters": { + "pageToken": { + "description": "Specifies a page token to use. Set `pageToken` to a `nextPageToken`\nreturned by a previous list request to get the next page of results.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Specifies the number of results to return per page. If there are fewer\nelements than the specified number, returns all elements.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/projects/{projectsId}/configs", + "path": "v1beta1/{+parent}/configs", + "id": "runtimeconfig.projects.configs.list", + "description": "Lists all the RuntimeConfig resources within project." + }, + "create": { + "response": { + "$ref": "RuntimeConfig" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "parameters": { + "requestId": { + "description": "An optional but recommended unique `request_id`. If the server\nreceives two `create()` requests with the same\n`request_id`, then the second request will be ignored and the\nfirst resource created and stored in the backend is returned.\nEmpty `request_id` fields are ignored.\n\nIt is responsibility of the client to ensure uniqueness of the\n`request_id` strings.\n\n`request_id` strings are limited to 64 characters.", + "type": "string", + "location": "query" + }, + "parent": { + "description": "The [project ID](https://support.google.com/cloud/answer/6158840?hl=en&ref_topic=6158848)\nfor this request, in the format `projects/[PROJECT_ID]`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs", + "path": "v1beta1/{+parent}/configs", + "id": "runtimeconfig.projects.configs.create", + "request": { + "$ref": "RuntimeConfig" + }, + "description": "Creates a new RuntimeConfig resource. The configuration name must be\nunique within project." + }, + "setIamPolicy": { + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:setIamPolicy", + "path": "v1beta1/{+resource}:setIamPolicy", + "id": "runtimeconfig.projects.configs.setIamPolicy" + }, + "getIamPolicy": { + "httpMethod": "GET", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}:getIamPolicy", + "id": "runtimeconfig.projects.configs.getIamPolicy", + "path": "v1beta1/{+resource}:getIamPolicy", + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "RuntimeConfig" + }, + "parameters": { + "name": { + "pattern": "^projects/[^/]+/configs/[^/]+$", + "location": "path", + "description": "The name of the RuntimeConfig resource to retrieve, in the format:\n\n`projects/[PROJECT_ID]/configs/[CONFIG_NAME]`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloudruntimeconfig" + ], + "flatPath": "v1beta1/projects/{projectsId}/configs/{configsId}", + "id": "runtimeconfig.projects.configs.get", + "path": "v1beta1/{+name}", + "description": "Gets information about a RuntimeConfig resource." + } } } } } }, "parameters": { - "callback": { - "description": "JSONP", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "$.xgafv": { + "enum": [ + "1", + "2" + ], "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" ], + "location": "query" + }, + "callback": { "location": "query", - "enum": [ - "1", - "2" - ] + "description": "JSONP", + "type": "string" }, "alt": { + "description": "Data format for response.", + "default": "json", "enum": [ "json", "media", @@ -1091,13 +786,6 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], - "location": "query", - "description": "Data format for response.", - "default": "json" - }, - "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.", - "type": "string", "location": "query" }, "access_token": { @@ -1105,49 +793,361 @@ "description": "OAuth access token.", "type": "string" }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", + "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.", "type": "string", "location": "query" } }, "version": "v1beta1", - "baseUrl": "https://runtimeconfig.googleapis.com/" + "baseUrl": "https://runtimeconfig.googleapis.com/", + "servicePath": "", + "description": "The Runtime Configurator allows you to dynamically configure and expose variables through Google Cloud Platform. In addition, you can also set Watchers and Waiters that will watch for changes to your data and return based on certain conditions.", + "kind": "discovery#restDescription", + "basePath": "", + "id": "runtimeconfig:v1beta1", + "documentationLink": "https://cloud.google.com/deployment-manager/runtime-configurator/", + "revision": "20171219", + "discoveryVersion": "v1", + "version_module": true, + "schemas": { + "Status": { + "properties": { + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + }, + "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" + } + }, + "id": "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.", + "type": "object" + }, + "Binding": { + "description": "Associates `members` with a `role`.", + "type": "object", + "properties": { + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + } + }, + "id": "Binding" + }, + "Cardinality": { + "description": "A Cardinality condition for the Waiter resource. A cardinality condition is\nmet when the number of variables under a specified path prefix reaches a\npredefined number. For example, if you set a Cardinality condition where\nthe `path` is set to `/foo` and the number of paths is set to 2, the\nfollowing variables would meet the condition in a RuntimeConfig resource:\n\n+ `/foo/variable1 = \"value1\"`\n+ `/foo/variable2 = \"value2\"`\n+ `/bar/variable3 = \"value3\"`\n\nIt would not would not satisify the same condition with the `number` set to\n3, however, because there is only 2 paths that start with `/foo`.\nCardinality conditions are recursive; all subtrees under the specific\npath prefix are counted.", + "type": "object", + "properties": { + "path": { + "description": "The root of the variable subtree to monitor. For example, `/foo`.", + "type": "string" + }, + "number": { + "description": "The number variables under the `path` that must exist to meet this\ncondition. Defaults to 1 if not specified.", + "format": "int32", + "type": "integer" + } + }, + "id": "Cardinality" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "ListConfigsResponse": { + "description": "`ListConfigs()` returns the following response. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", + "type": "string" + }, + "configs": { + "description": "A list of the configurations in the project. The order of returned\nobjects is arbitrary; that is, it is not ordered in any particular way.", + "type": "array", + "items": { + "$ref": "RuntimeConfig" + } + } + }, + "id": "ListConfigsResponse" + }, + "EndCondition": { + "properties": { + "cardinality": { + "description": "The cardinality of the `EndCondition`.", + "$ref": "Cardinality" + } + }, + "id": "EndCondition", + "description": "The condition that a Waiter resource is waiting for.", + "type": "object" + }, + "TestIamPermissionsResponse": { + "properties": { + "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsResponse", + "description": "Response message for `TestIamPermissions` method.", + "type": "object" + }, + "ListVariablesResponse": { + "description": "Response for the `ListVariables()` method.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", + "type": "string" + }, + "variables": { + "description": "A list of variables and their values. The order of returned variable\nobjects is arbitrary.", + "type": "array", + "items": { + "$ref": "Variable" + } + } + }, + "id": "ListVariablesResponse" + }, + "RuntimeConfig": { + "description": "A RuntimeConfig resource is the primary resource in the Cloud RuntimeConfig\nservice. A RuntimeConfig resource consists of metadata and a hierarchy of\nvariables.", + "type": "object", + "properties": { + "name": { + "description": "The resource name of a runtime config. The name must have the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, and `[CONFIG_NAME]` is an\narbitrary name that matches the\n`[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])?` regular expression.\nThe length of `[CONFIG_NAME]` must be less than 64 characters.\n\nYou pick the RuntimeConfig resource name, but the server will validate that\nthe name adheres to this format. After you create the resource, you cannot\nchange the resource's name.", + "type": "string" + }, + "description": { + "description": "An optional description of the RuntimeConfig object.", + "type": "string" + } + }, + "id": "RuntimeConfig" + }, + "WatchVariableRequest": { + "properties": { + "newerThan": { + "description": "If specified, checks the current timestamp of the variable and if the\ncurrent timestamp is newer than `newerThan` timestamp, the method returns\nimmediately.\n\nIf not specified or the variable has an older timestamp, the watcher waits\nfor a the value to change before returning.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "WatchVariableRequest", + "description": "Request for the `WatchVariable()` method.", + "type": "object" + }, + "ListWaitersResponse": { + "description": "Response for the `ListWaiters()` method.\nOrder of returned waiter objects is arbitrary.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "This token allows you to get the next page of results for list requests.\nIf the number of results is larger than `pageSize`, use the `nextPageToken`\nas a value for the query parameter `pageToken` in the next list request.\nSubsequent list requests will have their own `nextPageToken` to continue\npaging through the results", + "type": "string" + }, + "waiters": { + "description": "Found waiters in the project.", + "type": "array", + "items": { + "$ref": "Waiter" + } + } + }, + "id": "ListWaitersResponse" + }, + "Waiter": { + "properties": { + "failure": { + "$ref": "EndCondition", + "description": "[Optional] The failure condition of this waiter. If this condition is met,\n`done` will be set to `true` and the `error` code will be set to `ABORTED`.\nThe failure condition takes precedence over the success condition. If both\nconditions are met, a failure will be indicated. This value is optional; if\nno failure condition is set, the only failure scenario will be a timeout." + }, + "success": { + "description": "[Required] The success condition. If this condition is met, `done` will be\nset to `true` and the `error` value will remain unset. The failure condition\ntakes precedence over the success condition. If both conditions are met, a\nfailure will be indicated.", + "$ref": "EndCondition" + }, + "done": { + "description": "[Output Only] If the value is `false`, it means the waiter is still waiting\nfor one of its conditions to be met.\n\nIf true, the waiter has finished. If the waiter finished due to a timeout\nor failure, `error` will be set.", + "type": "boolean" + }, + "createTime": { + "description": "[Output Only] The instant at which this Waiter resource was created. Adding\nthe value of `timeout` to this instant yields the timeout deadline for the\nwaiter.", + "format": "google-datetime", + "type": "string" + }, + "timeout": { + "description": "[Required] Specifies the timeout of the waiter in seconds, beginning from\nthe instant that `waiters().create` method is called. If this time elapses\nbefore the success or failure conditions are met, the waiter fails and sets\nthe `error` code to `DEADLINE_EXCEEDED`.", + "format": "google-duration", + "type": "string" + }, + "name": { + "description": "The name of the Waiter resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/waiters/[WAITER_NAME]\n\nThe `[PROJECT_ID]` must be a valid Google Cloud project ID,\nthe `[CONFIG_NAME]` must be a valid RuntimeConfig resource, the\n`[WAITER_NAME]` must match RFC 1035 segment specification, and the length\nof `[WAITER_NAME]` must be less than 64 bytes.\n\nAfter you create a Waiter resource, you cannot change the resource name.", + "type": "string" + }, + "error": { + "$ref": "Status", + "description": "[Output Only] If the waiter ended due to a failure or timeout, this value\nwill be set." + } + }, + "id": "Waiter", + "description": "A Waiter resource waits for some end condition within a RuntimeConfig resource\nto be met before it returns. For example, assume you have a distributed\nsystem where each node writes to a Variable resource indidicating the node's\nreadiness as part of the startup process.\n\nYou then configure a Waiter resource with the success condition set to wait\nuntil some number of nodes have checked in. Afterwards, your application\nruns some arbitrary code after the condition has been met and the waiter\nreturns successfully.\n\nOnce created, a Waiter resource is immutable.\n\nTo learn more about using waiters, read the\n[Creating a Waiter](/deployment-manager/runtime-configurator/creating-a-waiter)\ndocumentation.", + "type": "object" + }, + "TestIamPermissionsRequest": { + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest", + "description": "Request message for `TestIamPermissions` method.", + "type": "object" + }, + "Variable": { + "properties": { + "value": { + "description": "The binary value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. The value must be\nbase64 encoded. Only one of `value` or `text` can be set.", + "format": "byte", + "type": "string" + }, + "updateTime": { + "description": "[Output Only] The time of the last variable update.", + "format": "google-datetime", + "type": "string" + }, + "state": { + "enum": [ + "VARIABLE_STATE_UNSPECIFIED", + "UPDATED", + "DELETED" + ], + "description": "[Ouput only] The current state of the variable. The variable state indicates\nthe outcome of the `variables().watch` call and is visible through the\n`get` and `list` calls.", + "type": "string", + "enumDescriptions": [ + "Default variable state.", + "The variable was updated, while `variables().watch` was executing.", + "The variable was deleted, while `variables().watch` was executing." + ] + }, + "name": { + "description": "The name of the variable resource, in the format:\n\n projects/[PROJECT_ID]/configs/[CONFIG_NAME]/variables/[VARIABLE_NAME]\n\nThe `[PROJECT_ID]` must be a valid project ID, `[CONFIG_NAME]` must be a\nvalid RuntimeConfig reource and `[VARIABLE_NAME]` follows Unix file system\nfile path naming.\n\nThe `[VARIABLE_NAME]` can contain ASCII letters, numbers, slashes and\ndashes. Slashes are used as path element separators and are not part of the\n`[VARIABLE_NAME]` itself, so `[VARIABLE_NAME]` must contain at least one\nnon-slash character. Multiple slashes are coalesced into single slash\ncharacter. Each path segment should match\n[0-9A-Za-z](?:[_.A-Za-z0-9-]{0,62}[_.A-Za-z0-9])? regular expression.\nThe length of a `[VARIABLE_NAME]` must be less than 256 characters.\n\nOnce you create a variable, you cannot change the variable name.", + "type": "string" + }, + "text": { + "description": "The string value of the variable. The length of the value must be less\nthan 4096 bytes. Empty values are also accepted. For example,\n`text: \"my text value\"`. The string must be valid UTF-8.", + "type": "string" + } + }, + "id": "Variable", + "description": "Describes a single variable within a RuntimeConfig resource.\nThe name denotes the hierarchical variable name. For example,\n`ports/serving_port` is a valid variable name. The variable value is an\nopaque string and only leaf variables can have values (that is, variables\nthat do not have any child variables).", + "type": "object" + }, + "Policy": { + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", + "type": "object", + "properties": { + "etag": { + "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", + "format": "byte", + "type": "string" + }, + "version": { + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32", + "type": "integer" + }, + "bindings": { + "description": "Associates a list of `members` to a `role`.\n`bindings` with no members will result in an error.", + "type": "array", + "items": { + "$ref": "Binding" + } + } + }, + "id": "Policy" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "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.", + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object" + } + }, + "id": "Operation" + }, + "SetIamPolicyRequest": { + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest", + "description": "Request message for `SetIamPolicy` method.", + "type": "object" + } + }, + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" + }, + "protocol": "rest" }
diff --git a/safebrowsing/v4/safebrowsing-api.json b/safebrowsing/v4/safebrowsing-api.json index 277a5f7..fb9239f 100644 --- a/safebrowsing/v4/safebrowsing-api.json +++ b/safebrowsing/v4/safebrowsing-api.json
@@ -1,92 +1,9 @@ { - "basePath": "", - "ownerDomain": "google.com", - "name": "safebrowsing", - "batchPath": "batch", - "revision": "20180103", - "documentationLink": "https://developers.google.com/safe-browsing/", - "id": "safebrowsing:v4", - "title": "Google Safe Browsing API", - "discoveryVersion": "v1", - "ownerName": "Google", "resources": { - "threatListUpdates": { - "methods": { - "fetch": { - "request": { - "$ref": "FetchThreatListUpdatesRequest" - }, - "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once.", - "response": { - "$ref": "FetchThreatListUpdatesResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "flatPath": "v4/threatListUpdates:fetch", - "path": "v4/threatListUpdates:fetch", - "id": "safebrowsing.threatListUpdates.fetch" - } - } - }, - "threatHits": { - "methods": { - "create": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "flatPath": "v4/threatHits", - "path": "v4/threatHits", - "id": "safebrowsing.threatHits.create", - "description": "Reports a Safe Browsing threat list hit to Google. Only projects with\nTRUSTED_REPORTER visibility can use this method.", - "request": { - "$ref": "ThreatHit" - } - } - } - }, - "encodedFullHashes": { - "methods": { - "get": { - "response": { - "$ref": "FindFullHashesResponse" - }, - "parameterOrder": [ - "encodedRequest" - ], - "httpMethod": "GET", - "parameters": { - "clientId": { - "type": "string", - "location": "query", - "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API." - }, - "clientVersion": { - "location": "query", - "description": "The version of the client implementation.", - "type": "string" - }, - "encodedRequest": { - "description": "A serialized FindFullHashesRequest proto.", - "format": "byte", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v4/encodedFullHashes/{encodedRequest}", - "path": "v4/encodedFullHashes/{encodedRequest}", - "id": "safebrowsing.encodedFullHashes.get", - "description": "" - } - } - }, "threatLists": { "methods": { "list": { + "description": "Lists the Safe Browsing threat lists available for download.", "response": { "$ref": "ListThreatListsResponse" }, @@ -95,27 +12,26 @@ "parameters": {}, "flatPath": "v4/threatLists", "path": "v4/threatLists", - "id": "safebrowsing.threatLists.list", - "description": "Lists the Safe Browsing threat lists available for download." + "id": "safebrowsing.threatLists.list" } } }, "threatMatches": { "methods": { "find": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "FindThreatMatchesResponse" - }, - "parameters": {}, - "flatPath": "v4/threatMatches:find", - "id": "safebrowsing.threatMatches.find", - "path": "v4/threatMatches:find", + "description": "Finds the threat entries that match the Safe Browsing lists.", "request": { "$ref": "FindThreatMatchesRequest" }, - "description": "Finds the threat entries that match the Safe Browsing lists." + "response": { + "$ref": "FindThreatMatchesResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "flatPath": "v4/threatMatches:find", + "path": "v4/threatMatches:find", + "id": "safebrowsing.threatMatches.find" } } }, @@ -123,17 +39,17 @@ "methods": { "find": { "flatPath": "v4/fullHashes:find", - "path": "v4/fullHashes:find", "id": "safebrowsing.fullHashes.find", - "description": "Finds the full hashes that match the requested hash prefixes.", + "path": "v4/fullHashes:find", "request": { "$ref": "FindFullHashesRequest" }, + "description": "Finds the full hashes that match the requested hash prefixes.", + "httpMethod": "POST", + "parameterOrder": [], "response": { "$ref": "FindFullHashesResponse" }, - "parameterOrder": [], - "httpMethod": "POST", "parameters": {} } } @@ -141,22 +57,18 @@ "encodedUpdates": { "methods": { "get": { + "flatPath": "v4/encodedUpdates/{encodedRequest}", + "path": "v4/encodedUpdates/{encodedRequest}", + "id": "safebrowsing.encodedUpdates.get", "description": "", - "httpMethod": "GET", - "parameterOrder": [ - "encodedRequest" - ], "response": { "$ref": "FetchThreatListUpdatesResponse" }, + "parameterOrder": [ + "encodedRequest" + ], + "httpMethod": "GET", "parameters": { - "encodedRequest": { - "location": "path", - "description": "A serialized FetchThreatListUpdatesRequest proto.", - "format": "byte", - "required": true, - "type": "string" - }, "clientId": { "location": "query", "description": "A client ID that uniquely identifies the client implementation of the Safe\nBrowsing API.", @@ -166,20 +78,108 @@ "description": "The version of the client implementation.", "type": "string", "location": "query" + }, + "encodedRequest": { + "description": "A serialized FetchThreatListUpdatesRequest proto.", + "format": "byte", + "required": true, + "type": "string", + "location": "path" + } + } + } + } + }, + "threatListUpdates": { + "methods": { + "fetch": { + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "FetchThreatListUpdatesResponse" + }, + "parameters": {}, + "flatPath": "v4/threatListUpdates:fetch", + "id": "safebrowsing.threatListUpdates.fetch", + "path": "v4/threatListUpdates:fetch", + "request": { + "$ref": "FetchThreatListUpdatesRequest" + }, + "description": "Fetches the most recent threat list updates. A client can request updates\nfor multiple lists at once." + } + } + }, + "threatHits": { + "methods": { + "create": { + "description": "Reports a Safe Browsing threat list hit to Google. Only projects with\nTRUSTED_REPORTER visibility can use this method.", + "request": { + "$ref": "ThreatHit" + }, + "response": { + "$ref": "Empty" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "flatPath": "v4/threatHits", + "path": "v4/threatHits", + "id": "safebrowsing.threatHits.create" + } + } + }, + "encodedFullHashes": { + "methods": { + "get": { + "description": "", + "response": { + "$ref": "FindFullHashesResponse" + }, + "parameterOrder": [ + "encodedRequest" + ], + "httpMethod": "GET", + "parameters": { + "clientId": { + "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.", + "type": "string", + "location": "query" + }, + "clientVersion": { + "description": "The version of the client implementation.", + "type": "string", + "location": "query" + }, + "encodedRequest": { + "location": "path", + "description": "A serialized FindFullHashesRequest proto.", + "format": "byte", + "required": true, + "type": "string" } }, - "flatPath": "v4/encodedUpdates/{encodedRequest}", - "id": "safebrowsing.encodedUpdates.get", - "path": "v4/encodedUpdates/{encodedRequest}" + "flatPath": "v4/encodedFullHashes/{encodedRequest}", + "path": "v4/encodedFullHashes/{encodedRequest}", + "id": "safebrowsing.encodedFullHashes.get" } } } }, "parameters": { - "upload_protocol": { - "type": "string", + "bearer_token": { "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" }, "prettyPrint": { "location": "query", @@ -188,16 +188,23 @@ "default": "true" }, "fields": { - "type": "string", "location": "query", - "description": "Selector specifying which fields to include in a partial response." + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, "$.xgafv": { + "description": "V1 error format.", + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -206,17 +213,9 @@ "enum": [ "1", "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" + ] }, "alt": { - "default": "json", "enum": [ "json", "media", @@ -229,37 +228,28 @@ "Responses with Content-Type of application/x-protobuf" ], "location": "query", - "description": "Data format for response." - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" + "description": "Data format for response.", + "default": "json" }, "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.", "type": "string", "location": "query" }, - "quotaUser": { + "access_token": { "location": "query", - "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.", + "description": "OAuth access token.", "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.", + "type": "string", + "location": "query" + }, "pp": { - "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", + "default": "true", "location": "query" } }, @@ -305,6 +295,18 @@ "description": "Request to return full hashes matched by the provided hash prefixes.", "type": "object", "properties": { + "client": { + "description": "The client metadata.", + "$ref": "ClientInfo" + }, + "threatInfo": { + "description": "The lists and hashes to be checked.", + "$ref": "ThreatInfo" + }, + "apiClient": { + "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation.", + "$ref": "ClientInfo" + }, "clientStates": { "description": "The current client states for each of the client's local threat lists.", "type": "array", @@ -312,24 +314,11 @@ "format": "byte", "type": "string" } - }, - "client": { - "$ref": "ClientInfo", - "description": "The client metadata." - }, - "threatInfo": { - "description": "The lists and hashes to be checked.", - "$ref": "ThreatInfo" - }, - "apiClient": { - "$ref": "ClientInfo", - "description": "Client metadata associated with callers of higher-level APIs built on top\nof the client's implementation." } }, "id": "FindFullHashesRequest" }, "FetchThreatListUpdatesRequest": { - "id": "FetchThreatListUpdatesRequest", "description": "Describes a Safe Browsing API update request. Clients can request updates for\nmultiple lists in a single request.\nNOTE: Field index 2 is unused.\nNEXT: 5", "type": "object", "properties": { @@ -341,13 +330,42 @@ } }, "client": { - "$ref": "ClientInfo", - "description": "The client metadata." + "description": "The client metadata.", + "$ref": "ClientInfo" } - } + }, + "id": "FetchThreatListUpdatesRequest" }, "ListUpdateResponse": { + "description": "An update to an individual list.", + "type": "object", "properties": { + "platformType": { + "description": "The platform type for which data is returned.", + "type": "string", + "enumDescriptions": [ + "Unknown platform.", + "Threat posed to Windows.", + "Threat posed to Linux.", + "Threat posed to Android.", + "Threat posed to OS X.", + "Threat posed to iOS.", + "Threat posed to at least one of the defined platforms.", + "Threat posed to all defined platforms.", + "Threat posed to Chrome." + ], + "enum": [ + "PLATFORM_TYPE_UNSPECIFIED", + "WINDOWS", + "LINUX", + "ANDROID", + "OSX", + "IOS", + "ANY_PLATFORM", + "ALL_PLATFORMS", + "CHROME" + ] + }, "threatEntryType": { "description": "The format of the threats.", "type": "string", @@ -377,41 +395,25 @@ "$ref": "ThreatEntrySet" } }, + "checksum": { + "$ref": "Checksum", + "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later." + }, "responseType": { - "enum": [ - "RESPONSE_TYPE_UNSPECIFIED", - "PARTIAL_UPDATE", - "FULL_UPDATE" - ], "description": "The type of response. This may indicate that an action is required by the\nclient when the response is received.", "type": "string", "enumDescriptions": [ "Unknown.", "Partial updates are applied to the client's existing local database.", "Full updates replace the client's entire local database. This means\nthat either the client was seriously out-of-date or the client is\nbelieved to be corrupt." + ], + "enum": [ + "RESPONSE_TYPE_UNSPECIFIED", + "PARTIAL_UPDATE", + "FULL_UPDATE" ] }, - "checksum": { - "description": "The expected SHA256 hash of the client state; that is, of the sorted list\nof all hashes present in the database after applying the provided update.\nIf the client state doesn't match the expected state, the client must\ndisregard this update and retry later.", - "$ref": "Checksum" - }, "threatType": { - "enum": [ - "THREAT_TYPE_UNSPECIFIED", - "MALWARE", - "SOCIAL_ENGINEERING", - "UNWANTED_SOFTWARE", - "POTENTIALLY_HARMFUL_APPLICATION", - "SOCIAL_ENGINEERING_INTERNAL", - "API_ABUSE", - "MALICIOUS_BINARY", - "CSD_WHITELIST", - "CSD_DOWNLOAD_WHITELIST", - "CLIENT_INCIDENT", - "CLIENT_INCIDENT_WHITELIST", - "APK_MALWARE_OFFLINE", - "SUBRESOURCE_FILTER" - ], "description": "The threat type for which data is returned.", "type": "string", "enumDescriptions": [ @@ -429,13 +431,24 @@ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.", "List used for offline APK checks in PAM.", "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list." + ], + "enum": [ + "THREAT_TYPE_UNSPECIFIED", + "MALWARE", + "SOCIAL_ENGINEERING", + "UNWANTED_SOFTWARE", + "POTENTIALLY_HARMFUL_APPLICATION", + "SOCIAL_ENGINEERING_INTERNAL", + "API_ABUSE", + "MALICIOUS_BINARY", + "CSD_WHITELIST", + "CSD_DOWNLOAD_WHITELIST", + "CLIENT_INCIDENT", + "CLIENT_INCIDENT_WHITELIST", + "APK_MALWARE_OFFLINE", + "SUBRESOURCE_FILTER" ] }, - "newClientState": { - "description": "The new client state, in encrypted format. Opaque to clients.", - "format": "byte", - "type": "string" - }, "removals": { "description": "A set of entries to remove from a local threat type's list. In practice,\nthis field is empty or contains exactly one ThreatEntrySet.", "type": "array", @@ -443,71 +456,24 @@ "$ref": "ThreatEntrySet" } }, - "platformType": { - "type": "string", - "enumDescriptions": [ - "Unknown platform.", - "Threat posed to Windows.", - "Threat posed to Linux.", - "Threat posed to Android.", - "Threat posed to OS X.", - "Threat posed to iOS.", - "Threat posed to at least one of the defined platforms.", - "Threat posed to all defined platforms.", - "Threat posed to Chrome." - ], - "enum": [ - "PLATFORM_TYPE_UNSPECIFIED", - "WINDOWS", - "LINUX", - "ANDROID", - "OSX", - "IOS", - "ANY_PLATFORM", - "ALL_PLATFORMS", - "CHROME" - ], - "description": "The platform type for which data is returned." + "newClientState": { + "description": "The new client state, in encrypted format. Opaque to clients.", + "format": "byte", + "type": "string" } }, - "id": "ListUpdateResponse", - "description": "An update to an individual list.", - "type": "object" + "id": "ListUpdateResponse" }, "ThreatMatch": { "description": "A match when checking a threat entry in the Safe Browsing threat lists.", "type": "object", "properties": { - "threatEntryType": { - "enum": [ - "THREAT_ENTRY_TYPE_UNSPECIFIED", - "URL", - "EXECUTABLE", - "IP_RANGE", - "CHROME_EXTENSION", - "FILENAME", - "CERT" - ], - "description": "The threat entry type matching this threat.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "A URL.", - "An executable program.", - "An IP range.", - "Chrome extension.", - "Filename.", - "CERT" - ] - }, "cacheDuration": { "description": "The cache lifetime for the returned match. Clients must not cache this\nresponse for more than this duration to avoid false positives.", "format": "google-duration", "type": "string" }, "threatType": { - "description": "The threat type matching this threat.", - "type": "string", "enumDescriptions": [ "Unknown.", "Malware threat type.", @@ -539,7 +505,9 @@ "CLIENT_INCIDENT_WHITELIST", "APK_MALWARE_OFFLINE", "SUBRESOURCE_FILTER" - ] + ], + "description": "The threat type matching this threat.", + "type": "string" }, "threatEntryMetadata": { "$ref": "ThreatEntryMetadata", @@ -574,11 +542,35 @@ ], "description": "The platform type matching this threat.", "type": "string" + }, + "threatEntryType": { + "description": "The threat entry type matching this threat.", + "type": "string", + "enumDescriptions": [ + "Unspecified.", + "A URL.", + "An executable program.", + "An IP range.", + "Chrome extension.", + "Filename.", + "CERT" + ], + "enum": [ + "THREAT_ENTRY_TYPE_UNSPECIFIED", + "URL", + "EXECUTABLE", + "IP_RANGE", + "CHROME_EXTENSION", + "FILENAME", + "CERT" + ] } }, "id": "ThreatMatch" }, "ThreatEntry": { + "description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set.", + "type": "object", "properties": { "digest": { "description": "The digest of an executable in SHA256 format. The API supports both\nbinary and hex digests. For JSON requests, digests are base64-encoded.", @@ -591,65 +583,56 @@ "type": "string" }, "url": { - "type": "string", - "description": "A URL." + "description": "A URL.", + "type": "string" } }, - "id": "ThreatEntry", - "description": "An individual threat; for example, a malicious URL or its hash\nrepresentation. Only one of these fields should be set.", - "type": "object" + "id": "ThreatEntry" }, "MetadataEntry": { + "description": "A single metadata entry.", + "type": "object", "properties": { - "key": { - "description": "The metadata entry key. For JSON requests, the key is base64-encoded.", - "format": "byte", - "type": "string" - }, "value": { "description": "The metadata entry value. For JSON requests, the value is base64-encoded.", "format": "byte", "type": "string" + }, + "key": { + "description": "The metadata entry key. For JSON requests, the key is base64-encoded.", + "format": "byte", + "type": "string" } }, - "id": "MetadataEntry", - "description": "A single metadata entry.", - "type": "object" + "id": "MetadataEntry" }, "FindThreatMatchesRequest": { "description": "Request to check entries against lists.", "type": "object", "properties": { - "threatInfo": { - "$ref": "ThreatInfo", - "description": "The lists and entries to be checked for matches." - }, "client": { "$ref": "ClientInfo", "description": "The client metadata." + }, + "threatInfo": { + "description": "The lists and entries to be checked for matches.", + "$ref": "ThreatInfo" } }, "id": "FindThreatMatchesRequest" }, - "RawIndices": { - "description": "A set of raw indices to remove from a local list.", - "type": "object", - "properties": { - "indices": { - "type": "array", - "items": { - "format": "int32", - "type": "integer" - }, - "description": "The indices to remove from a lexicographically-sorted local list." - } - }, - "id": "RawIndices" - }, "ThreatSource": { "description": "A single resource related to a threat hit.", "type": "object", "properties": { + "remoteIp": { + "description": "The remote IP of the resource in ASCII format. Either IPv4 or IPv6.", + "type": "string" + }, + "referrer": { + "description": "Referrer of the resource. Only set if the referrer is available.", + "type": "string" + }, "type": { "description": "The type of source reported.", "type": "string", @@ -671,35 +654,43 @@ "url": { "description": "The URL of the resource.", "type": "string" - }, - "remoteIp": { - "description": "The remote IP of the resource in ASCII format. Either IPv4 or IPv6.", - "type": "string" - }, - "referrer": { - "description": "Referrer of the resource. Only set if the referrer is available.", - "type": "string" } }, "id": "ThreatSource" }, - "UserInfo": { + "RawIndices": { + "description": "A set of raw indices to remove from a local list.", + "type": "object", "properties": { - "regionCode": { - "type": "string", - "description": "The UN M.49 region code associated with the user's location." - }, + "indices": { + "description": "The indices to remove from a lexicographically-sorted local list.", + "type": "array", + "items": { + "format": "int32", + "type": "integer" + } + } + }, + "id": "RawIndices" + }, + "UserInfo": { + "description": "Details about the user that encountered the threat.", + "type": "object", + "properties": { "userId": { "description": "Unique user identifier defined by the client.", "format": "byte", "type": "string" + }, + "regionCode": { + "description": "The UN M.49 region code associated with the user's location.", + "type": "string" } }, - "id": "UserInfo", - "description": "Details about the user that encountered the threat.", - "type": "object" + "id": "UserInfo" }, "FetchThreatListUpdatesResponse": { + "type": "object", "properties": { "listUpdateResponses": { "description": "The list updates requested by the clients.", @@ -714,20 +705,7 @@ "type": "string" } }, - "id": "FetchThreatListUpdatesResponse", - "type": "object" - }, - "Checksum": { - "id": "Checksum", - "description": "The expected state of a client's local database.", - "type": "object", - "properties": { - "sha256": { - "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.", - "format": "byte", - "type": "string" - } - } + "id": "FetchThreatListUpdatesResponse" }, "FindFullHashesResponse": { "type": "object", @@ -752,17 +730,23 @@ }, "id": "FindFullHashesResponse" }, + "Checksum": { + "description": "The expected state of a client's local database.", + "type": "object", + "properties": { + "sha256": { + "description": "The SHA256 hash of the client state; that is, of the sorted list of all\nhashes present in the database.", + "format": "byte", + "type": "string" + } + }, + "id": "Checksum" + }, "ThreatEntrySet": { "description": "A set of threats that should be added or removed from a client's local\ndatabase.", "type": "object", "properties": { - "riceHashes": { - "$ref": "RiceDeltaEncoding", - "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data." - }, "compressionType": { - "description": "The compression type for the entries in this set.", - "type": "string", "enumDescriptions": [ "Unknown.", "Raw, uncompressed data.", @@ -772,7 +756,9 @@ "COMPRESSION_TYPE_UNSPECIFIED", "RAW", "RICE" - ] + ], + "description": "The compression type for the entries in this set.", + "type": "string" }, "riceIndices": { "$ref": "RiceDeltaEncoding", @@ -783,8 +769,12 @@ "description": "The raw removal indices for a local list." }, "rawHashes": { - "$ref": "RawHashes", - "description": "The raw SHA256-formatted entries." + "description": "The raw SHA256-formatted entries.", + "$ref": "RawHashes" + }, + "riceHashes": { + "$ref": "RiceDeltaEncoding", + "description": "The encoded 4-byte prefixes of SHA256-formatted entries, using a\nGolomb-Rice encoding. The hashes are converted to uint32, sorted in\nascending order, then delta encoded and stored as encoded_data." } }, "id": "ThreatEntrySet" @@ -792,7 +782,56 @@ "ThreatHit": { "type": "object", "properties": { + "threatType": { + "description": "The threat type reported.", + "type": "string", + "enumDescriptions": [ + "Unknown.", + "Malware threat type.", + "Social engineering threat type.", + "Unwanted software threat type.", + "Potentially harmful application threat type.", + "Social engineering threat type for internal use.", + "API abuse threat type.", + "Malicious binary threat type.", + "Client side detection whitelist threat type.", + "Client side download detection whitelist threat type.", + "Client incident threat type.", + "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.", + "List used for offline APK checks in PAM.", + "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list." + ], + "enum": [ + "THREAT_TYPE_UNSPECIFIED", + "MALWARE", + "SOCIAL_ENGINEERING", + "UNWANTED_SOFTWARE", + "POTENTIALLY_HARMFUL_APPLICATION", + "SOCIAL_ENGINEERING_INTERNAL", + "API_ABUSE", + "MALICIOUS_BINARY", + "CSD_WHITELIST", + "CSD_DOWNLOAD_WHITELIST", + "CLIENT_INCIDENT", + "CLIENT_INCIDENT_WHITELIST", + "APK_MALWARE_OFFLINE", + "SUBRESOURCE_FILTER" + ] + }, + "resources": { + "description": "The resources related to the threat hit.", + "type": "array", + "items": { + "$ref": "ThreatSource" + } + }, + "entry": { + "description": "The threat entry responsible for the hit. Full hash should be reported for\nhash-based hits.", + "$ref": "ThreatEntry" + }, "platformType": { + "description": "The platform type reported.", + "type": "string", "enumDescriptions": [ "Unknown platform.", "Threat posed to Windows.", @@ -814,9 +853,7 @@ "ANY_PLATFORM", "ALL_PLATFORMS", "CHROME" - ], - "description": "The platform type reported.", - "type": "string" + ] }, "userInfo": { "$ref": "UserInfo", @@ -825,53 +862,6 @@ "clientInfo": { "description": "Client-reported identification.", "$ref": "ClientInfo" - }, - "threatType": { - "enum": [ - "THREAT_TYPE_UNSPECIFIED", - "MALWARE", - "SOCIAL_ENGINEERING", - "UNWANTED_SOFTWARE", - "POTENTIALLY_HARMFUL_APPLICATION", - "SOCIAL_ENGINEERING_INTERNAL", - "API_ABUSE", - "MALICIOUS_BINARY", - "CSD_WHITELIST", - "CSD_DOWNLOAD_WHITELIST", - "CLIENT_INCIDENT", - "CLIENT_INCIDENT_WHITELIST", - "APK_MALWARE_OFFLINE", - "SUBRESOURCE_FILTER" - ], - "description": "The threat type reported.", - "type": "string", - "enumDescriptions": [ - "Unknown.", - "Malware threat type.", - "Social engineering threat type.", - "Unwanted software threat type.", - "Potentially harmful application threat type.", - "Social engineering threat type for internal use.", - "API abuse threat type.", - "Malicious binary threat type.", - "Client side detection whitelist threat type.", - "Client side download detection whitelist threat type.", - "Client incident threat type.", - "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.", - "List used for offline APK checks in PAM.", - "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list." - ] - }, - "resources": { - "type": "array", - "items": { - "$ref": "ThreatSource" - }, - "description": "The resources related to the threat hit." - }, - "entry": { - "$ref": "ThreatEntry", - "description": "The threat entry responsible for the hit. Full hash should be reported for\nhash-based hits." } }, "id": "ThreatHit" @@ -880,6 +870,11 @@ "description": "A single list update request.", "type": "object", "properties": { + "state": { + "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).", + "format": "byte", + "type": "string" + }, "platformType": { "enumDescriptions": [ "Unknown platform.", @@ -907,22 +902,6 @@ "type": "string" }, "threatType": { - "enum": [ - "THREAT_TYPE_UNSPECIFIED", - "MALWARE", - "SOCIAL_ENGINEERING", - "UNWANTED_SOFTWARE", - "POTENTIALLY_HARMFUL_APPLICATION", - "SOCIAL_ENGINEERING_INTERNAL", - "API_ABUSE", - "MALICIOUS_BINARY", - "CSD_WHITELIST", - "CSD_DOWNLOAD_WHITELIST", - "CLIENT_INCIDENT", - "CLIENT_INCIDENT_WHITELIST", - "APK_MALWARE_OFFLINE", - "SUBRESOURCE_FILTER" - ], "description": "The type of threat posed by entries present in the list.", "type": "string", "enumDescriptions": [ @@ -940,6 +919,22 @@ "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.", "List used for offline APK checks in PAM.", "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list." + ], + "enum": [ + "THREAT_TYPE_UNSPECIFIED", + "MALWARE", + "SOCIAL_ENGINEERING", + "UNWANTED_SOFTWARE", + "POTENTIALLY_HARMFUL_APPLICATION", + "SOCIAL_ENGINEERING_INTERNAL", + "API_ABUSE", + "MALICIOUS_BINARY", + "CSD_WHITELIST", + "CSD_DOWNLOAD_WHITELIST", + "CLIENT_INCIDENT", + "CLIENT_INCIDENT_WHITELIST", + "APK_MALWARE_OFFLINE", + "SUBRESOURCE_FILTER" ] }, "constraints": { @@ -967,11 +962,6 @@ ], "description": "The types of entries present in the list.", "type": "string" - }, - "state": { - "type": "string", - "description": "The current state of the client for the requested list (the encrypted\nclient state that was received from the last successful list update).", - "format": "byte" } }, "id": "ListUpdateRequest" @@ -990,21 +980,21 @@ "type": "string" }, "supportedCompressions": { - "enumDescriptions": [ - "Unknown.", - "Raw, uncompressed data.", - "Rice-Golomb encoded data." - ], "description": "The compression types supported by the client.", "type": "array", "items": { - "type": "string", "enum": [ "COMPRESSION_TYPE_UNSPECIFIED", "RAW", "RICE" - ] - } + ], + "type": "string" + }, + "enumDescriptions": [ + "Unknown.", + "Raw, uncompressed data.", + "Rice-Golomb encoded data." + ] }, "maxUpdateEntries": { "description": "The maximum size in number of entries. The update will not contain more\nentries than this value. This should be a power of 2 between 2**10 and\n2**20. If zero, no update size limit is set.", @@ -1014,33 +1004,6 @@ }, "id": "Constraints" }, - "RiceDeltaEncoding": { - "type": "object", - "properties": { - "riceParameter": { - "type": "integer", - "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.", - "format": "int32" - }, - "firstValue": { - "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.", - "format": "int64", - "type": "string" - }, - "encodedData": { - "description": "The encoded deltas that are encoded using the Golomb-Rice coder.", - "format": "byte", - "type": "string" - }, - "numEntries": { - "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.", - "format": "int32", - "type": "integer" - } - }, - "id": "RiceDeltaEncoding", - "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices." - }, "ListThreatListsResponse": { "type": "object", "properties": { @@ -1054,7 +1017,35 @@ }, "id": "ListThreatListsResponse" }, + "RiceDeltaEncoding": { + "description": "The Rice-Golomb encoded data. Used for sending compressed 4-byte hashes or\ncompressed removal indices.", + "type": "object", + "properties": { + "firstValue": { + "description": "The offset of the first entry in the encoded data, or, if only a single\ninteger was encoded, that single integer's value.", + "format": "int64", + "type": "string" + }, + "encodedData": { + "description": "The encoded deltas that are encoded using the Golomb-Rice coder.", + "format": "byte", + "type": "string" + }, + "numEntries": { + "description": "The number of entries that are delta encoded in the encoded data. If only a\nsingle integer was encoded, this will be zero and the single value will be\nstored in `first_value`.", + "format": "int32", + "type": "integer" + }, + "riceParameter": { + "description": "The Golomb-Rice parameter, which is a number between 2 and 28. This field\nis missing (that is, zero) if `num_entries` is zero.", + "format": "int32", + "type": "integer" + } + }, + "id": "RiceDeltaEncoding" + }, "FindThreatMatchesResponse": { + "type": "object", "properties": { "matches": { "description": "The threat list matches.", @@ -1064,47 +1055,13 @@ } } }, - "id": "FindThreatMatchesResponse", - "type": "object" + "id": "FindThreatMatchesResponse" }, "ThreatListDescriptor": { "description": "Describes an individual threat list. A list is defined by three parameters:\nthe type of threat posed, the type of platform targeted by the threat, and\nthe type of entries in the list.", "type": "object", "properties": { - "threatEntryType": { - "enumDescriptions": [ - "Unspecified.", - "A URL.", - "An executable program.", - "An IP range.", - "Chrome extension.", - "Filename.", - "CERT" - ], - "enum": [ - "THREAT_ENTRY_TYPE_UNSPECIFIED", - "URL", - "EXECUTABLE", - "IP_RANGE", - "CHROME_EXTENSION", - "FILENAME", - "CERT" - ], - "description": "The entry types contained in the list.", - "type": "string" - }, "platformType": { - "enum": [ - "PLATFORM_TYPE_UNSPECIFIED", - "WINDOWS", - "LINUX", - "ANDROID", - "OSX", - "IOS", - "ANY_PLATFORM", - "ALL_PLATFORMS", - "CHROME" - ], "description": "The platform type targeted by the list's entries.", "type": "string", "enumDescriptions": [ @@ -1117,9 +1074,22 @@ "Threat posed to at least one of the defined platforms.", "Threat posed to all defined platforms.", "Threat posed to Chrome." + ], + "enum": [ + "PLATFORM_TYPE_UNSPECIFIED", + "WINDOWS", + "LINUX", + "ANDROID", + "OSX", + "IOS", + "ANY_PLATFORM", + "ALL_PLATFORMS", + "CHROME" ] }, "threatType": { + "description": "The threat type posed by the list's entries.", + "type": "string", "enumDescriptions": [ "Unknown.", "Malware threat type.", @@ -1151,33 +1121,98 @@ "CLIENT_INCIDENT_WHITELIST", "APK_MALWARE_OFFLINE", "SUBRESOURCE_FILTER" + ] + }, + "threatEntryType": { + "description": "The entry types contained in the list.", + "type": "string", + "enumDescriptions": [ + "Unspecified.", + "A URL.", + "An executable program.", + "An IP range.", + "Chrome extension.", + "Filename.", + "CERT" ], - "description": "The threat type posed by the list's entries.", - "type": "string" + "enum": [ + "THREAT_ENTRY_TYPE_UNSPECIFIED", + "URL", + "EXECUTABLE", + "IP_RANGE", + "CHROME_EXTENSION", + "FILENAME", + "CERT" + ] } }, "id": "ThreatListDescriptor" }, "ClientInfo": { - "id": "ClientInfo", "description": "The client metadata associated with Safe Browsing API requests.", "type": "object", "properties": { - "clientId": { - "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.", - "type": "string" - }, "clientVersion": { "description": "The version of the client implementation.", "type": "string" + }, + "clientId": { + "description": "A client ID that (hopefully) uniquely identifies the client implementation\nof the Safe Browsing API.", + "type": "string" } - } + }, + "id": "ClientInfo" }, "ThreatInfo": { "description": "The information regarding one or more threats that a client submits when\nchecking for matches in threat lists.", "type": "object", "properties": { + "platformTypes": { + "description": "The platform types to be checked.", + "type": "array", + "items": { + "enum": [ + "PLATFORM_TYPE_UNSPECIFIED", + "WINDOWS", + "LINUX", + "ANDROID", + "OSX", + "IOS", + "ANY_PLATFORM", + "ALL_PLATFORMS", + "CHROME" + ], + "type": "string" + }, + "enumDescriptions": [ + "Unknown platform.", + "Threat posed to Windows.", + "Threat posed to Linux.", + "Threat posed to Android.", + "Threat posed to OS X.", + "Threat posed to iOS.", + "Threat posed to at least one of the defined platforms.", + "Threat posed to all defined platforms.", + "Threat posed to Chrome." + ] + }, + "threatEntries": { + "description": "The threat entries to be checked.", + "type": "array", + "items": { + "$ref": "ThreatEntry" + } + }, "threatEntryTypes": { + "enumDescriptions": [ + "Unspecified.", + "A URL.", + "An executable program.", + "An IP range.", + "Chrome extension.", + "Filename.", + "CERT" + ], "description": "The entry types to be checked.", "type": "array", "items": { @@ -1191,34 +1226,9 @@ "CERT" ], "type": "string" - }, - "enumDescriptions": [ - "Unspecified.", - "A URL.", - "An executable program.", - "An IP range.", - "Chrome extension.", - "Filename.", - "CERT" - ] + } }, "threatTypes": { - "enumDescriptions": [ - "Unknown.", - "Malware threat type.", - "Social engineering threat type.", - "Unwanted software threat type.", - "Potentially harmful application threat type.", - "Social engineering threat type for internal use.", - "API abuse threat type.", - "Malicious binary threat type.", - "Client side detection whitelist threat type.", - "Client side download detection whitelist threat type.", - "Client incident threat type.", - "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.", - "List used for offline APK checks in PAM.", - "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list." - ], "description": "The threat types to be checked.", "type": "array", "items": { @@ -1239,57 +1249,47 @@ "SUBRESOURCE_FILTER" ], "type": "string" - } - }, - "platformTypes": { + }, "enumDescriptions": [ - "Unknown platform.", - "Threat posed to Windows.", - "Threat posed to Linux.", - "Threat posed to Android.", - "Threat posed to OS X.", - "Threat posed to iOS.", - "Threat posed to at least one of the defined platforms.", - "Threat posed to all defined platforms.", - "Threat posed to Chrome." - ], - "description": "The platform types to be checked.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "PLATFORM_TYPE_UNSPECIFIED", - "WINDOWS", - "LINUX", - "ANDROID", - "OSX", - "IOS", - "ANY_PLATFORM", - "ALL_PLATFORMS", - "CHROME" - ] - } - }, - "threatEntries": { - "description": "The threat entries to be checked.", - "type": "array", - "items": { - "$ref": "ThreatEntry" - } + "Unknown.", + "Malware threat type.", + "Social engineering threat type.", + "Unwanted software threat type.", + "Potentially harmful application threat type.", + "Social engineering threat type for internal use.", + "API abuse threat type.", + "Malicious binary threat type.", + "Client side detection whitelist threat type.", + "Client side download detection whitelist threat type.", + "Client incident threat type.", + "Whitelist used when detecting client incident threats.\nThis enum was never launched and should be re-used for the next list.", + "List used for offline APK checks in PAM.", + "Patterns to be used for activating the subresource filter. Interstitial\nwill not be shown for patterns from this list." + ] } }, "id": "ThreatInfo" } }, - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, "protocol": "rest", + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" + }, "version": "v4", "baseUrl": "https://safebrowsing.googleapis.com/", - "kind": "discovery#restDescription", "servicePath": "", "description": "Enables client applications to check web resources (most commonly URLs) against Google-generated lists of unsafe web resources.", - "rootUrl": "https://safebrowsing.googleapis.com/" + "kind": "discovery#restDescription", + "rootUrl": "https://safebrowsing.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "safebrowsing", + "batchPath": "batch", + "revision": "20180103", + "documentationLink": "https://developers.google.com/safe-browsing/", + "id": "safebrowsing:v4", + "title": "Google Safe Browsing API", + "discoveryVersion": "v1", + "ownerName": "Google" }
diff --git a/script/v1/script-api.json b/script/v1/script-api.json index 11db4b8..1c1d871 100644 --- a/script/v1/script-api.json +++ b/script/v1/script-api.json
@@ -1,102 +1,75 @@ { - "auth": { - "oauth2": { - "scopes": { - "https://www.google.com/calendar/feeds": { - "description": "Manage your calendars" - }, - "https://www.googleapis.com/auth/groups": { - "description": "View and manage your Google Groups" - }, - "https://www.googleapis.com/auth/forms.currentonly": { - "description": "View and manage forms that this application has been installed in" - }, - "https://www.googleapis.com/auth/drive": { - "description": "View and manage the files in your Google Drive" - }, - "https://www.googleapis.com/auth/admin.directory.user": { - "description": "View and manage the provisioning of users on your domain" - }, - "https://www.googleapis.com/auth/admin.directory.group": { - "description": "View and manage the provisioning of groups on your domain" - }, - "https://mail.google.com/": { - "description": "Read, send, delete, and manage your email" - }, - "https://www.googleapis.com/auth/spreadsheets": { - "description": "View and manage your spreadsheets in Google Drive" - }, - "https://www.googleapis.com/auth/forms": { - "description": "View and manage your forms in Google Drive" - }, - "https://www.google.com/m8/feeds": { - "description": "Manage your contacts" - }, - "https://www.googleapis.com/auth/userinfo.email": { - "description": "View your email address" - } - } - } - }, - "servicePath": "", - "description": "An API for managing and executing Google Apps Script projects.", - "kind": "discovery#restDescription", - "rootUrl": "https://script.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "script", - "batchPath": "batch", - "revision": "20180104", - "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run", - "id": "script:v1", - "fullyEncodeReservedExpansion": true, - "title": "Google Apps Script API", - "discoveryVersion": "v1", - "ownerName": "Google", - "resources": { - "scripts": { - "methods": { - "run": { - "request": { - "$ref": "ExecutionRequest" - }, - "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "scriptId" - ], - "httpMethod": "POST", - "parameters": { - "scriptId": { - "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://mail.google.com/", - "https://www.google.com/calendar/feeds", - "https://www.google.com/m8/feeds", - "https://www.googleapis.com/auth/admin.directory.group", - "https://www.googleapis.com/auth/admin.directory.user", - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/forms", - "https://www.googleapis.com/auth/forms.currentonly", - "https://www.googleapis.com/auth/groups", - "https://www.googleapis.com/auth/spreadsheets", - "https://www.googleapis.com/auth/userinfo.email" - ], - "flatPath": "v1/scripts/{scriptId}:run", - "path": "v1/scripts/{scriptId}:run", - "id": "script.scripts.run" - } - } - } - }, "parameters": { + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "type": "string", + "location": "query", + "description": "OAuth access token." + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "type": "boolean", + "default": "true", + "location": "query", + "description": "Pretty-print response." + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "type": "boolean", + "default": "true", + "location": "query", + "description": "Returns response with indentations and line breaks." + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format." + }, "alt": { "enum": [ "json", @@ -112,80 +85,11 @@ "location": "query", "description": "Data format for response.", "default": "json" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" } }, "schemas": { "Status": { + "id": "Status", "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, the response body's error field contains this `Status` object.", "type": "object", "properties": { @@ -197,11 +101,11 @@ "description": "An array that contains a single ExecutionError object that provides information about the nature of the error.", "type": "array", "items": { + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "type": "object" + } } }, "code": { @@ -209,8 +113,7 @@ "format": "int32", "type": "integer" } - }, - "id": "Status" + } }, "ExecutionRequest": { "description": "A request to run the function in a script. The script is identified by the\nspecified `script_id`. Executing a function on a script returns results\nbased on the implementation of the script.", @@ -225,11 +128,11 @@ "type": "boolean" }, "parameters": { - "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional.", "type": "array", "items": { "type": "any" - } + }, + "description": "The parameters to be passed to the function being executed. The object type\nfor each parameter should match the expected type in Apps Script.\nParameters cannot be Apps Script-specific object types (such as a\n`Document` or a `Calendar`); they can only be primitive types such as\n`string`, `number`, `array`, `object`, or `boolean`. Optional." }, "sessionState": { "description": "For Android add-ons only. An ID that represents the user's current session\nin the Android app for Google Docs or Sheets, included as extra data in the\n[Intent](https://developer.android.com/guide/components/intents-filters.html)\nthat launches the add-on. When an Android add-on is run with a session\nstate, it gains the privileges of a\n[bound](https://developers.google.com/apps-script/guides/bound)\nscript—that is, it can access information like the user's current\ncursor position (in Docs) or selected cell (in Sheets). To retrieve the\nstate, call\n`Intent.getStringExtra(\"com.google.android.apps.docs.addons.SessionState\")`.\nOptional.", @@ -239,17 +142,18 @@ "id": "ExecutionRequest" }, "ExecutionResponse": { - "description": "An object that provides the return value of a function executed using the\nApps Script API. If the script function returns successfully, the response\nbody's response field contains this\n`ExecutionResponse` object.", - "type": "object", "properties": { "result": { "description": "The return value of the script function. The type matches the object type\nreturned in Apps Script. Functions called using the Apps Script API cannot\nreturn Apps Script-specific objects (such as a `Document` or a `Calendar`);\nthey can only return primitive types such as a `string`, `number`, `array`,\n`object`, or `boolean`.", "type": "any" } }, - "id": "ExecutionResponse" + "id": "ExecutionResponse", + "description": "An object that provides the return value of a function executed using the\nApps Script API. If the script function returns successfully, the response\nbody's response field contains this\n`ExecutionResponse` object.", + "type": "object" }, "Operation": { + "id": "Operation", "description": "A representation of a execution of an Apps Script function that is started using run. The execution response does not arrive until the function finishes executing. The maximum execution runtime is listed in the [Apps Script quotas guide](/apps-script/guides/services/quotas#current_limitations). \u003cp\u003eAfter the execution is started, it can have one of four outcomes:\u003c/p\u003e \u003cul\u003e \u003cli\u003e If the script function returns successfully, the\n response field contains an\n ExecutionResponse object\n with the function's return value in the object's `result` field.\u003c/li\u003e\n\u003cli\u003e If the script function (or Apps Script itself) throws an exception, the\n error field contains a\n Status object. The `Status` object's `details`\n field contains an array with a single\n ExecutionError object that\n provides information about the nature of the error.\u003c/li\u003e\n\u003cli\u003e If the execution has not yet completed,\n the done field is `false` and\n the neither the `response` nor `error` fields are present.\u003c/li\u003e\n\u003cli\u003e If the `run` call itself fails (for example, because of a\n malformed request or an authorization error), the method returns an HTTP\n response code in the 4XX range with a different format for the response\n body. Client libraries automatically convert a 4XX response into an\n exception class.\u003c/li\u003e\n\u003c/ul\u003e", "type": "object", "properties": { @@ -258,32 +162,31 @@ "type": "boolean" }, "response": { + "description": "If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.", + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "description": "If the script function returns successfully, this field contains an ExecutionResponse object with the function's return value.", - "type": "object" + } }, "error": { - "$ref": "Status", - "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error." + "description": "If a `run` call succeeds but the script function (or Apps Script itself) throws an exception, this field contains a Status object. The `Status` object's `details` field contains an array with a single ExecutionError object that provides information about the nature of the error.", + "$ref": "Status" } - }, - "id": "Operation" + } }, "ScriptStackTraceElement": { "description": "A stack trace through the script that shows where the execution failed.", "type": "object", "properties": { + "function": { + "description": "The name of the function that failed.", + "type": "string" + }, "lineNumber": { "description": "The line number where the script failed.", "format": "int32", "type": "integer" - }, - "function": { - "description": "The name of the function that failed.", - "type": "string" } }, "id": "ScriptStackTraceElement" @@ -317,5 +220,102 @@ }, "protocol": "rest", "version": "v1", - "baseUrl": "https://script.googleapis.com/" + "baseUrl": "https://script.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/drive": { + "description": "View and manage the files in your Google Drive" + }, + "https://www.googleapis.com/auth/admin.directory.user": { + "description": "View and manage the provisioning of users on your domain" + }, + "https://www.googleapis.com/auth/admin.directory.group": { + "description": "View and manage the provisioning of groups on your domain" + }, + "https://mail.google.com/": { + "description": "Read, send, delete, and manage your email" + }, + "https://www.googleapis.com/auth/spreadsheets": { + "description": "View and manage your spreadsheets in Google Drive" + }, + "https://www.googleapis.com/auth/forms": { + "description": "View and manage your forms in Google Drive" + }, + "https://www.google.com/m8/feeds": { + "description": "Manage your contacts" + }, + "https://www.googleapis.com/auth/userinfo.email": { + "description": "View your email address" + }, + "https://www.google.com/calendar/feeds": { + "description": "Manage your calendars" + }, + "https://www.googleapis.com/auth/groups": { + "description": "View and manage your Google Groups" + }, + "https://www.googleapis.com/auth/forms.currentonly": { + "description": "View and manage forms that this application has been installed in" + } + } + } + }, + "servicePath": "", + "description": "An API for managing and executing Google Apps Script projects.", + "kind": "discovery#restDescription", + "rootUrl": "https://script.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "script", + "batchPath": "batch", + "revision": "20180106", + "documentationLink": "https://developers.google.com/apps-script/execution/rest/v1/scripts/run", + "id": "script:v1", + "fullyEncodeReservedExpansion": true, + "title": "Google Apps Script API", + "discoveryVersion": "v1", + "ownerName": "Google", + "resources": { + "scripts": { + "methods": { + "run": { + "path": "v1/scripts/{scriptId}:run", + "id": "script.scripts.run", + "description": "Runs a function in an Apps Script project. The project must be deployed\nfor use with the Apps Script API.\n\nThis method requires authorization with an OAuth 2.0 token that includes at\nleast one of the scopes listed in the [Authorization](#authorization)\nsection; script projects that do not require authorization cannot be\nexecuted through this API. To find the correct scopes to include in the\nauthentication token, open the project in the script editor, then select\n**File \u003e Project properties** and click the **Scopes** tab.", + "request": { + "$ref": "ExecutionRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "scriptId" + ], + "httpMethod": "POST", + "scopes": [ + "https://mail.google.com/", + "https://www.google.com/calendar/feeds", + "https://www.google.com/m8/feeds", + "https://www.googleapis.com/auth/admin.directory.group", + "https://www.googleapis.com/auth/admin.directory.user", + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/forms", + "https://www.googleapis.com/auth/forms.currentonly", + "https://www.googleapis.com/auth/groups", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/userinfo.email" + ], + "parameters": { + "scriptId": { + "description": "The script ID of the script to be executed. To find the script ID, open\nthe project in the script editor and select **File \u003e Project properties**.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/scripts/{scriptId}:run" + } + } + } + } }
diff --git a/searchconsole/v1/searchconsole-api.json b/searchconsole/v1/searchconsole-api.json index 2acbf59..217b63f 100644 --- a/searchconsole/v1/searchconsole-api.json +++ b/searchconsole/v1/searchconsole-api.json
@@ -1,6 +1,4 @@ { - "version": "v1", - "baseUrl": "https://searchconsole.googleapis.com/", "canonicalName": "Search Console", "kind": "discovery#restDescription", "description": "Provides tools for running validation tests against single URLs", @@ -10,12 +8,12 @@ "ownerDomain": "google.com", "name": "searchconsole", "batchPath": "batch", - "revision": "20171225", + "revision": "20180106", "documentationLink": "https://developers.google.com/webmaster-tools/search-console-api/", "id": "searchconsole:v1", "title": "Google Search Console URL Testing Tools API", - "discoveryVersion": "v1", "ownerName": "Google", + "discoveryVersion": "v1", "version_module": true, "resources": { "urlTestingTools": { @@ -23,6 +21,7 @@ "mobileFriendlyTest": { "methods": { "run": { + "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run", "path": "v1/urlTestingTools/mobileFriendlyTest:run", "id": "searchconsole.urlTestingTools.mobileFriendlyTest.run", "description": "Runs Mobile-Friendly Test for a given URL.", @@ -34,8 +33,7 @@ }, "parameterOrder": [], "httpMethod": "POST", - "parameters": {}, - "flatPath": "v1/urlTestingTools/mobileFriendlyTest:run" + "parameters": {} } } } @@ -43,54 +41,30 @@ } }, "parameters": { - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, "upload_protocol": { - "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, "$.xgafv": { + "description": "V1 error format.", + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -99,9 +73,12 @@ "enum": [ "1", "2" - ], - "description": "V1 error format.", - "type": "string" + ] + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "alt": { "enum": [ @@ -119,81 +96,46 @@ "description": "Data format for response.", "default": "json" }, + "access_token": { + "type": "string", + "location": "query", + "description": "OAuth access token." + }, "key": { "location": "query", "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.", "type": "string" }, - "access_token": { - "description": "OAuth access token.", + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" } }, "schemas": { - "TestStatus": { - "id": "TestStatus", - "description": "Final state of the test, including error details if necessary.", - "type": "object", - "properties": { - "status": { - "enumDescriptions": [ - "Internal error when running this test. Please try running the test again.", - "Inspection has completed without errors.", - "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.", - "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected." - ], - "enum": [ - "TEST_STATUS_UNSPECIFIED", - "COMPLETE", - "INTERNAL_ERROR", - "PAGE_UNREACHABLE" - ], - "description": "Status of the test.", - "type": "string" - }, - "details": { - "description": "Error details if applicable.", - "type": "string" - } - } - }, - "Image": { - "description": "Describe image data.", - "type": "object", - "properties": { - "mimeType": { - "description": "The mime-type of the image data.", - "type": "string" - }, - "data": { - "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.", - "format": "byte", - "type": "string" - } - }, - "id": "Image" - }, - "RunMobileFriendlyTestRequest": { - "id": "RunMobileFriendlyTestRequest", - "description": "Mobile-friendly test request.", - "type": "object", - "properties": { - "url": { - "description": "URL for inspection.", - "type": "string" - }, - "requestScreenshot": { - "description": "Whether or not screenshot is requested. Default is false.", - "type": "boolean" - } - } - }, "MobileFriendlyIssue": { "description": "Mobile-friendly issue.", "type": "object", "properties": { "rule": { + "description": "Rule violated.", + "type": "string", "enumDescriptions": [ "Unknown rule. Sorry, we don't have any description for the rule that was\nbroken.", "Plugins incompatible with mobile devices are being used. [Learn more]\n(https://support.google.com/webmasters/answer/6352293#flash_usage).", @@ -211,9 +153,7 @@ "SIZE_CONTENT_TO_VIEWPORT", "USE_LEGIBLE_FONT_SIZES", "TAP_TARGETS_TOO_CLOSE" - ], - "description": "Rule violated.", - "type": "string" + ] } }, "id": "MobileFriendlyIssue" @@ -222,30 +162,19 @@ "description": "Mobile-friendly test response, including mobile-friendly issues and resource\nissues.", "type": "object", "properties": { - "testStatus": { - "description": "Final state of the test, can be either complete or an error.", - "$ref": "TestStatus" - }, - "resourceIssues": { - "description": "Information about embedded resources issues.", - "type": "array", - "items": { - "$ref": "ResourceIssue" - } - }, "mobileFriendliness": { - "enumDescriptions": [ - "Internal error when running this test. Please try running the test again.", - "The page is mobile friendly.", - "The page is not mobile friendly." - ], "enum": [ "MOBILE_FRIENDLY_TEST_RESULT_UNSPECIFIED", "MOBILE_FRIENDLY", "NOT_MOBILE_FRIENDLY" ], "description": "Test verdict, whether the page is mobile friendly or not.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Internal error when running this test. Please try running the test again.", + "The page is mobile friendly.", + "The page is not mobile friendly." + ] }, "mobileFriendlyIssues": { "description": "List of mobile-usability issues.", @@ -257,23 +186,33 @@ "screenshot": { "$ref": "Image", "description": "Screenshot of the requested URL." + }, + "testStatus": { + "$ref": "TestStatus", + "description": "Final state of the test, can be either complete or an error." + }, + "resourceIssues": { + "description": "Information about embedded resources issues.", + "type": "array", + "items": { + "$ref": "ResourceIssue" + } } }, "id": "RunMobileFriendlyTestResponse" }, "ResourceIssue": { + "id": "ResourceIssue", "description": "Information about a resource with issue.", "type": "object", "properties": { "blockedResource": { - "description": "Describes a blocked resource issue.", - "$ref": "BlockedResource" + "$ref": "BlockedResource", + "description": "Describes a blocked resource issue." } - }, - "id": "ResourceIssue" + } }, "BlockedResource": { - "description": "Blocked resource.", "type": "object", "properties": { "url": { @@ -281,12 +220,73 @@ "type": "string" } }, - "id": "BlockedResource" + "id": "BlockedResource", + "description": "Blocked resource." + }, + "TestStatus": { + "type": "object", + "properties": { + "status": { + "description": "Status of the test.", + "type": "string", + "enumDescriptions": [ + "Internal error when running this test. Please try running the test again.", + "Inspection has completed without errors.", + "Inspection terminated in an error state. This indicates a problem in\nGoogle's infrastructure, not a user error. Please try again later.", + "Google can not access the URL because of a user error such as a robots.txt\nblockage, a 403 or 500 code etc. Please make sure that the URL provided is\naccessible by Googlebot and is not password protected." + ], + "enum": [ + "TEST_STATUS_UNSPECIFIED", + "COMPLETE", + "INTERNAL_ERROR", + "PAGE_UNREACHABLE" + ] + }, + "details": { + "description": "Error details if applicable.", + "type": "string" + } + }, + "id": "TestStatus", + "description": "Final state of the test, including error details if necessary." + }, + "RunMobileFriendlyTestRequest": { + "description": "Mobile-friendly test request.", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "URL for inspection." + }, + "requestScreenshot": { + "description": "Whether or not screenshot is requested. Default is false.", + "type": "boolean" + } + }, + "id": "RunMobileFriendlyTestRequest" + }, + "Image": { + "description": "Describe image data.", + "type": "object", + "properties": { + "mimeType": { + "description": "The mime-type of the image data.", + "type": "string" + }, + "data": { + "description": "Image data in format determined by the mime type. Currently, the format\nwill always be \"image/png\", but this might change in the future.", + "format": "byte", + "type": "string" + } + }, + "id": "Image" } }, + "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest" + "version": "v1", + "baseUrl": "https://searchconsole.googleapis.com/" }
diff --git a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json index 9f0891f..aa6bf2c 100644 --- a/serviceconsumermanagement/v1/serviceconsumermanagement-api.json +++ b/serviceconsumermanagement/v1/serviceconsumermanagement-api.json
@@ -1,1699 +1,12 @@ { - "rootUrl": "https://serviceconsumermanagement.googleapis.com/", - "ownerDomain": "google.com", - "name": "serviceconsumermanagement", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Service Consumer Management API", - "ownerName": "Google", - "resources": { - "services": { - "methods": { - "search": { - "description": "Search tenancy units for a service.", - "response": { - "$ref": "SearchTenancyUnitsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageToken": { - "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.\n\nOptional.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The maximum number of results returned by this request. Currently, the\ndefault maximum is set to 1000. If page_size is not provided or provided a\nnumber larger than 1000, it will be automatically set to 1000.\n\nOptional.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "query": { - "description": "Set a query `{expression}` for querying tenancy units. Your `{expression}`\nmust be in the format: `field_name=literal_string`. The `field_name` is the\nname of the field you want to compare. Supported fields are\n`tenant_resources.tag` and`tenant_resources.resource`.\n\nFor example, to search tenancy units that contain at least one tenant\nresource with given tag 'xyz', use query `tenant_resources.tag=xyz`.\nTo search tenancy units that contain at least one tenant resource with\ngiven resource name 'projects/123456', use query\n`tenant_resources.resource=projects/123456`.\n\nMultiple expressions can be joined with `AND`s. Tenancy units must match\nall expressions to be included in the result set. For example,\n`tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`\n\nOptional.", - "type": "string", - "location": "query" - }, - "parent": { - "description": "Service for which search is performed.\nservices/{service}\n{service} the name of a service, for example 'service.googleapis.com'.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/services/{servicesId}:search", - "path": "v1/{+parent}:search", - "id": "serviceconsumermanagement.services.search" - } - }, - "resources": { - "tenancyUnits": { - "methods": { - "list": { - "description": "Find tenancy unit for a service and consumer.\nThis method should not be used in producers' runtime path, e.g. finding\nthe tenant project number when creating VMs. Producers should persist\nthe tenant project information after the project is created.", - "response": { - "$ref": "ListTenancyUnitsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "filter": { - "location": "query", - "description": "Filter expression over tenancy resources field. Optional.", - "type": "string" - }, - "pageToken": { - "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The maximum number of results returned by this request.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Service and consumer. Required.\nservices/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/[^/]+/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits", - "path": "v1/{+parent}/tenancyUnits", - "id": "serviceconsumermanagement.services.tenancyUnits.list" - }, - "create": { - "description": "Creates a tenancy unit with no tenant resources.", - "request": { - "$ref": "CreateTenancyUnitRequest" - }, - "response": { - "$ref": "TenancyUnit" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "description": "services/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.\nEnabled service binding using the new tenancy unit.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/[^/]+/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits", - "path": "v1/{+parent}/tenancyUnits", - "id": "serviceconsumermanagement.services.tenancyUnits.create" - }, - "removeProject": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "Name of the tenancy unit.\nSuch as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject", - "path": "v1/{+name}:removeProject", - "id": "serviceconsumermanagement.services.tenancyUnits.removeProject", - "request": { - "$ref": "RemoveTenantProjectRequest" - }, - "description": "Removes specified project resource identified by tenant resource tag.\nIt will remove project lien with 'TenantManager' origin if that was added.\nIt will then attempt to delete the project.\nIf that operation fails, this method fails.\nOperation\u003cresponse: Empty\u003e." - }, - "delete": { - "description": "Delete tenancy unit. Before the tenancy unit is deleted, there should be\nno tenant resource in it.\nOperation\u003cresponse: Empty\u003e.", - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "location": "path", - "description": "Name of the tenancy unit to be deleted.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}", - "id": "serviceconsumermanagement.services.tenancyUnits.delete", - "path": "v1/{+name}" - }, - "addProject": { - "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject", - "path": "v1/{+parent}:addProject", - "id": "serviceconsumermanagement.services.tenancyUnits.addProject", - "request": { - "$ref": "AddTenantProjectRequest" - }, - "description": "Add a new tenant project to the tenancy unit.\nIf there are previously failed AddTenantProject calls, you might need to\ncall RemoveTenantProject first to clean them before you can make another\nAddTenantProject with the same tag.\nOperation\u003cresponse: Empty\u003e.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "location": "path", - "description": "Name of the tenancy unit.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - } - } - }, - "operations": { - "methods": { - "list": { - "flatPath": "v1/operations", - "path": "v1/{+name}", - "id": "serviceconsumermanagement.operations.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.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^operations$", - "location": "path" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ] - }, - "get": { - "flatPath": "v1/operations/{operationsId}", - "id": "serviceconsumermanagement.operations.get", - "path": "v1/{+name}", - "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", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ] - }, - "cancel": { - "request": { - "$ref": "CancelOperationRequest" - }, - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^operations/.+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "serviceconsumermanagement.operations.cancel" - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^operations/.+$", - "location": "path" - } - }, - "flatPath": "v1/operations/{operationsId}", - "path": "v1/{+name}", - "id": "serviceconsumermanagement.operations.delete" - } - } - } - }, - "parameters": { - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "type": "string", - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - } - }, - "version": "v1", - "baseUrl": "https://serviceconsumermanagement.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Provides management methods for configuring service producer resources on Google Cloud.", - "servicePath": "", - "basePath": "", "revision": "20180105", "id": "serviceconsumermanagement:v1", "documentationLink": "https://cloud.google.com/service-consumer-management/docs/overview", "discoveryVersion": "v1", "version_module": true, "schemas": { - "Context": { - "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.", - "type": "object", - "properties": { - "rules": { - "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "ContextRule" - } - } - }, - "id": "Context" - }, - "LogDescriptor": { - "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer", - "type": "object", - "properties": { - "description": { - "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.", - "type": "string" - }, - "displayName": { - "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.", - "type": "string" - }, - "labels": { - "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } - }, - "name": { - "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].", - "type": "string" - } - }, - "id": "LogDescriptor" - }, - "MonitoredResourceDescriptor": { - "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.", - "type": "object", - "properties": { - "displayName": { - "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.", - "type": "string" - }, - "description": { - "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.", - "type": "string" - }, - "type": { - "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.", - "type": "string" - }, - "labels": { - "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } - }, - "name": { - "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.", - "type": "string" - } - }, - "id": "MonitoredResourceDescriptor" - }, - "CustomErrorRule": { - "description": "A custom error rule.", - "type": "object", - "properties": { - "isErrorType": { - "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.", - "type": "boolean" - }, - "selector": { - "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "CustomErrorRule" - }, - "MediaDownload": { - "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", - "type": "object", - "properties": { - "enabled": { - "description": "Whether download is enabled.", - "type": "boolean" - }, - "downloadService": { - "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.", - "type": "string" - }, - "completeNotification": { - "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.", - "type": "boolean" - }, - "maxDirectDownloadSize": { - "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.", - "format": "int64", - "type": "string" - }, - "dropzone": { - "description": "Name of the Scotty dropzone to use for the current API.", - "type": "string" - }, - "useDirectDownload": { - "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.", - "type": "boolean" - } - }, - "id": "MediaDownload" - }, - "CustomAuthRequirements": { - "description": "Configuration for a custom authentication provider.", - "type": "object", - "properties": { - "provider": { - "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).", - "type": "string" - } - }, - "id": "CustomAuthRequirements" - }, - "AuthorizationRule": { - "description": "Authorization rule for API services.\n\nIt specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.\n\nFor example:\n\n package google.storage.v1;\n\n message CopyObjectRequest {\n string source = 1 [\n (google.api.authz).permissions = \"storage.objects.get\"];\n\n string destination = 2 [\n (google.api.authz).permissions =\n \"storage.objects.create,storage.objects.update\"];\n }", - "type": "object", - "properties": { - "permissions": { - "description": "The required permissions. The acceptable values vary depend on the\nauthorization system used. For Google APIs, it should be a comma-separated\nGoogle IAM permission values. When multiple permissions are listed, the\nsemantics is not defined by the system. Additional documentation must\nbe provided manually.", - "type": "string" - }, - "selector": { - "description": "Selects the API elements to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "AuthorizationRule" - }, - "MediaUpload": { - "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", - "type": "object", - "properties": { - "completeNotification": { - "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.", - "type": "boolean" - }, - "progressNotification": { - "description": "Whether to receive a notification for progress changes of media upload.", - "type": "boolean" - }, - "enabled": { - "description": "Whether upload is enabled.", - "type": "boolean" - }, - "dropzone": { - "description": "Name of the Scotty dropzone to use for the current API.", - "type": "string" - }, - "startNotification": { - "description": "Whether to receive a notification on the start of media upload.", - "type": "boolean" - }, - "uploadService": { - "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.", - "type": "string" - }, - "maxSize": { - "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.", - "format": "int64", - "type": "string" - }, - "mimeTypes": { - "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "MediaUpload" - }, - "CreateTenancyUnitRequest": { - "description": "Request to create a tenancy unit for a consumer of a service.", - "type": "object", - "properties": { - "tenancyUnitId": { - "description": "Optional producer provided identifier of the tenancy unit\nMust be no longer than 40 characters and preferably URI friendly\nIf it is not provided, UID for the tenancy unit will be auto generated\nIt must be unique across a service.\nIf the tenancy unit already exists for the service and consumer pair,\nCreateTenancyUnit will return existing tenancy unit if provided identifier\nis identical or empty, otherwise the call will fail.", - "type": "string" - } - }, - "id": "CreateTenancyUnitRequest" - }, - "BillingDestination": { - "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).", - "type": "object", - "properties": { - "metrics": { - "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.", - "type": "array", - "items": { - "type": "string" - } - }, - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", - "type": "string" - } - }, - "id": "BillingDestination" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "UsageRule": { - "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true", - "type": "object", - "properties": { - "selector": { - "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "skipServiceControl": { - "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.", - "type": "boolean" - }, - "allowUnregisteredCalls": { - "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.", - "type": "boolean" - } - }, - "id": "UsageRule" - }, - "AuthRequirement": { - "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", - "type": "object", - "properties": { - "providerId": { - "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth", - "type": "string" - }, - "audiences": { - "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", - "type": "string" - } - }, - "id": "AuthRequirement" - }, - "Documentation": { - "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.", - "type": "object", - "properties": { - "pages": { - "description": "The top level pages for the documentation set.", - "type": "array", - "items": { - "$ref": "Page" - } - }, - "summary": { - "description": "A short summary of what the service does. Can only be provided by\nplain text.", - "type": "string" - }, - "documentationRootUrl": { - "description": "The URL to the root of documentation.", - "type": "string" - }, - "rules": { - "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "DocumentationRule" - } - }, - "overview": { - "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.", - "type": "string" - } - }, - "id": "Documentation" - }, - "BackendRule": { - "description": "A backend rule provides configuration for an individual API element.", - "type": "object", - "properties": { - "minDeadline": { - "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.", - "format": "double", - "type": "number" - }, - "address": { - "description": "The address of the API backend.", - "type": "string" - }, - "selector": { - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "deadline": { - "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.", - "format": "double", - "type": "number" - } - }, - "id": "BackendRule" - }, - "AuthenticationRule": { - "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.", - "type": "object", - "properties": { - "oauth": { - "$ref": "OAuthRequirements", - "description": "The requirements for OAuth credentials." - }, - "customAuth": { - "$ref": "CustomAuthRequirements", - "description": "Configuration for custom authentication." - }, - "requirements": { - "description": "Requirements for additional authentication providers.", - "type": "array", - "items": { - "$ref": "AuthRequirement" - } - }, - "selector": { - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "allowWithoutCredential": { - "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.", - "type": "boolean" - } - }, - "id": "AuthenticationRule" - }, - "Api": { - "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.", - "type": "object", - "properties": { - "options": { - "description": "Any metadata attached to the interface.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "methods": { - "description": "The methods of this interface, in unspecified order.", - "type": "array", - "items": { - "$ref": "Method" - } - }, - "name": { - "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.", - "type": "string" - }, - "syntax": { - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ], - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax of the service.", - "type": "string" - }, - "sourceContext": { - "$ref": "SourceContext", - "description": "Source context for the protocol buffer service represented by this\nmessage." - }, - "version": { - "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n", - "type": "string" - }, - "mixins": { - "description": "Included interfaces. See Mixin.", - "type": "array", - "items": { - "$ref": "Mixin" - } - } - }, - "id": "Api" - }, - "CancelOperationRequest": { - "description": "The request message for Operations.CancelOperation.", - "type": "object", - "properties": {}, - "id": "CancelOperationRequest" - }, - "MetricRule": { - "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.", - "type": "object", - "properties": { - "selector": { - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "metricCosts": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.", - "type": "object" - } - }, - "id": "MetricRule" - }, - "TenantProjectPolicy": { - "description": "Describes policy settings that need to be applied to a newly\ncreated Tenant Project.", - "type": "object", - "properties": { - "policyBindings": { - "description": "Additional policy bindings to be applied on the tenant\nproject.\nAt least one owner must be set in the bindings. Among the list of members\nas owners, at least one of them must be either `user` or `group` based.", - "type": "array", - "items": { - "$ref": "PolicyBinding" - } - } - }, - "id": "TenantProjectPolicy" - }, - "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", - "type": "object", - "properties": { - "providers": { - "description": "Defines a set of authentication providers that a service supports.", - "type": "array", - "items": { - "$ref": "AuthProvider" - } - }, - "rules": { - "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "AuthenticationRule" - } - } - }, - "id": "Authentication" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "properties": { - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." - }, - "metadata": { - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "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": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - } - }, - "id": "Operation" - }, - "Page": { - "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.", - "type": "object", - "properties": { - "subpages": { - "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.", - "type": "array", - "items": { - "$ref": "Page" - } - }, - "name": { - "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.", - "type": "string" - }, - "content": { - "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.", - "type": "string" - } - }, - "id": "Page" - }, - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "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" - } - }, - "id": "Status" - }, - "AddTenantProjectRequest": { - "description": "Request to add a newly created and configured tenant project to tenancy\nunit.", - "type": "object", - "properties": { - "tag": { - "description": "Tag of the added project. Must be less than 128 characters. Required.", - "type": "string" - }, - "projectConfig": { - "$ref": "TenantProjectConfig", - "description": "Configuration of the new tenant project that will be added to tenancy unit\nresources." - } - }, - "id": "AddTenantProjectRequest" - }, - "AuthProvider": { - "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", - "type": "object", - "properties": { - "audiences": { - "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", - "type": "string" - }, - "id": { - "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".", - "type": "string" - }, - "issuer": { - "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com", - "type": "string" - }, - "authorizationUrl": { - "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.", - "type": "string" - }, - "jwksUri": { - "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs", - "type": "string" - } - }, - "id": "AuthProvider" - }, - "EnumValue": { - "description": "Enum value definition.", - "type": "object", - "properties": { - "options": { - "description": "Protocol buffer options.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "number": { - "description": "Enum value number.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "Enum value name.", - "type": "string" - } - }, - "id": "EnumValue" - }, - "Service": { - "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", - "type": "object", - "properties": { - "title": { - "description": "The product title for this service.", - "type": "string" - }, - "endpoints": { - "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.", - "type": "array", - "items": { - "$ref": "Endpoint" - } - }, - "logs": { - "description": "Defines the logs used by this service.", - "type": "array", - "items": { - "$ref": "LogDescriptor" - } - }, - "apis": { - "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.", - "type": "array", - "items": { - "$ref": "Api" - } - }, - "types": { - "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32", - "type": "array", - "items": { - "$ref": "Type" - } - }, - "sourceInfo": { - "$ref": "SourceInfo", - "description": "Output only. The source information for this configuration if available." - }, - "http": { - "$ref": "Http", - "description": "HTTP configuration." - }, - "systemParameters": { - "$ref": "SystemParameters", - "description": "System parameter configuration." - }, - "backend": { - "description": "API backend configuration.", - "$ref": "Backend" - }, - "documentation": { - "description": "Additional API documentation.", - "$ref": "Documentation" - }, - "logging": { - "$ref": "Logging", - "description": "Logging configuration." - }, - "monitoredResources": { - "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", - "type": "array", - "items": { - "$ref": "MonitoredResourceDescriptor" - } - }, - "enums": { - "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum", - "type": "array", - "items": { - "$ref": "Enum" - } - }, - "context": { - "description": "Context configuration.", - "$ref": "Context" - }, - "id": { - "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", - "type": "string" - }, - "usage": { - "$ref": "Usage", - "description": "Configuration controlling usage of this service." - }, - "metrics": { - "description": "Defines the metrics used by this service.", - "type": "array", - "items": { - "$ref": "MetricDescriptor" - } - }, - "authentication": { - "$ref": "Authentication", - "description": "Auth configuration." - }, - "experimental": { - "$ref": "Experimental", - "description": "Experimental configuration." - }, - "control": { - "description": "Configuration for the service control plane.", - "$ref": "Control" - }, - "configVersion": { - "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.", - "format": "uint32", - "type": "integer" - }, - "monitoring": { - "description": "Monitoring configuration.", - "$ref": "Monitoring" - }, - "producerProjectId": { - "description": "The Google project that owns this service.", - "type": "string" - }, - "systemTypes": { - "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.", - "type": "array", - "items": { - "$ref": "Type" - } - }, - "visibility": { - "$ref": "Visibility", - "description": "API visibility configuration." - }, - "quota": { - "$ref": "Quota", - "description": "Quota configuration." - }, - "name": { - "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", - "type": "string" - }, - "billing": { - "$ref": "Billing", - "description": "Billing configuration." - }, - "customError": { - "description": "Custom error configuration.", - "$ref": "CustomError" - } - }, - "id": "Service" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "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.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "id": "ListOperationsResponse" - }, - "CustomHttpPattern": { - "description": "A custom pattern is used for defining custom HTTP verb.", - "type": "object", - "properties": { - "kind": { - "description": "The name of this custom HTTP verb.", - "type": "string" - }, - "path": { - "description": "The path matched by this custom verb.", - "type": "string" - } - }, - "id": "CustomHttpPattern" - }, - "SystemParameterRule": { - "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.", - "type": "object", - "properties": { - "parameters": { - "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.", - "type": "array", - "items": { - "$ref": "SystemParameter" - } - }, - "selector": { - "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "SystemParameterRule" - }, - "BillingConfig": { - "description": "Describes billing configuration for new a Tenant Project", - "type": "object", - "properties": { - "billingAccount": { - "description": "Name of the billing account.\nFor example `billingAccounts/012345-567890-ABCDEF`.", - "type": "string" - } - }, - "id": "BillingConfig" - }, - "TenantResource": { - "description": "Resource constituting the TenancyUnit.", - "type": "object", - "properties": { - "resource": { - "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'.", - "type": "string" - }, - "status": { - "description": "Status of tenant resource.", - "type": "string", - "enumDescriptions": [ - "Unspecified status is the default unset value.", - "Creation of the tenant resource is ongoing.", - "Active resource.", - "Deletion of the resource is ongoing.", - "Tenant resource creation or deletion has failed." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "PENDING_CREATE", - "ACTIVE", - "PENDING_DELETE", - "FAILED" - ] - }, - "tag": { - "description": "Unique per single tenancy unit.", - "type": "string" - } - }, - "id": "TenantResource" - }, - "RemoveTenantProjectRequest": { - "description": "Request message to remove tenant project resource from the tenancy unit.", - "type": "object", - "properties": { - "tag": { - "description": "Tag of the resource within the tenancy unit.", - "type": "string" - } - }, - "id": "RemoveTenantProjectRequest" - }, - "HttpRule": { - "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.", - "type": "object", - "properties": { - "body": { - "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", - "type": "string" - }, - "post": { - "description": "Used for creating a resource.", - "type": "string" - }, - "mediaDownload": { - "$ref": "MediaDownload", - "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration." - }, - "restMethodName": { - "description": "DO NOT USE. This is an experimental field.\n\nOptional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default method name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest method name\n\"create\", but for backwards compatibility with apiary, it is specified as\ninsert.", - "type": "string" - }, - "additionalBindings": { - "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", - "type": "array", - "items": { - "$ref": "HttpRule" - } - }, - "responseBody": { - "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.", - "type": "string" - }, - "restCollection": { - "description": "DO NOT USE. This is an experimental field.\n\nOptional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.", - "type": "string" - }, - "mediaUpload": { - "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods.", - "$ref": "MediaUpload" - }, - "selector": { - "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "custom": { - "$ref": "CustomHttpPattern", - "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients." - }, - "patch": { - "description": "Used for updating a resource.", - "type": "string" - }, - "get": { - "description": "Used for listing and getting information about resources.", - "type": "string" - }, - "put": { - "description": "Used for updating a resource.", - "type": "string" - }, - "authorizations": { - "description": "Specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.", - "type": "array", - "items": { - "$ref": "AuthorizationRule" - } - }, - "delete": { - "description": "Used for deleting a resource.", - "type": "string" - } - }, - "id": "HttpRule" - }, - "VisibilityRule": { - "description": "A visibility rule provides visibility configuration for an individual API\nelement.", - "type": "object", - "properties": { - "restriction": { - "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", - "type": "string" - }, - "selector": { - "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "VisibilityRule" - }, - "MonitoringDestination": { - "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).", - "type": "object", - "properties": { - "metrics": { - "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.", - "type": "array", - "items": { - "type": "string" - } - }, - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", - "type": "string" - } - }, - "id": "MonitoringDestination" - }, - "TenancyUnit": { - "description": "Representation of a tenancy unit.", - "type": "object", - "properties": { - "consumer": { - "description": "@OutputOnly Cloud resource One Platform Name of the consumer of this\nservice. For example 'projects/123456'.", - "type": "string" - }, - "createTime": { - "description": "@OutputOnly The time this tenancy unit was created.", - "format": "google-datetime", - "type": "string" - }, - "service": { - "description": "@OutputOnly Google Cloud API name of the service owning this tenancy unit.\nFor example 'serviceconsumermanagement.googleapis.com'.", - "type": "string" - }, - "name": { - "description": "Globally unique identifier of this tenancy unit\n\"services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}\"", - "type": "string" - }, - "tenantResources": { - "description": "Resources constituting the tenancy unit.", - "type": "array", - "items": { - "$ref": "TenantResource" - } - } - }, - "id": "TenancyUnit" - }, - "Visibility": { - "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.", - "type": "object", - "properties": { - "rules": { - "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "VisibilityRule" - } - } - }, - "id": "Visibility" - }, - "SystemParameters": { - "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.", - "type": "object", - "properties": { - "rules": { - "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "SystemParameterRule" - } - } - }, - "id": "SystemParameters" - }, - "Quota": { - "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", - "type": "object", - "properties": { - "limits": { - "description": "List of `QuotaLimit` definitions for the service.", - "type": "array", - "items": { - "$ref": "QuotaLimit" - } - }, - "metricRules": { - "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.", - "type": "array", - "items": { - "$ref": "MetricRule" - } - } - }, - "id": "Quota" - }, - "TenantProjectConfig": { - "description": "This structure defines a tenant project to be added to the specified tenancy\nunit and its initial configuration and properties. A project lien will be\ncreated for the tenant project to prevent the tenant project from being\ndeleted accidentally. The lien will be deleted as part of tenant project\nremoval.", - "type": "object", - "properties": { - "services": { - "description": "Google Cloud API names of services that will be activated on this project\nduring provisioning. If any of these services can not be activated,\naddTenantProject method will fail.\nFor example: 'compute.googleapis.com','cloudfunctions.googleapis.com'", - "type": "array", - "items": { - "type": "string" - } - }, - "billingConfig": { - "description": "Billing account properties.\nIt may be specified explicitly, or created from the specified group\nduring provisioning", - "$ref": "BillingConfig" - }, - "tenantProjectPolicy": { - "description": "Describes ownership and policies for the new tenant project. Required.", - "$ref": "TenantProjectPolicy" - }, - "folder": { - "description": "Folder where project in this tenancy unit must be located\nThis folder must have been previously created with proper\npermissions for the caller to create and configure a project in it.\nValid folder resource names have the format `folders/{folder_number}`\n(for example, `folders/123456`).", - "type": "string" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Labels that will be applied to this project.", - "type": "object" - }, - "serviceAccountConfig": { - "$ref": "ServiceAccountConfig", - "description": "Configuration for IAM service account on tenant project." - } - }, - "id": "TenantProjectConfig" - }, - "PolicyBinding": { - "description": "Translates to IAM Policy bindings (without auditing at this level)", - "type": "object", - "properties": { - "members": { - "description": "Uses the same format as in IAM policy.\n`member` must include both prefix and id. E.g., `user:{emailId}`,\n`serviceAccount:{emailId}`, `group:{emailId}`.", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role. (https://cloud.google.com/iam/docs/understanding-roles)\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.", - "type": "string" - } - }, - "id": "PolicyBinding" - }, - "LoggingDestination": { - "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", - "type": "object", - "properties": { - "logs": { - "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", - "type": "array", - "items": { - "type": "string" - } - }, - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.", - "type": "string" - } - }, - "id": "LoggingDestination" - }, - "Option": { - "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", - "type": "object", - "properties": { - "name": { - "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.", - "type": "string" - }, - "value": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.", - "type": "object" - } - }, - "id": "Option" - }, - "Logging": { - "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history", - "type": "object", - "properties": { - "consumerDestinations": { - "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "LoggingDestination" - } - }, - "producerDestinations": { - "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.", - "type": "array", - "items": { - "$ref": "LoggingDestination" - } - } - }, - "id": "Logging" - }, - "QuotaLimit": { - "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.", - "type": "object", - "properties": { - "maxLimit": { - "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "name": { - "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.", - "type": "string" - }, - "freeTier": { - "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "duration": { - "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.", - "type": "string" - }, - "defaultLimit": { - "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "displayName": { - "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.", - "type": "string" - }, - "metric": { - "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.", - "type": "string" - }, - "description": { - "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).", - "type": "string" - }, - "values": { - "additionalProperties": { - "format": "int64", - "type": "string" - }, - "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.", - "type": "object" - }, - "unit": { - "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.", - "type": "string" - } - }, - "id": "QuotaLimit" - }, - "Method": { - "description": "Method represents a method of an API interface.", - "type": "object", - "properties": { - "responseTypeUrl": { - "description": "The URL of the output message type.", - "type": "string" - }, - "options": { - "description": "Any metadata attached to the method.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "responseStreaming": { - "description": "If true, the response is streamed.", - "type": "boolean" - }, - "name": { - "description": "The simple name of this method.", - "type": "string" - }, - "requestTypeUrl": { - "description": "A URL of the input message type.", - "type": "string" - }, - "requestStreaming": { - "description": "If true, the request is streamed.", - "type": "boolean" - }, - "syntax": { - "description": "The source syntax of this method.", - "type": "string", - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ], - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ] - } - }, - "id": "Method" - }, "Mixin": { + "id": "Mixin", "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }", "type": "object", "properties": { @@ -1705,8 +18,7 @@ "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.", "type": "string" } - }, - "id": "Mixin" + } }, "CustomError": { "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError", @@ -1730,22 +42,22 @@ "id": "CustomError" }, "Http": { + "id": "Http", "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.", "type": "object", "properties": { - "fullyDecodeReservedExpansion": { - "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.", - "type": "boolean" - }, "rules": { "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", "type": "array", "items": { "$ref": "HttpRule" } + }, + "fullyDecodeReservedExpansion": { + "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.", + "type": "boolean" } - }, - "id": "Http" + } }, "SourceInfo": { "description": "Source information used to create a Service Config", @@ -1777,13 +89,10 @@ "id": "Control" }, "SystemParameter": { + "id": "SystemParameter", "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.", "type": "object", "properties": { - "httpHeader": { - "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.", - "type": "string" - }, "name": { "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.", "type": "string" @@ -1791,44 +100,17 @@ "urlQueryParameter": { "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.", "type": "string" - } - }, - "id": "SystemParameter" - }, - "Monitoring": { - "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count", - "type": "object", - "properties": { - "consumerDestinations": { - "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "MonitoringDestination" - } }, - "producerDestinations": { - "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", - "type": "array", - "items": { - "$ref": "MonitoringDestination" - } + "httpHeader": { + "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.", + "type": "string" } - }, - "id": "Monitoring" + } }, "Field": { "description": "A single field of a message type.", "type": "object", "properties": { - "typeUrl": { - "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", - "type": "string" - }, - "number": { - "description": "The field number.", - "format": "int32", - "type": "integer" - }, "jsonName": { "description": "The field JSON name.", "type": "string" @@ -1892,8 +174,6 @@ "type": "integer" }, "cardinality": { - "description": "The field cardinality.", - "type": "string", "enumDescriptions": [ "For fields with unknown cardinality.", "For optional fields.", @@ -1905,7 +185,9 @@ "CARDINALITY_OPTIONAL", "CARDINALITY_REQUIRED", "CARDINALITY_REPEATED" - ] + ], + "description": "The field cardinality.", + "type": "string" }, "packed": { "description": "Whether to use alternative packed wire representation.", @@ -1918,14 +200,55 @@ "name": { "description": "The field name.", "type": "string" + }, + "typeUrl": { + "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", + "type": "string" + }, + "number": { + "description": "The field number.", + "format": "int32", + "type": "integer" } }, "id": "Field" }, + "Monitoring": { + "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count", + "type": "object", + "properties": { + "consumerDestinations": { + "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "MonitoringDestination" + } + }, + "producerDestinations": { + "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", + "type": "array", + "items": { + "$ref": "MonitoringDestination" + } + } + }, + "id": "Monitoring" + }, "Enum": { "description": "Enum type definition.", "type": "object", "properties": { + "name": { + "description": "Enum type name.", + "type": "string" + }, + "enumvalue": { + "description": "Enum value definitions.", + "type": "array", + "items": { + "$ref": "EnumValue" + } + }, "options": { "description": "Protocol buffer options.", "type": "array", @@ -1948,22 +271,12 @@ ], "description": "The source syntax.", "type": "string" - }, - "name": { - "description": "Enum type name.", - "type": "string" - }, - "enumvalue": { - "description": "Enum value definitions.", - "type": "array", - "items": { - "$ref": "EnumValue" - } } }, "id": "Enum" }, "LabelDescriptor": { + "id": "LabelDescriptor", "description": "A description of a label.", "type": "object", "properties": { @@ -1976,6 +289,8 @@ "type": "string" }, "valueType": { + "description": "The type of data that can be assigned to the label.", + "type": "string", "enumDescriptions": [ "A variable-length string. This is the default.", "Boolean; true or false.", @@ -1985,17 +300,22 @@ "STRING", "BOOL", "INT64" - ], - "description": "The type of data that can be assigned to the label.", - "type": "string" + ] } - }, - "id": "LabelDescriptor" + } }, "Type": { + "id": "Type", "description": "A protocol buffer message type.", "type": "object", "properties": { + "options": { + "description": "The protocol buffer options.", + "type": "array", + "items": { + "$ref": "Option" + } + }, "fields": { "description": "The list of fields.", "type": "array", @@ -2015,12 +335,10 @@ } }, "sourceContext": { - "description": "The source context.", - "$ref": "SourceContext" + "$ref": "SourceContext", + "description": "The source context." }, "syntax": { - "description": "The source syntax.", - "type": "string", "enumDescriptions": [ "Syntax `proto2`.", "Syntax `proto3`." @@ -2028,30 +346,25 @@ "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3" - ] - }, - "options": { - "description": "The protocol buffer options.", - "type": "array", - "items": { - "$ref": "Option" - } + ], + "description": "The source syntax.", + "type": "string" } - }, - "id": "Type" + } }, "Experimental": { + "id": "Experimental", "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.", "type": "object", "properties": { "authorization": { - "$ref": "AuthorizationConfig", - "description": "Authorization configuration." + "description": "Authorization configuration.", + "$ref": "AuthorizationConfig" } - }, - "id": "Experimental" + } }, "Backend": { + "id": "Backend", "description": "`Backend` defines the backend configuration for a service.", "type": "object", "properties": { @@ -2062,8 +375,7 @@ "$ref": "BackendRule" } } - }, - "id": "Backend" + } }, "DocumentationRule": { "description": "A documentation rule provides information about individual API elements.", @@ -2085,6 +397,7 @@ "id": "DocumentationRule" }, "ServiceAccountConfig": { + "id": "ServiceAccountConfig", "description": "Describes service account configuration for the tenant project.", "type": "object", "properties": { @@ -2099,8 +412,7 @@ "description": "ID of the IAM service account to be created in tenant project.\nThe email format of the service account will be\n\"\u003caccount-id\u003e@\u003ctenant-project-id\u003e.iam.gserviceaccount.com\".\nThis account id has to be unique within tenant project and producers\nhave to guarantee it.", "type": "string" } - }, - "id": "ServiceAccountConfig" + } }, "AuthorizationConfig": { "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com", @@ -2138,21 +450,29 @@ }, "id": "ContextRule" }, - "SourceContext": { - "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.", + "Billing": { + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "type": "object", "properties": { - "fileName": { - "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.", - "type": "string" + "consumerDestinations": { + "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "BillingDestination" + } } }, - "id": "SourceContext" + "id": "Billing" }, "MetricDescriptor": { + "id": "MetricDescriptor", "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.", "type": "object", "properties": { + "unit": { + "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.", + "type": "string" + }, "labels": { "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.", "type": "array", @@ -2213,29 +533,40 @@ "description": { "description": "A detailed description of the metric, which can be used in documentation.", "type": "string" - }, - "unit": { - "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.", - "type": "string" } - }, - "id": "MetricDescriptor" + } }, - "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "SourceContext": { + "id": "SourceContext", + "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.", "type": "object", "properties": { - "consumerDestinations": { - "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.", + "fileName": { + "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.", + "type": "string" + } + } + }, + "ListTenancyUnitsResponse": { + "id": "ListTenancyUnitsResponse", + "description": "Response for the list request.", + "type": "object", + "properties": { + "tenancyUnits": { + "description": "Tenancy Units matching the request.", "type": "array", "items": { - "$ref": "BillingDestination" + "$ref": "TenancyUnit" } + }, + "nextPageToken": { + "description": "Pagination token for large results.", + "type": "string" } - }, - "id": "Billing" + } }, "SearchTenancyUnitsResponse": { + "id": "SearchTenancyUnitsResponse", "description": "Response for the search query.", "type": "object", "properties": { @@ -2250,26 +581,7 @@ "$ref": "TenancyUnit" } } - }, - "id": "SearchTenancyUnitsResponse" - }, - "ListTenancyUnitsResponse": { - "description": "Response for the list request.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "Pagination token for large results.", - "type": "string" - }, - "tenancyUnits": { - "description": "Tenancy Units matching the request.", - "type": "array", - "items": { - "$ref": "TenancyUnit" - } - } - }, - "id": "ListTenancyUnitsResponse" + } }, "Endpoint": { "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true", @@ -2316,13 +628,10 @@ "id": "OAuthRequirements" }, "Usage": { + "id": "Usage", "description": "Configuration controlling usage of a service.", "type": "object", "properties": { - "producerNotificationChannel": { - "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.", - "type": "string" - }, "rules": { "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", "type": "array", @@ -2336,15 +645,1275 @@ "items": { "type": "string" } + }, + "producerNotificationChannel": { + "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.", + "type": "string" + } + } + }, + "Context": { + "id": "Context", + "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.", + "type": "object", + "properties": { + "rules": { + "description": "A list of RPC context rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "ContextRule" + } + } + } + }, + "LogDescriptor": { + "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer", + "type": "object", + "properties": { + "name": { + "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].", + "type": "string" + }, + "description": { + "description": "A human-readable description of this log. This information appears in\nthe documentation and can contain details.", + "type": "string" + }, + "displayName": { + "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.", + "type": "string" + }, + "labels": { + "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } } }, - "id": "Usage" + "id": "LogDescriptor" + }, + "CustomErrorRule": { + "description": "A custom error rule.", + "type": "object", + "properties": { + "isErrorType": { + "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.", + "type": "boolean" + }, + "selector": { + "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + } + }, + "id": "CustomErrorRule" + }, + "MonitoredResourceDescriptor": { + "id": "MonitoredResourceDescriptor", + "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.", + "type": "object", + "properties": { + "name": { + "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.", + "type": "string" + }, + "displayName": { + "description": "Optional. A concise name for the monitored resource type that might be\ndisplayed in user interfaces. It should be a Title Cased Noun Phrase,\nwithout any article or other determiners. For example,\n`\"Google Cloud SQL Database\"`.", + "type": "string" + }, + "description": { + "description": "Optional. A detailed description of the monitored resource type that might\nbe used in documentation.", + "type": "string" + }, + "type": { + "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.", + "type": "string" + }, + "labels": { + "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + } + } + }, + "CustomAuthRequirements": { + "id": "CustomAuthRequirements", + "description": "Configuration for a custom authentication provider.", + "type": "object", + "properties": { + "provider": { + "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).", + "type": "string" + } + } + }, + "MediaDownload": { + "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", + "type": "object", + "properties": { + "enabled": { + "description": "Whether download is enabled.", + "type": "boolean" + }, + "downloadService": { + "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.", + "type": "string" + }, + "completeNotification": { + "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.", + "type": "boolean" + }, + "dropzone": { + "description": "Name of the Scotty dropzone to use for the current API.", + "type": "string" + }, + "maxDirectDownloadSize": { + "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.", + "format": "int64", + "type": "string" + }, + "useDirectDownload": { + "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.", + "type": "boolean" + } + }, + "id": "MediaDownload" + }, + "AuthorizationRule": { + "description": "Authorization rule for API services.\n\nIt specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.\n\nFor example:\n\n package google.storage.v1;\n\n message CopyObjectRequest {\n string source = 1 [\n (google.api.authz).permissions = \"storage.objects.get\"];\n\n string destination = 2 [\n (google.api.authz).permissions =\n \"storage.objects.create,storage.objects.update\"];\n }", + "type": "object", + "properties": { + "selector": { + "description": "Selects the API elements to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "permissions": { + "description": "The required permissions. The acceptable values vary depend on the\nauthorization system used. For Google APIs, it should be a comma-separated\nGoogle IAM permission values. When multiple permissions are listed, the\nsemantics is not defined by the system. Additional documentation must\nbe provided manually.", + "type": "string" + } + }, + "id": "AuthorizationRule" + }, + "MediaUpload": { + "id": "MediaUpload", + "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", + "type": "object", + "properties": { + "startNotification": { + "description": "Whether to receive a notification on the start of media upload.", + "type": "boolean" + }, + "uploadService": { + "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.", + "type": "string" + }, + "maxSize": { + "description": "Optional maximum acceptable size for an upload.\nThe size is specified in bytes.", + "format": "int64", + "type": "string" + }, + "mimeTypes": { + "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.", + "type": "array", + "items": { + "type": "string" + } + }, + "completeNotification": { + "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.", + "type": "boolean" + }, + "progressNotification": { + "description": "Whether to receive a notification for progress changes of media upload.", + "type": "boolean" + }, + "enabled": { + "description": "Whether upload is enabled.", + "type": "boolean" + }, + "dropzone": { + "description": "Name of the Scotty dropzone to use for the current API.", + "type": "string" + } + } + }, + "CreateTenancyUnitRequest": { + "description": "Request to create a tenancy unit for a consumer of a service.", + "type": "object", + "properties": { + "tenancyUnitId": { + "description": "Optional producer provided identifier of the tenancy unit\nMust be no longer than 40 characters and preferably URI friendly\nIf it is not provided, UID for the tenancy unit will be auto generated\nIt must be unique across a service.\nIf the tenancy unit already exists for the service and consumer pair,\nCreateTenancyUnit will return existing tenancy unit if provided identifier\nis identical or empty, otherwise the call will fail.", + "type": "string" + } + }, + "id": "CreateTenancyUnitRequest" + }, + "BillingDestination": { + "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).", + "type": "object", + "properties": { + "monitoredResource": { + "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", + "type": "string" + }, + "metrics": { + "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "BillingDestination" + }, + "Empty": { + "id": "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 `{}`.", + "type": "object", + "properties": {} + }, + "UsageRule": { + "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true", + "type": "object", + "properties": { + "selector": { + "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "skipServiceControl": { + "description": "If true, the selected method should skip service control and the control\nplane features, such as quota and billing, will not be available.\nThis flag is used by Google Cloud Endpoints to bypass checks for internal\nmethods, such as service health check methods.", + "type": "boolean" + }, + "allowUnregisteredCalls": { + "description": "If true, the selected method allows unregistered calls, e.g. calls\nthat don't identify any user or application.", + "type": "boolean" + } + }, + "id": "UsageRule" + }, + "AuthRequirement": { + "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", + "type": "object", + "properties": { + "audiences": { + "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", + "type": "string" + }, + "providerId": { + "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth", + "type": "string" + } + }, + "id": "AuthRequirement" + }, + "Documentation": { + "id": "Documentation", + "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.", + "type": "object", + "properties": { + "summary": { + "description": "A short summary of what the service does. Can only be provided by\nplain text.", + "type": "string" + }, + "documentationRootUrl": { + "description": "The URL to the root of documentation.", + "type": "string" + }, + "rules": { + "description": "A list of documentation rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "DocumentationRule" + } + }, + "overview": { + "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.", + "type": "string" + }, + "pages": { + "description": "The top level pages for the documentation set.", + "type": "array", + "items": { + "$ref": "Page" + } + } + } + }, + "BackendRule": { + "id": "BackendRule", + "description": "A backend rule provides configuration for an individual API element.", + "type": "object", + "properties": { + "selector": { + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "deadline": { + "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.", + "format": "double", + "type": "number" + }, + "minDeadline": { + "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.", + "format": "double", + "type": "number" + }, + "address": { + "description": "The address of the API backend.", + "type": "string" + } + } + }, + "AuthenticationRule": { + "id": "AuthenticationRule", + "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.", + "type": "object", + "properties": { + "requirements": { + "description": "Requirements for additional authentication providers.", + "type": "array", + "items": { + "$ref": "AuthRequirement" + } + }, + "selector": { + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "allowWithoutCredential": { + "description": "Whether to allow requests without a credential. The credential can be\nan OAuth token, Google cookies (first-party auth) or EndUserCreds.\n\nFor requests without credentials, if the service control environment is\nspecified, each incoming request **must** be associated with a service\nconsumer. This can be done by passing an API key that belongs to a consumer\nproject.", + "type": "boolean" + }, + "oauth": { + "description": "The requirements for OAuth credentials.", + "$ref": "OAuthRequirements" + }, + "customAuth": { + "$ref": "CustomAuthRequirements", + "description": "Configuration for custom authentication." + } + } + }, + "Api": { + "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.", + "type": "object", + "properties": { + "name": { + "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.", + "type": "string" + }, + "syntax": { + "description": "The source syntax of the service.", + "type": "string", + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ] + }, + "sourceContext": { + "$ref": "SourceContext", + "description": "Source context for the protocol buffer service represented by this\nmessage." + }, + "version": { + "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n", + "type": "string" + }, + "mixins": { + "description": "Included interfaces. See Mixin.", + "type": "array", + "items": { + "$ref": "Mixin" + } + }, + "options": { + "description": "Any metadata attached to the interface.", + "type": "array", + "items": { + "$ref": "Option" + } + }, + "methods": { + "description": "The methods of this interface, in unspecified order.", + "type": "array", + "items": { + "$ref": "Method" + } + } + }, + "id": "Api" + }, + "CancelOperationRequest": { + "description": "The request message for Operations.CancelOperation.", + "type": "object", + "properties": {}, + "id": "CancelOperationRequest" + }, + "MetricRule": { + "id": "MetricRule", + "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.", + "type": "object", + "properties": { + "selector": { + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "metricCosts": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.", + "type": "object" + } + } + }, + "TenantProjectPolicy": { + "description": "Describes policy settings that need to be applied to a newly\ncreated Tenant Project.", + "type": "object", + "properties": { + "policyBindings": { + "description": "Additional policy bindings to be applied on the tenant\nproject.\nAt least one owner must be set in the bindings. Among the list of members\nas owners, at least one of them must be either `user` or `group` based.", + "type": "array", + "items": { + "$ref": "PolicyBinding" + } + } + }, + "id": "TenantProjectPolicy" + }, + "Authentication": { + "id": "Authentication", + "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", + "type": "object", + "properties": { + "rules": { + "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "AuthenticationRule" + } + }, + "providers": { + "description": "Defines a set of authentication providers that a service supports.", + "type": "array", + "items": { + "$ref": "AuthProvider" + } + } + } + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "properties": { + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "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": { + "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", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "id": "Operation" + }, + "Page": { + "id": "Page", + "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.", + "type": "object", + "properties": { + "subpages": { + "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.", + "type": "array", + "items": { + "$ref": "Page" + } + }, + "name": { + "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.", + "type": "string" + }, + "content": { + "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.", + "type": "string" + } + } + }, + "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.", + "type": "object", + "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" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + } + }, + "id": "Status" + }, + "AuthProvider": { + "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", + "type": "object", + "properties": { + "id": { + "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".", + "type": "string" + }, + "issuer": { + "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com", + "type": "string" + }, + "authorizationUrl": { + "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.", + "type": "string" + }, + "jwksUri": { + "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs", + "type": "string" + }, + "audiences": { + "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", + "type": "string" + } + }, + "id": "AuthProvider" + }, + "AddTenantProjectRequest": { + "description": "Request to add a newly created and configured tenant project to tenancy\nunit.", + "type": "object", + "properties": { + "projectConfig": { + "description": "Configuration of the new tenant project that will be added to tenancy unit\nresources.", + "$ref": "TenantProjectConfig" + }, + "tag": { + "description": "Tag of the added project. Must be less than 128 characters. Required.", + "type": "string" + } + }, + "id": "AddTenantProjectRequest" + }, + "Service": { + "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", + "type": "object", + "properties": { + "types": { + "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32", + "type": "array", + "items": { + "$ref": "Type" + } + }, + "sourceInfo": { + "$ref": "SourceInfo", + "description": "Output only. The source information for this configuration if available." + }, + "http": { + "description": "HTTP configuration.", + "$ref": "Http" + }, + "systemParameters": { + "$ref": "SystemParameters", + "description": "System parameter configuration." + }, + "backend": { + "$ref": "Backend", + "description": "API backend configuration." + }, + "documentation": { + "$ref": "Documentation", + "description": "Additional API documentation." + }, + "logging": { + "description": "Logging configuration.", + "$ref": "Logging" + }, + "monitoredResources": { + "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", + "type": "array", + "items": { + "$ref": "MonitoredResourceDescriptor" + } + }, + "enums": { + "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum", + "type": "array", + "items": { + "$ref": "Enum" + } + }, + "context": { + "$ref": "Context", + "description": "Context configuration." + }, + "id": { + "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", + "type": "string" + }, + "usage": { + "$ref": "Usage", + "description": "Configuration controlling usage of this service." + }, + "metrics": { + "description": "Defines the metrics used by this service.", + "type": "array", + "items": { + "$ref": "MetricDescriptor" + } + }, + "authentication": { + "description": "Auth configuration.", + "$ref": "Authentication" + }, + "experimental": { + "description": "Experimental configuration.", + "$ref": "Experimental" + }, + "control": { + "$ref": "Control", + "description": "Configuration for the service control plane." + }, + "configVersion": { + "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.", + "format": "uint32", + "type": "integer" + }, + "monitoring": { + "$ref": "Monitoring", + "description": "Monitoring configuration." + }, + "producerProjectId": { + "description": "The Google project that owns this service.", + "type": "string" + }, + "systemTypes": { + "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.", + "type": "array", + "items": { + "$ref": "Type" + } + }, + "visibility": { + "description": "API visibility configuration.", + "$ref": "Visibility" + }, + "quota": { + "description": "Quota configuration.", + "$ref": "Quota" + }, + "name": { + "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", + "type": "string" + }, + "billing": { + "description": "Billing configuration.", + "$ref": "Billing" + }, + "customError": { + "$ref": "CustomError", + "description": "Custom error configuration." + }, + "title": { + "description": "The product title for this service.", + "type": "string" + }, + "endpoints": { + "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.", + "type": "array", + "items": { + "$ref": "Endpoint" + } + }, + "logs": { + "description": "Defines the logs used by this service.", + "type": "array", + "items": { + "$ref": "LogDescriptor" + } + }, + "apis": { + "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.", + "type": "array", + "items": { + "$ref": "Api" + } + } + }, + "id": "Service" + }, + "EnumValue": { + "description": "Enum value definition.", + "type": "object", + "properties": { + "number": { + "description": "Enum value number.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "Enum value name.", + "type": "string" + }, + "options": { + "description": "Protocol buffer options.", + "type": "array", + "items": { + "$ref": "Option" + } + } + }, + "id": "EnumValue" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "properties": { + "operations": { + "description": "A list of operations that matches the specified filter in the request.", + "type": "array", + "items": { + "$ref": "Operation" + } + }, + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + } + }, + "id": "ListOperationsResponse" + }, + "CustomHttpPattern": { + "description": "A custom pattern is used for defining custom HTTP verb.", + "type": "object", + "properties": { + "path": { + "description": "The path matched by this custom verb.", + "type": "string" + }, + "kind": { + "description": "The name of this custom HTTP verb.", + "type": "string" + } + }, + "id": "CustomHttpPattern" + }, + "SystemParameterRule": { + "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.", + "type": "object", + "properties": { + "selector": { + "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "parameters": { + "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.", + "type": "array", + "items": { + "$ref": "SystemParameter" + } + } + }, + "id": "SystemParameterRule" + }, + "BillingConfig": { + "description": "Describes billing configuration for new a Tenant Project", + "type": "object", + "properties": { + "billingAccount": { + "description": "Name of the billing account.\nFor example `billingAccounts/012345-567890-ABCDEF`.", + "type": "string" + } + }, + "id": "BillingConfig" + }, + "RemoveTenantProjectRequest": { + "description": "Request message to remove tenant project resource from the tenancy unit.", + "type": "object", + "properties": { + "tag": { + "description": "Tag of the resource within the tenancy unit.", + "type": "string" + } + }, + "id": "RemoveTenantProjectRequest" + }, + "TenantResource": { + "description": "Resource constituting the TenancyUnit.", + "type": "object", + "properties": { + "tag": { + "description": "Unique per single tenancy unit.", + "type": "string" + }, + "resource": { + "description": "@OutputOnly Identifier of the tenant resource.\nFor cloud projects it is in the form 'projects/{number}'.\nFor example 'projects/123456'.", + "type": "string" + }, + "status": { + "description": "Status of tenant resource.", + "type": "string", + "enumDescriptions": [ + "Unspecified status is the default unset value.", + "Creation of the tenant resource is ongoing.", + "Active resource.", + "Deletion of the resource is ongoing.", + "Tenant resource creation or deletion has failed." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "PENDING_CREATE", + "ACTIVE", + "PENDING_DELETE", + "FAILED" + ] + } + }, + "id": "TenantResource" + }, + "HttpRule": { + "id": "HttpRule", + "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.", + "type": "object", + "properties": { + "restMethodName": { + "description": "DO NOT USE. This is an experimental field.\n\nOptional. The rest method name is by default derived from the URL\npattern. If specified, this field overrides the default method name.\nExample:\n\n rpc CreateResource(CreateResourceRequest)\n returns (CreateResourceResponse) {\n option (google.api.http) = {\n post: \"/v1/resources\",\n body: \"resource\",\n rest_method_name: \"insert\"\n };\n }\n\nThis method has the automatically derived rest method name\n\"create\", but for backwards compatibility with apiary, it is specified as\ninsert.", + "type": "string" + }, + "additionalBindings": { + "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", + "type": "array", + "items": { + "$ref": "HttpRule" + } + }, + "restCollection": { + "description": "DO NOT USE. This is an experimental field.\n\nOptional. The REST collection name is by default derived from the URL\npattern. If specified, this field overrides the default collection name.\nExample:\n\n rpc AddressesAggregatedList(AddressesAggregatedListRequest)\n returns (AddressesAggregatedListResponse) {\n option (google.api.http) = {\n get: \"/v1/projects/{project_id}/aggregated/addresses\"\n rest_collection: \"projects.addresses\"\n };\n }\n\nThis method has the automatically derived collection name\n\"projects.aggregated\". Because, semantically, this rpc is actually an\noperation on the \"projects.addresses\" collection, the `rest_collection`\nfield is configured to override the derived collection name.", + "type": "string" + }, + "responseBody": { + "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.", + "type": "string" + }, + "mediaUpload": { + "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods.", + "$ref": "MediaUpload" + }, + "selector": { + "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "custom": { + "$ref": "CustomHttpPattern", + "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients." + }, + "patch": { + "description": "Used for updating a resource.", + "type": "string" + }, + "get": { + "description": "Used for listing and getting information about resources.", + "type": "string" + }, + "put": { + "description": "Used for updating a resource.", + "type": "string" + }, + "authorizations": { + "description": "Specifies the permission(s) required for an API element for the overall\nAPI request to succeed. It is typically used to mark request message fields\nthat contain the name of the resource and indicates the permissions that\nwill be checked on that resource.", + "type": "array", + "items": { + "$ref": "AuthorizationRule" + } + }, + "delete": { + "description": "Used for deleting a resource.", + "type": "string" + }, + "body": { + "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", + "type": "string" + }, + "mediaDownload": { + "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.", + "$ref": "MediaDownload" + }, + "post": { + "description": "Used for creating a resource.", + "type": "string" + } + } + }, + "VisibilityRule": { + "description": "A visibility rule provides visibility configuration for an individual API\nelement.", + "type": "object", + "properties": { + "restriction": { + "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", + "type": "string" + }, + "selector": { + "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + } + }, + "id": "VisibilityRule" + }, + "MonitoringDestination": { + "id": "MonitoringDestination", + "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).", + "type": "object", + "properties": { + "monitoredResource": { + "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", + "type": "string" + }, + "metrics": { + "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TenancyUnit": { + "description": "Representation of a tenancy unit.", + "type": "object", + "properties": { + "consumer": { + "description": "@OutputOnly Cloud resource One Platform Name of the consumer of this\nservice. For example 'projects/123456'.", + "type": "string" + }, + "createTime": { + "description": "@OutputOnly The time this tenancy unit was created.", + "format": "google-datetime", + "type": "string" + }, + "service": { + "description": "@OutputOnly Google Cloud API name of the service owning this tenancy unit.\nFor example 'serviceconsumermanagement.googleapis.com'.", + "type": "string" + }, + "name": { + "description": "Globally unique identifier of this tenancy unit\n\"services/{service}/{collection id}/{resource id}/tenancyUnits/{unit}\"", + "type": "string" + }, + "tenantResources": { + "description": "Resources constituting the tenancy unit.", + "type": "array", + "items": { + "$ref": "TenantResource" + } + } + }, + "id": "TenancyUnit" + }, + "Visibility": { + "id": "Visibility", + "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.", + "type": "object", + "properties": { + "rules": { + "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "VisibilityRule" + } + } + } + }, + "SystemParameters": { + "id": "SystemParameters", + "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.", + "type": "object", + "properties": { + "rules": { + "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "SystemParameterRule" + } + } + } + }, + "Quota": { + "id": "Quota", + "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", + "type": "object", + "properties": { + "limits": { + "description": "List of `QuotaLimit` definitions for the service.", + "type": "array", + "items": { + "$ref": "QuotaLimit" + } + }, + "metricRules": { + "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.", + "type": "array", + "items": { + "$ref": "MetricRule" + } + } + } + }, + "TenantProjectConfig": { + "id": "TenantProjectConfig", + "description": "This structure defines a tenant project to be added to the specified tenancy\nunit and its initial configuration and properties. A project lien will be\ncreated for the tenant project to prevent the tenant project from being\ndeleted accidentally. The lien will be deleted as part of tenant project\nremoval.", + "type": "object", + "properties": { + "services": { + "description": "Google Cloud API names of services that will be activated on this project\nduring provisioning. If any of these services can not be activated,\naddTenantProject method will fail.\nFor example: 'compute.googleapis.com','cloudfunctions.googleapis.com'", + "type": "array", + "items": { + "type": "string" + } + }, + "billingConfig": { + "$ref": "BillingConfig", + "description": "Billing account properties.\nIt may be specified explicitly, or created from the specified group\nduring provisioning" + }, + "tenantProjectPolicy": { + "$ref": "TenantProjectPolicy", + "description": "Describes ownership and policies for the new tenant project. Required." + }, + "folder": { + "description": "Folder where project in this tenancy unit must be located\nThis folder must have been previously created with proper\npermissions for the caller to create and configure a project in it.\nValid folder resource names have the format `folders/{folder_number}`\n(for example, `folders/123456`).", + "type": "string" + }, + "labels": { + "description": "Labels that will be applied to this project.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "serviceAccountConfig": { + "description": "Configuration for IAM service account on tenant project.", + "$ref": "ServiceAccountConfig" + } + } + }, + "PolicyBinding": { + "id": "PolicyBinding", + "description": "Translates to IAM Policy bindings (without auditing at this level)", + "type": "object", + "properties": { + "members": { + "description": "Uses the same format as in IAM policy.\n`member` must include both prefix and id. E.g., `user:{emailId}`,\n`serviceAccount:{emailId}`, `group:{emailId}`.", + "type": "array", + "items": { + "type": "string" + } + }, + "role": { + "description": "Role. (https://cloud.google.com/iam/docs/understanding-roles)\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.", + "type": "string" + } + } + }, + "LoggingDestination": { + "id": "LoggingDestination", + "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", + "type": "object", + "properties": { + "logs": { + "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", + "type": "array", + "items": { + "type": "string" + } + }, + "monitoredResource": { + "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.", + "type": "string" + } + } + }, + "Option": { + "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", + "type": "object", + "properties": { + "name": { + "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.", + "type": "string" + }, + "value": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.", + "type": "object" + } + }, + "id": "Option" + }, + "Logging": { + "id": "Logging", + "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history", + "type": "object", + "properties": { + "consumerDestinations": { + "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "LoggingDestination" + } + }, + "producerDestinations": { + "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.", + "type": "array", + "items": { + "$ref": "LoggingDestination" + } + } + } + }, + "QuotaLimit": { + "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.", + "type": "object", + "properties": { + "unit": { + "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.", + "type": "string" + }, + "maxLimit": { + "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.", + "type": "string" + }, + "duration": { + "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.", + "type": "string" + }, + "freeTier": { + "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "defaultLimit": { + "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).", + "type": "string" + }, + "metric": { + "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.", + "type": "string" + }, + "displayName": { + "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.", + "type": "string" + }, + "values": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.", + "type": "object" + } + }, + "id": "QuotaLimit" + }, + "Method": { + "id": "Method", + "description": "Method represents a method of an API interface.", + "type": "object", + "properties": { + "name": { + "description": "The simple name of this method.", + "type": "string" + }, + "requestTypeUrl": { + "description": "A URL of the input message type.", + "type": "string" + }, + "requestStreaming": { + "description": "If true, the request is streamed.", + "type": "boolean" + }, + "syntax": { + "description": "The source syntax of this method.", + "type": "string", + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ] + }, + "responseTypeUrl": { + "description": "The URL of the output message type.", + "type": "string" + }, + "options": { + "description": "Any metadata attached to the method.", + "type": "array", + "items": { + "$ref": "Option" + } + }, + "responseStreaming": { + "description": "If true, the response is streamed.", + "type": "boolean" + } + } } }, "protocol": "rest", "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "canonicalName": "Service Consumer Management", "auth": { @@ -2358,5 +1927,436 @@ } } } - } + }, + "rootUrl": "https://serviceconsumermanagement.googleapis.com/", + "ownerDomain": "google.com", + "name": "serviceconsumermanagement", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Service Consumer Management API", + "ownerName": "Google", + "resources": { + "services": { + "methods": { + "search": { + "id": "serviceconsumermanagement.services.search", + "path": "v1/{+parent}:search", + "description": "Search tenancy units for a service.", + "httpMethod": "GET", + "response": { + "$ref": "SearchTenancyUnitsResponse" + }, + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageToken": { + "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.\n\nOptional.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of results returned by this request. Currently, the\ndefault maximum is set to 1000. If page_size is not provided or provided a\nnumber larger than 1000, it will be automatically set to 1000.\n\nOptional.", + "format": "int32", + "type": "integer" + }, + "query": { + "location": "query", + "description": "Set a query `{expression}` for querying tenancy units. Your `{expression}`\nmust be in the format: `field_name=literal_string`. The `field_name` is the\nname of the field you want to compare. Supported fields are\n`tenant_resources.tag` and`tenant_resources.resource`.\n\nFor example, to search tenancy units that contain at least one tenant\nresource with given tag 'xyz', use query `tenant_resources.tag=xyz`.\nTo search tenancy units that contain at least one tenant resource with\ngiven resource name 'projects/123456', use query\n`tenant_resources.resource=projects/123456`.\n\nMultiple expressions can be joined with `AND`s. Tenancy units must match\nall expressions to be included in the result set. For example,\n`tenant_resources.tag=xyz AND tenant_resources.resource=projects/123456`\n\nOptional.", + "type": "string" + }, + "parent": { + "description": "Service for which search is performed.\nservices/{service}\n{service} the name of a service, for example 'service.googleapis.com'.", + "required": true, + "type": "string", + "pattern": "^services/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/services/{servicesId}:search" + } + }, + "resources": { + "tenancyUnits": { + "methods": { + "create": { + "id": "serviceconsumermanagement.services.tenancyUnits.create", + "path": "v1/{+parent}/tenancyUnits", + "request": { + "$ref": "CreateTenancyUnitRequest" + }, + "description": "Creates a tenancy unit with no tenant resources.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "TenancyUnit" + }, + "parameters": { + "parent": { + "pattern": "^services/[^/]+/[^/]+/[^/]+$", + "location": "path", + "description": "services/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.\nEnabled service binding using the new tenancy unit.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits" + }, + "removeProject": { + "parameters": { + "name": { + "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$", + "location": "path", + "description": "Name of the tenancy unit.\nSuch as 'services/service.googleapis.com/projects/12345/tenancyUnits/abcd'.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:removeProject", + "path": "v1/{+name}:removeProject", + "id": "serviceconsumermanagement.services.tenancyUnits.removeProject", + "request": { + "$ref": "RemoveTenantProjectRequest" + }, + "description": "Removes specified project resource identified by tenant resource tag.\nIt will remove project lien with 'TenantManager' origin if that was added.\nIt will then attempt to delete the project.\nIf that operation fails, this method fails.\nOperation\u003cresponse: Empty\u003e.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST" + }, + "delete": { + "path": "v1/{+name}", + "id": "serviceconsumermanagement.services.tenancyUnits.delete", + "description": "Delete tenancy unit. Before the tenancy unit is deleted, there should be\nno tenant resource in it.\nOperation\u003cresponse: Empty\u003e.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$", + "location": "path", + "description": "Name of the tenancy unit to be deleted.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}" + }, + "addProject": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "parent": { + "pattern": "^services/[^/]+/[^/]+/[^/]+/tenancyUnits/[^/]+$", + "location": "path", + "description": "Name of the tenancy unit.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits/{tenancyUnitsId}:addProject", + "path": "v1/{+parent}:addProject", + "id": "serviceconsumermanagement.services.tenancyUnits.addProject", + "description": "Add a new tenant project to the tenancy unit.\nIf there are previously failed AddTenantProject calls, you might need to\ncall RemoveTenantProject first to clean them before you can make another\nAddTenantProject with the same tag.\nOperation\u003cresponse: Empty\u003e.", + "request": { + "$ref": "AddTenantProjectRequest" + } + }, + "list": { + "id": "serviceconsumermanagement.services.tenancyUnits.list", + "path": "v1/{+parent}/tenancyUnits", + "description": "Find tenancy unit for a service and consumer.\nThis method should not be used in producers' runtime path, e.g. finding\nthe tenant project number when creating VMs. Producers should persist\nthe tenant project information after the project is created.", + "httpMethod": "GET", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "ListTenancyUnitsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "pageToken": { + "description": "The continuation token, which is used to page through large result sets.\nTo get the next page of results, set this parameter to the value of\n`nextPageToken` from the previous response.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of results returned by this request.", + "format": "int32", + "type": "integer" + }, + "parent": { + "pattern": "^services/[^/]+/[^/]+/[^/]+$", + "location": "path", + "description": "Service and consumer. Required.\nservices/{service}/{collection id}/{resource id}\n{collection id} is the cloud resource collection type representing the\nservice consumer, for example 'projects', or 'organizations'.\n{resource id} is the consumer numeric id, such as project number: '123456'.\n{service} the name of a service, for example 'service.googleapis.com'.", + "required": true, + "type": "string" + }, + "filter": { + "description": "Filter expression over tenancy resources field. Optional.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/services/{servicesId}/{servicesId1}/{servicesId2}/tenancyUnits" + } + } + } + } + }, + "operations": { + "methods": { + "cancel": { + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "name": { + "pattern": "^operations/.+$", + "location": "path", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/operations/{operationsId}:cancel", + "id": "serviceconsumermanagement.operations.cancel", + "path": "v1/{+name}:cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "request": { + "$ref": "CancelOperationRequest" + } + }, + "delete": { + "path": "v1/{+name}", + "id": "serviceconsumermanagement.operations.delete", + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "name": { + "pattern": "^operations/.+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/operations/{operationsId}" + }, + "list": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "name": { + "pattern": "^operations$", + "location": "path", + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "flatPath": "v1/operations", + "path": "v1/{+name}", + "id": "serviceconsumermanagement.operations.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.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET" + }, + "get": { + "path": "v1/{+name}", + "id": "serviceconsumermanagement.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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "pattern": "^operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/operations/{operationsId}" + } + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://serviceconsumermanagement.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Provides management methods for configuring service producer resources on Google Cloud.", + "servicePath": "", + "basePath": "" }
diff --git a/servicecontrol/v1/servicecontrol-api.json b/servicecontrol/v1/servicecontrol-api.json index ae7f887..d9c3d1f 100644 --- a/servicecontrol/v1/servicecontrol-api.json +++ b/servicecontrol/v1/servicecontrol-api.json
@@ -1,29 +1,42 @@ { - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/servicecontrol": { - "description": "Manage your Google Service Control data" - } - } - } - }, - "rootUrl": "https://servicecontrol.googleapis.com/", - "ownerDomain": "google.com", - "name": "servicecontrol", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Service Control API", - "ownerName": "Google", "resources": { "services": { "methods": { - "releaseQuota": { + "startReconciliation": { + "flatPath": "v1/services/{serviceName}:startReconciliation", + "path": "v1/services/{serviceName}:startReconciliation", + "id": "servicecontrol.services.startReconciliation", + "request": { + "$ref": "StartReconciliationRequest" + }, + "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", "response": { - "$ref": "ReleaseQuotaResponse" + "$ref": "StartReconciliationResponse" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST", + "parameters": { + "serviceName": { + "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/servicecontrol" + ] + }, + "check": { + "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", + "request": { + "$ref": "CheckRequest" + }, + "response": { + "$ref": "CheckResponse" }, "parameterOrder": [ "serviceName" @@ -35,32 +48,56 @@ ], "parameters": { "serviceName": { + "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/services/{serviceName}:check", + "path": "v1/services/{serviceName}:check", + "id": "servicecontrol.services.check" + }, + "releaseQuota": { + "response": { + "$ref": "ReleaseQuotaResponse" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST", + "parameters": { + "serviceName": { "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.", "required": true, "type": "string", "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/servicecontrol" + ], "flatPath": "v1/services/{serviceName}:releaseQuota", "path": "v1/services/{serviceName}:releaseQuota", "id": "servicecontrol.services.releaseQuota", - "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.", "request": { "$ref": "ReleaseQuotaRequest" - } + }, + "description": "Releases previously allocated quota done through AllocateQuota method.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality." }, "endReconciliation": { "request": { "$ref": "EndReconciliationRequest" }, "description": "Signals the quota controller that service ends the ongoing usage\nreconciliation.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", - "httpMethod": "POST", - "parameterOrder": [ - "serviceName" - ], "response": { "$ref": "EndReconciliationResponse" }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST", "parameters": { "serviceName": { "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.", @@ -74,21 +111,21 @@ "https://www.googleapis.com/auth/servicecontrol" ], "flatPath": "v1/services/{serviceName}:endReconciliation", - "id": "servicecontrol.services.endReconciliation", - "path": "v1/services/{serviceName}:endReconciliation" + "path": "v1/services/{serviceName}:endReconciliation", + "id": "servicecontrol.services.endReconciliation" }, "report": { "request": { "$ref": "ReportRequest" }, "description": "Reports operation results to Google Service Control, such as logs and\nmetrics. It should be called after an operation is completed.\n\nIf feasible, the client should aggregate reporting data for up to 5\nseconds to reduce API traffic. Limiting aggregation to 5 seconds is to\nreduce data loss during client crashes. Clients should carefully choose\nthe aggregation time window to avoid data loss risk more than 0.01%\nfor business and compliance reasons.\n\nNOTE: the ReportRequest has the size limit of 1MB.\n\nThis method requires the `servicemanagement.services.report` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", - "response": { - "$ref": "ReportResponse" - }, + "httpMethod": "POST", "parameterOrder": [ "serviceName" ], - "httpMethod": "POST", + "response": { + "$ref": "ReportResponse" + }, "parameters": { "serviceName": { "location": "path", @@ -102,14 +139,16 @@ "https://www.googleapis.com/auth/servicecontrol" ], "flatPath": "v1/services/{serviceName}:report", - "path": "v1/services/{serviceName}:report", - "id": "servicecontrol.services.report" + "id": "servicecontrol.services.report", + "path": "v1/services/{serviceName}:report" }, "allocateQuota": { - "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.", + "path": "v1/services/{serviceName}:allocateQuota", + "id": "servicecontrol.services.allocateQuota", "request": { "$ref": "AllocateQuotaRequest" }, + "description": "Attempts to allocate quota for the specified consumer. It should be called\nbefore the operation is executed.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Cloud IAM](https://cloud.google.com/iam).\n\n**NOTE:** The client **must** fail-open on server errors `INTERNAL`,\n`UNKNOWN`, `DEADLINE_EXCEEDED`, and `UNAVAILABLE`. To ensure system\nreliability, the server may inject these errors to prohibit any hard\ndependency on the quota functionality.", "response": { "$ref": "AllocateQuotaResponse" }, @@ -117,30 +156,6 @@ "serviceName" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/servicecontrol" - ], - "parameters": { - "serviceName": { - "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/services/{serviceName}:allocateQuota", - "path": "v1/services/{serviceName}:allocateQuota", - "id": "servicecontrol.services.allocateQuota" - }, - "startReconciliation": { - "httpMethod": "POST", - "parameterOrder": [ - "serviceName" - ], - "response": { - "$ref": "StartReconciliationResponse" - }, "parameters": { "serviceName": { "description": "Name of the service as specified in the service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee google.api.Service for the definition of a service name.", @@ -153,46 +168,43 @@ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/servicecontrol" ], - "flatPath": "v1/services/{serviceName}:startReconciliation", - "id": "servicecontrol.services.startReconciliation", - "path": "v1/services/{serviceName}:startReconciliation", - "request": { - "$ref": "StartReconciliationRequest" - }, - "description": "Unlike rate quota, allocation quota does not get refilled periodically.\nSo, it is possible that the quota usage as seen by the service differs from\nwhat the One Platform considers the usage is. This is expected to happen\nonly rarely, but over time this can accumulate. Services can invoke\nStartReconciliation and EndReconciliation to correct this usage drift, as\ndescribed below:\n1. Service sends StartReconciliation with a timestamp in future for each\n metric that needs to be reconciled. The timestamp being in future allows\n to account for in-flight AllocateQuota and ReleaseQuota requests for the\n same metric.\n2. One Platform records this timestamp and starts tracking subsequent\n AllocateQuota and ReleaseQuota requests until EndReconciliation is\n called.\n3. At or after the time specified in the StartReconciliation, service\n sends EndReconciliation with the usage that needs to be reconciled to.\n4. One Platform adjusts its own record of usage for that metric to the\n value specified in EndReconciliation by taking in to account any\n allocation or release between StartReconciliation and EndReconciliation.\n\nSignals the quota controller that the service wants to perform a usage\nreconciliation as specified in the request.\n\nThis method requires the `servicemanagement.services.quota`\npermission on the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam)." - }, - "check": { - "flatPath": "v1/services/{serviceName}:check", - "path": "v1/services/{serviceName}:check", - "id": "servicecontrol.services.check", - "request": { - "$ref": "CheckRequest" - }, - "description": "Checks an operation with Google Service Control to decide whether\nthe given operation should proceed. It should be called before the\noperation is executed.\n\nIf feasible, the client should cache the check results and reuse them for\n60 seconds. In case of server errors, the client can rely on the cached\nresults for longer time.\n\nNOTE: the CheckRequest has the size limit of 64KB.\n\nThis method requires the `servicemanagement.services.check` permission\non the specified service. For more information, see\n[Google Cloud IAM](https://cloud.google.com/iam).", - "response": { - "$ref": "CheckResponse" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "POST", - "parameters": { - "serviceName": { - "location": "path", - "description": "The service name as specified in its service configuration. For example,\n`\"pubsub.googleapis.com\"`.\n\nSee\n[google.api.Service](https://cloud.google.com/service-management/reference/rpc/google.api#google.api.Service)\nfor the definition of a service name.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/servicecontrol" - ] + "flatPath": "v1/services/{serviceName}:allocateQuota" } } } }, "parameters": { + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, "$.xgafv": { "description": "V1 error format.", "type": "string", @@ -207,11 +219,17 @@ ] }, "callback": { + "description": "JSONP", "type": "string", - "location": "query", - "description": "JSONP" + "location": "query" }, "alt": { + "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -219,18 +237,12 @@ "media", "proto" ], - "type": "string", - "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": { - "location": "query", "description": "OAuth access token.", - "type": "string" + "type": "string", + "location": "query" }, "key": { "location": "query", @@ -243,84 +255,52 @@ "location": "query" }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" + "default": "true" } }, "version": "v1", "baseUrl": "https://servicecontrol.googleapis.com/", - "servicePath": "", - "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.", "kind": "discovery#restDescription", + "description": "Google Service Control provides control plane functionality to managed services, such as logging, monitoring, and status checks.", + "servicePath": "", "basePath": "", - "id": "servicecontrol:v1", - "documentationLink": "https://cloud.google.com/service-control/", "revision": "20171229", + "documentationLink": "https://cloud.google.com/service-control/", + "id": "servicecontrol:v1", "discoveryVersion": "v1", "version_module": true, "schemas": { - "AllocateInfo": { - "type": "object", + "CheckResponse": { "properties": { - "unusedArguments": { - "description": "A list of label keys that were unused by the server in processing the\nrequest. Thus, for similar requests repeated in a certain future time\nwindow, the caller can choose to ignore these labels in the requests\nto achieve better client-side cache hits and quota aggregation.", + "operationId": { + "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.", + "type": "string" + }, + "checkErrors": { + "description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.", "type": "array", "items": { - "type": "string" - } - } - }, - "id": "AllocateInfo" - }, - "ReportRequest": { - "properties": { - "operations": { - "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.", - "type": "array", - "items": { - "$ref": "Operation" + "$ref": "CheckError" } }, + "checkInfo": { + "$ref": "CheckInfo", + "description": "Feedback data returned from the server during processing a Check request." + }, + "quotaInfo": { + "description": "Quota information for the check request associated with this response.\n", + "$ref": "QuotaInfo" + }, "serviceConfigId": { - "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.", + "description": "The actual config id used to process the request.", "type": "string" } }, - "id": "ReportRequest", - "description": "Request message for the Report method.", + "id": "CheckResponse", + "description": "Response message for the Check method.", "type": "object" }, "Status": { @@ -350,83 +330,94 @@ }, "id": "Status" }, - "LogEntry": { - "id": "LogEntry", - "description": "An individual log entry.", - "type": "object", + "ReportRequest": { "properties": { - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", - "type": "object" - }, - "severity": { - "type": "string", - "enumDescriptions": [ - "(0) The log entry has no assigned severity level.", - "(100) Debug or trace information.", - "(200) Routine information, such as ongoing status or performance.", - "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", - "(400) Warning events might cause problems.", - "(500) Error events are likely to cause problems.", - "(600) Critical events cause more severe problems or outages.", - "(700) A person must take an action immediately.", - "(800) One or more systems are unusable." - ], - "enum": [ - "DEFAULT", - "DEBUG", - "INFO", - "NOTICE", - "WARNING", - "ERROR", - "CRITICAL", - "ALERT", - "EMERGENCY" - ], - "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`." - }, - "name": { - "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.", - "type": "string" - }, - "insertId": { - "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.", - "type": "string" - }, - "structPayload": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.", - "type": "object" - }, - "textPayload": { - "description": "The log entry payload, represented as a Unicode string (UTF-8).", - "type": "string" - }, - "protoPayload": { - "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" + "operations": { + "description": "Operations to be reported.\n\nTypically the service should report one operation per request.\nPutting multiple operations into a single request is allowed, but should\nbe used only when multiple operations are natually available at the time\nof the report.\n\nIf multiple operations are in a single request, the total request size\nshould be no larger than 1MB. See ReportResponse.report_errors for\npartial failure behavior.", + "type": "array", + "items": { + "$ref": "Operation" } }, - "timestamp": { - "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.", - "format": "google-datetime", + "serviceConfigId": { + "description": "Specifies which version of service config should be used to process the\nrequest.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.", "type": "string" } - } + }, + "id": "ReportRequest", + "description": "Request message for the Report method.", + "type": "object" + }, + "AllocateInfo": { + "type": "object", + "properties": { + "unusedArguments": { + "description": "A list of label keys that were unused by the server in processing the\nrequest. Thus, for similar requests repeated in a certain future time\nwindow, the caller can choose to ignore these labels in the requests\nto achieve better client-side cache hits and quota aggregation.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "AllocateInfo" }, "AuditLog": { "description": "Common audit log format for Google Cloud Platform API operations.\n\n", "type": "object", "properties": { + "requestMetadata": { + "description": "Metadata about the operation.", + "$ref": "RequestMetadata" + }, + "status": { + "description": "The status of the overall operation.", + "$ref": "Status" + }, + "authenticationInfo": { + "description": "Authentication information.", + "$ref": "AuthenticationInfo" + }, + "response": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.", + "type": "object" + }, + "serviceName": { + "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "Other service-specific data about the request, response, and other\ninformation associated with the current audited event.", + "type": "object" + }, + "methodName": { + "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"", + "type": "string" + }, + "resourceName": { + "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"", + "type": "string" + }, + "serviceData": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.", + "type": "object" + }, + "numResponseItems": { + "description": "The number of items returned from a List or Query API method,\nif applicable.", + "format": "int64", + "type": "string" + }, "authorizationInfo": { "description": "Authorization information. If there are multiple\nresources or permissions involved, then there is\none AuthorizationInfo element for each {resource, permission} tuple.", "type": "array", @@ -441,76 +432,87 @@ }, "description": "The operation request. This may not include all request parameters,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.", "type": "object" - }, - "requestMetadata": { - "$ref": "RequestMetadata", - "description": "Metadata about the operation." - }, - "status": { - "$ref": "Status", - "description": "The status of the overall operation." - }, - "authenticationInfo": { - "description": "Authentication information.", - "$ref": "AuthenticationInfo" - }, - "serviceName": { - "description": "The name of the API service performing the operation. For example,\n`\"datastore.googleapis.com\"`.", - "type": "string" - }, - "response": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The operation response. This may not include all response elements,\nsuch as those that are too large, privacy-sensitive, or duplicated\nelsewhere in the log record.\nIt should never include user-generated data, such as file contents.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.", - "type": "object" - }, - "metadata": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Other service-specific data about the request, response, and other\ninformation associated with the current audited event." - }, - "methodName": { - "type": "string", - "description": "The name of the service method or operation.\nFor API calls, this should be the name of the API method.\nFor example,\n\n \"google.datastore.v1.Datastore.RunQuery\"\n \"google.logging.v1.LoggingService.DeleteLog\"" - }, - "resourceName": { - "description": "The resource or collection that is the target of the operation.\nThe name is a scheme-less URI, not including the API service name.\nFor example:\n\n \"shelves/SHELF_ID/books\"\n \"shelves/SHELF_ID/books/BOOK_ID\"", - "type": "string" - }, - "serviceData": { - "description": "Deprecated, use `metadata` field instead.\nOther service-specific data about the request, response, and other\nactivities.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "numResponseItems": { - "description": "The number of items returned from a List or Query API method,\nif applicable.", - "format": "int64", - "type": "string" } }, "id": "AuditLog" }, - "MetricValue": { + "LogEntry": { + "description": "An individual log entry.", + "type": "object", "properties": { + "severity": { + "enum": [ + "DEFAULT", + "DEBUG", + "INFO", + "NOTICE", + "WARNING", + "ERROR", + "CRITICAL", + "ALERT", + "EMERGENCY" + ], + "description": "The severity of the log entry. The default value is\n`LogSeverity.DEFAULT`.", + "type": "string", + "enumDescriptions": [ + "(0) The log entry has no assigned severity level.", + "(100) Debug or trace information.", + "(200) Routine information, such as ongoing status or performance.", + "(300) Normal but significant events, such as start up, shut down, or\na configuration change.", + "(400) Warning events might cause problems.", + "(500) Error events are likely to cause problems.", + "(600) Critical events cause more severe problems or outages.", + "(700) A person must take an action immediately.", + "(800) One or more systems are unusable." + ] + }, + "name": { + "description": "Required. The log to which this log entry belongs. Examples: `\"syslog\"`,\n`\"book_log\"`.", + "type": "string" + }, + "insertId": { + "description": "A unique ID for the log entry used for deduplication. If omitted,\nthe implementation will generate one based on operation_id.", + "type": "string" + }, + "structPayload": { + "description": "The log entry payload, represented as a structure that\nis expressed as a JSON object.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + } + }, + "textPayload": { + "description": "The log entry payload, represented as a Unicode string (UTF-8).", + "type": "string" + }, + "protoPayload": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The log entry payload, represented as a protocol buffer that is\nexpressed as a JSON object. The only accepted type currently is\nAuditLog.", + "type": "object" + }, + "timestamp": { + "description": "The time the event described by the log entry occurred. If\nomitted, defaults to operation start time.", + "format": "google-datetime", + "type": "string" + }, "labels": { - "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.", + "description": "A set of user-defined (key, value) data that provides additional\ninformation about the log entry.", "type": "object", "additionalProperties": { "type": "string" } - }, - "stringValue": { - "description": "A text string value.", - "type": "string" - }, + } + }, + "id": "LogEntry" + }, + "MetricValue": { + "description": "Represents a single metric value.", + "type": "object", + "properties": { "doubleValue": { "description": "A double precision floating point value.", "format": "double", @@ -522,8 +524,8 @@ "type": "string" }, "distributionValue": { - "$ref": "Distribution", - "description": "A distribution value." + "description": "A distribution value.", + "$ref": "Distribution" }, "boolValue": { "description": "A boolean value.", @@ -540,20 +542,25 @@ "type": "string" }, "moneyValue": { - "description": "A money value.", - "$ref": "Money" + "$ref": "Money", + "description": "A money value." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels describing the metric value.\nSee comments on google.api.servicecontrol.v1.Operation.labels for\nthe overriding relationship.", + "type": "object" + }, + "stringValue": { + "description": "A text string value.", + "type": "string" } }, - "id": "MetricValue", - "description": "Represents a single metric value.", - "type": "object" + "id": "MetricValue" }, "EndReconciliationResponse": { "properties": { - "serviceConfigId": { - "description": "ID of the actual config used to process the request.", - "type": "string" - }, "quotaMetrics": { "description": "Metric values as tracked by One Platform before the adjustment was made.\nThe following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"\n\n3. Delta value of the usage after the reconciliation for limits associated\nwith the metrics will be specified using the following metric:\n \"serviceruntime.googleapis.com/allocation/reconciliation_delta\"\nThe delta value is defined as:\n new_usage_from_client - existing_value_in_spanner.\nThis metric is not defined in serviceruntime.yaml or in Cloud Monarch.\nThis metric is meant for callers' use only. Since this metric is not\ndefined in the monitoring backend, reporting on this metric will result in\nan error.", "type": "array", @@ -571,6 +578,10 @@ "items": { "$ref": "QuotaError" } + }, + "serviceConfigId": { + "description": "ID of the actual config used to process the request.", + "type": "string" } }, "id": "EndReconciliationResponse", @@ -578,42 +589,55 @@ "type": "object" }, "Money": { + "description": "Represents an amount of money with its currency type.", + "type": "object", "properties": { + "units": { + "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", + "format": "int64", + "type": "string" + }, "currencyCode": { "description": "The 3-letter currency code defined in ISO 4217.", "type": "string" }, "nanos": { - "type": "integer", "description": "Number of nano (10^-9) units of the amount.\nThe value must be between -999,999,999 and +999,999,999 inclusive.\nIf `units` is positive, `nanos` must be positive or zero.\nIf `units` is zero, `nanos` can be positive, zero, or negative.\nIf `units` is negative, `nanos` must be negative or zero.\nFor example $-1.75 is represented as `units`=-1 and `nanos`=-750,000,000.", - "format": "int32" - }, - "units": { - "description": "The whole units of the amount.\nFor example if `currencyCode` is `\"USD\"`, then 1 unit is one US dollar.", - "format": "int64", - "type": "string" + "format": "int32", + "type": "integer" } }, - "id": "Money", - "description": "Represents an amount of money with its currency type.", - "type": "object" + "id": "Money" }, "Distribution": { - "type": "object", "properties": { + "explicitBuckets": { + "$ref": "ExplicitBuckets", + "description": "Buckets with arbitrary user-provided width." + }, + "maximum": { + "description": "The maximum of the population of values. Ignored if `count` is zero.", + "format": "double", + "type": "number" + }, + "sumOfSquaredDeviation": { + "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.", + "format": "double", + "type": "number" + }, "exponentialBuckets": { "$ref": "ExponentialBuckets", "description": "Buckets with exponentially growing width." }, - "linearBuckets": { - "description": "Buckets with constant width.", - "$ref": "LinearBuckets" - }, "minimum": { "description": "The minimum of the population of values. Ignored if `count` is zero.", "format": "double", "type": "number" }, + "linearBuckets": { + "$ref": "LinearBuckets", + "description": "Buckets with constant width." + }, "count": { "description": "The total number of samples in the distribution. Must be \u003e= 0.", "format": "int64", @@ -625,30 +649,17 @@ "type": "number" }, "bucketCounts": { + "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted.", "type": "array", "items": { "format": "int64", "type": "string" - }, - "description": "The number of samples in each histogram bucket. `bucket_counts` are\noptional. If present, they must sum to the `count` value.\n\nThe buckets are defined below in `bucket_option`. There are N buckets.\n`bucket_counts[0]` is the number of samples in the underflow bucket.\n`bucket_counts[1]` to `bucket_counts[N-1]` are the numbers of samples\nin each of the finite buckets. And `bucket_counts[N] is the number\nof samples in the overflow bucket. See the comments of `bucket_option`\nbelow for more details.\n\nAny suffix of trailing zeros may be omitted." - }, - "explicitBuckets": { - "$ref": "ExplicitBuckets", - "description": "Buckets with arbitrary user-provided width." - }, - "maximum": { - "description": "The maximum of the population of values. Ignored if `count` is zero.", - "format": "double", - "type": "number" - }, - "sumOfSquaredDeviation": { - "type": "number", - "description": "The sum of squared deviations from the mean:\n Sum[i=1..count]((x_i - mean)^2)\nwhere each x_i is a sample values. If `count` is zero then this field\nmust be zero, otherwise validation of the request fails.", - "format": "double" + } } }, "id": "Distribution", - "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points" + "description": "Distribution represents a frequency distribution of double-valued sample\npoints. It contains the size of the population of sample points plus\nadditional optional information:\n\n - the arithmetic mean of the samples\n - the minimum and maximum of the samples\n - the sum-squared-deviation of the samples, used to compute variance\n - a histogram of the values of the sample points", + "type": "object" }, "ExplicitBuckets": { "description": "Describing buckets with arbitrary user-provided width.", @@ -666,13 +677,9 @@ "id": "ExplicitBuckets" }, "ExponentialBuckets": { + "description": "Describing buckets with exponentially growing width.", "type": "object", "properties": { - "numFiniteBuckets": { - "type": "integer", - "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", - "format": "int32" - }, "growthFactor": { "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be larger than 1.0.", "format": "double", @@ -682,14 +689,16 @@ "description": "The i'th exponential bucket covers the interval\n [scale * growth_factor^(i-1), scale * growth_factor^i)\nwhere i ranges from 1 to num_finite_buckets inclusive.\nMust be \u003e 0.", "format": "double", "type": "number" + }, + "numFiniteBuckets": { + "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", + "format": "int32", + "type": "integer" } }, - "id": "ExponentialBuckets", - "description": "Describing buckets with exponentially growing width." + "id": "ExponentialBuckets" }, "AuthorizationInfo": { - "description": "Authorization information for the operation.", - "type": "object", "properties": { "resource": { "description": "The resource being accessed, as a REST-style string. For example:\n\n bigquery.googleapis.com/projects/PROJECTID/datasets/DATASETID", @@ -704,31 +713,35 @@ "type": "string" } }, - "id": "AuthorizationInfo" + "id": "AuthorizationInfo", + "description": "Authorization information for the operation.", + "type": "object" }, "ResourceInfo": { - "id": "ResourceInfo", "description": "Describes a resource associated with this operation.", "type": "object", "properties": { - "resourceName": { - "type": "string", - "description": "Name of the resource. This is used for auditing purposes." - }, "resourceContainer": { "description": "The identifier of the parent of this resource instance.\nMust be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”", "type": "string" + }, + "resourceName": { + "description": "Name of the resource. This is used for auditing purposes.", + "type": "string" } - } + }, + "id": "ResourceInfo" }, "StartReconciliationResponse": { + "description": "Response message for QuotaController.StartReconciliation.", + "type": "object", "properties": { "quotaMetrics": { + "description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"", "type": "array", "items": { "$ref": "MetricValueSet" - }, - "description": "Metric values as tracked by One Platform before the start of\nreconciliation. The following metrics will be included:\n\n1. Per quota metric total usage will be specified using the following gauge\nmetric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n2. Value for each quota limit associated with the metrics will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/quota/limit\"" + } }, "operationId": { "description": "The same operation_id value used in the StartReconciliationRequest. Used\nfor logging and diagnostics purposes.", @@ -746,15 +759,15 @@ "type": "string" } }, - "id": "StartReconciliationResponse", - "description": "Response message for QuotaController.StartReconciliation.", - "type": "object" + "id": "StartReconciliationResponse" }, "QuotaProperties": { "description": "Represents the properties needed for quota operations.", "type": "object", "properties": { "quotaMode": { + "description": "Quota mode for this operation.", + "type": "string", "enumDescriptions": [ "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation fails and returns\nerror.", "Decreases available quota by the cost specified for the operation.\nIf cost is higher than available quota, operation does not fail and\navailable quota goes down to zero but it returns error.", @@ -766,9 +779,7 @@ "ACQUIRE_BEST_EFFORT", "CHECK", "RELEASE" - ], - "description": "Quota mode for this operation.", - "type": "string" + ] } }, "id": "QuotaProperties" @@ -777,11 +788,6 @@ "description": "Describing buckets with constant width.", "type": "object", "properties": { - "offset": { - "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.", - "format": "double", - "type": "number" - }, "numFiniteBuckets": { "description": "The number of finite buckets. With the underflow and overflow buckets,\nthe total number of buckets is `num_finite_buckets` + 2.\nSee comments on `bucket_options` for details.", "format": "int32", @@ -791,6 +797,11 @@ "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.\nMust be strictly positive.", "format": "double", "type": "number" + }, + "offset": { + "description": "The i'th linear bucket covers the interval\n [offset + (i-1) * width, offset + i * width)\nwhere i ranges from 1 to num_finite_buckets, inclusive.", + "format": "double", + "type": "number" } }, "id": "LinearBuckets" @@ -808,17 +819,18 @@ "type": "string" }, "thirdPartyPrincipal": { - "description": "The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.", - "type": "object", "additionalProperties": { "description": "Properties of the object.", "type": "any" - } + }, + "description": "The third party identification (if any) of the authenticated user making\nthe request.\nWhen the JSON object represented here has a proto equivalent, the proto\nname will be indicated in the `@type` property.", + "type": "object" } }, "id": "AuthenticationInfo" }, "AllocateQuotaResponse": { + "description": "Response message for the AllocateQuota method.", "type": "object", "properties": { "quotaMetrics": { @@ -848,8 +860,7 @@ } } }, - "id": "AllocateQuotaResponse", - "description": "Response message for the AllocateQuota method." + "id": "AllocateQuotaResponse" }, "ReleaseQuotaRequest": { "description": "Request message for the ReleaseQuota method.", @@ -866,10 +877,37 @@ }, "id": "ReleaseQuotaRequest" }, + "RequestMetadata": { + "description": "Metadata about the request.", + "type": "object", + "properties": { + "callerSuppliedUserAgent": { + "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT", + "type": "string" + }, + "callerNetwork": { + "description": "The network of the caller.\nSet only if the network host project is part of the same GCP organization\n(or project) as the accessed resource.\nSee https://cloud.google.com/compute/docs/vpc/ for more information.\nThis is a scheme-less URI full resource name. For example:\n\n \"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID\"", + "type": "string" + }, + "callerIp": { + "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from a Compute Engine VM with external IP address, this\nwill be the VM's external IP address. For caller from a Compute\nEngine VM without external IP address, if the VM is in the same\norganization (or project) as the accessed resource, `caller_ip` will\nbe the VM's internal IPv4 address, otherwise the `caller_ip` will be\nredacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.", + "type": "string" + } + }, + "id": "RequestMetadata" + }, "QuotaError": { "description": "Represents error information for QuotaOperation.", "type": "object", "properties": { + "subject": { + "description": "Subject to whom this error applies. See the specific enum for more details\non this field. For example, \"clientip:\u003cip address of client\u003e\" or\n\"project:\u003cGoogle developer project id\u003e\".", + "type": "string" + }, + "description": { + "description": "Free-form text that provides details on the cause of the error.", + "type": "string" + }, "code": { "enum": [ "UNSPECIFIED", @@ -905,71 +943,30 @@ "The backend server for checking billing status is unavailable.", "The backend server for checking quota limits is unavailable." ] - }, - "subject": { - "description": "Subject to whom this error applies. See the specific enum for more details\non this field. For example, \"clientip:\u003cip address of client\u003e\" or\n\"project:\u003cGoogle developer project id\u003e\".", - "type": "string" - }, - "description": { - "description": "Free-form text that provides details on the cause of the error.", - "type": "string" } }, "id": "QuotaError" }, - "RequestMetadata": { - "description": "Metadata about the request.", - "type": "object", - "properties": { - "callerNetwork": { - "description": "The network of the caller.\nSet only if the network host project is part of the same GCP organization\n(or project) as the accessed resource.\nSee https://cloud.google.com/compute/docs/vpc/ for more information.\nThis is a scheme-less URI full resource name. For example:\n\n \"//compute.googleapis.com/projects/PROJECT_ID/global/networks/NETWORK_ID\"", - "type": "string" - }, - "callerIp": { - "description": "The IP address of the caller.\nFor caller from internet, this will be public IPv4 or IPv6 address.\nFor caller from a Compute Engine VM with external IP address, this\nwill be the VM's external IP address. For caller from a Compute\nEngine VM without external IP address, if the VM is in the same\norganization (or project) as the accessed resource, `caller_ip` will\nbe the VM's internal IPv4 address, otherwise the `caller_ip` will be\nredacted to \"gce-internal-ip\".\nSee https://cloud.google.com/compute/docs/vpc/ for more information.", - "type": "string" - }, - "callerSuppliedUserAgent": { - "description": "The user agent of the caller.\nThis information is not authenticated and should be treated accordingly.\nFor example:\n\n+ `google-api-python-client/1.4.0`:\n The request was made by the Google API client for Python.\n+ `Cloud SDK Command Line Tool apitools-client/1.0 gcloud/0.9.62`:\n The request was made by the Google Cloud SDK CLI (gcloud).\n+ `AppEngine-Google; (+http://code.google.com/appengine; appid: s~my-project`:\n The request was made from the `my-project` App Engine app.\nNOLINT", - "type": "string" - } - }, - "id": "RequestMetadata" - }, "CheckInfo": { - "description": "Contains additional information about the check operation.", - "type": "object", "properties": { - "consumerInfo": { - "description": "Consumer info of this check.", - "$ref": "ConsumerInfo" - }, "unusedArguments": { "description": "A list of fields and label keys that are ignored by the server.\nThe client doesn't need to send them for following requests to improve\nperformance and allow better aggregation.", "type": "array", "items": { "type": "string" } - } - }, - "id": "CheckInfo" - }, - "AllocateQuotaRequest": { - "properties": { - "serviceConfigId": { - "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.", - "type": "string" }, - "allocateOperation": { - "$ref": "QuotaOperation", - "description": "Operation that describes the quota allocation." + "consumerInfo": { + "$ref": "ConsumerInfo", + "description": "Consumer info of this check." } }, - "id": "AllocateQuotaRequest", - "description": "Request message for the AllocateQuota method.", + "id": "CheckInfo", + "description": "Contains additional information about the check operation.", "type": "object" }, "ReleaseQuotaResponse": { + "description": "Response message for the ReleaseQuota method.", "type": "object", "properties": { "quotaMetrics": { @@ -988,89 +985,91 @@ "type": "string" }, "releaseErrors": { + "description": "Indicates the decision of the release.", "type": "array", "items": { "$ref": "QuotaError" - }, - "description": "Indicates the decision of the release." + } } }, - "id": "ReleaseQuotaResponse", - "description": "Response message for the ReleaseQuota method." + "id": "ReleaseQuotaResponse" + }, + "AllocateQuotaRequest": { + "description": "Request message for the AllocateQuota method.", + "type": "object", + "properties": { + "serviceConfigId": { + "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.", + "type": "string" + }, + "allocateOperation": { + "description": "Operation that describes the quota allocation.", + "$ref": "QuotaOperation" + } + }, + "id": "AllocateQuotaRequest" }, "MetricValueSet": { - "id": "MetricValueSet", "description": "Represents a set of metric values in the same metric.\nEach metric value in the set should have a unique combination of start time,\nend time, and label values.", "type": "object", "properties": { + "metricName": { + "description": "The metric name defined in the service configuration.", + "type": "string" + }, "metricValues": { "description": "The values in this metric.", "type": "array", "items": { "$ref": "MetricValue" } - }, - "metricName": { - "description": "The metric name defined in the service configuration.", - "type": "string" } - } + }, + "id": "MetricValueSet" }, "ReportError": { "description": "Represents the processing error of one Operation in the request.", "type": "object", "properties": { - "status": { - "$ref": "Status", - "description": "Details of the error when processing the Operation." - }, "operationId": { "description": "The Operation.operation_id value from the request.", "type": "string" + }, + "status": { + "$ref": "Status", + "description": "Details of the error when processing the Operation." } }, "id": "ReportError" }, + "StartReconciliationRequest": { + "description": "Request message for QuotaController.StartReconciliation.", + "type": "object", + "properties": { + "reconciliationOperation": { + "description": "Operation that describes the quota reconciliation.", + "$ref": "QuotaOperation" + }, + "serviceConfigId": { + "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.", + "type": "string" + } + }, + "id": "StartReconciliationRequest" + }, "CheckError": { - "id": "CheckError", "description": "Defines the errors to be returned in\ngoogle.api.servicecontrol.v1.CheckResponse.check_errors.", "type": "object", "properties": { + "detail": { + "description": "Free-form text providing details on the error cause of the error.", + "type": "string" + }, + "subject": { + "description": "Subject to whom this error applies. See the specific code enum for more\ndetails on this field. For example:\n - “project:\u003cproject-id or project-number\u003e”\n - “folder:\u003cfolder-id\u003e”\n - “organization:\u003corganization-id\u003e”", + "type": "string" + }, "code": { - "enumDescriptions": [ - "This is never used in `CheckResponse`.", - "The consumer's project id, network container, or resource container was\nnot found. Same as google.rpc.Code.NOT_FOUND.", - "The consumer doesn't have access to the specified resource.\nSame as google.rpc.Code.PERMISSION_DENIED.", - "Quota check failed. Same as google.rpc.Code.RESOURCE_EXHAUSTED.", - "Budget check failed.", - "The consumer's request has been flagged as a DoS attack.", - "The consumer's request should be rejected in order to protect the service\nfrom being overloaded.", - "The consumer has been flagged as an abuser.", - "The consumer hasn't activated the service.", - "The consumer cannot access the service due to visibility configuration.", - "The consumer cannot access the service because billing is disabled.", - "The consumer's project has been marked as deleted (soft deletion).", - "The consumer's project number or id does not represent a valid project.", - "The IP address of the consumer is invalid for the specific consumer\nproject.", - "The referer address of the consumer request is invalid for the specific\nconsumer project.", - "The client application of the consumer request is invalid for the\nspecific consumer project.", - "The API targeted by this request is invalid for the specified consumer\nproject.", - "The consumer's API key is invalid.", - "The consumer's API Key has expired.", - "The consumer's API Key was not found in config record.", - "The consumer's spatula header is invalid.", - "The consumer's LOAS role is invalid.", - "The consumer's LOAS role has no associated project.", - "The consumer's LOAS project is not `ACTIVE` in LoquatV2.", - "Request is not allowed as per security policies defined in Org Policy.", - "The backend server for looking up project id/number is unavailable.", - "The backend server for checking service status is unavailable.", - "The backend server for checking billing status is unavailable.", - "The backend server for checking quota limits is unavailable.", - "The Spanner for looking up LOAS project is unavailable.", - "Cloud Resource Manager backend server is unavailable.", - "Backend server for evaluating security policy is unavailable." - ], "enum": [ "ERROR_CODE_UNSPECIFIED", "NOT_FOUND", @@ -1106,42 +1105,63 @@ "SECURITY_POLICY_BACKEND_UNAVAILABLE" ], "description": "The error code.", - "type": "string" - }, - "detail": { "type": "string", - "description": "Free-form text providing details on the error cause of the error." - }, - "subject": { - "description": "Subject to whom this error applies. See the specific code enum for more\ndetails on this field. For example:\n - “project:\u003cproject-id or project-number\u003e”\n - “folder:\u003cfolder-id\u003e”\n - “organization:\u003corganization-id\u003e”", - "type": "string" - } - } - }, - "StartReconciliationRequest": { - "description": "Request message for QuotaController.StartReconciliation.", - "type": "object", - "properties": { - "serviceConfigId": { - "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.", - "type": "string" - }, - "reconciliationOperation": { - "description": "Operation that describes the quota reconciliation.", - "$ref": "QuotaOperation" + "enumDescriptions": [ + "This is never used in `CheckResponse`.", + "The consumer's project id, network container, or resource container was\nnot found. Same as google.rpc.Code.NOT_FOUND.", + "The consumer doesn't have access to the specified resource.\nSame as google.rpc.Code.PERMISSION_DENIED.", + "Quota check failed. Same as google.rpc.Code.RESOURCE_EXHAUSTED.", + "Budget check failed.", + "The consumer's request has been flagged as a DoS attack.", + "The consumer's request should be rejected in order to protect the service\nfrom being overloaded.", + "The consumer has been flagged as an abuser.", + "The consumer hasn't activated the service.", + "The consumer cannot access the service due to visibility configuration.", + "The consumer cannot access the service because billing is disabled.", + "The consumer's project has been marked as deleted (soft deletion).", + "The consumer's project number or id does not represent a valid project.", + "The IP address of the consumer is invalid for the specific consumer\nproject.", + "The referer address of the consumer request is invalid for the specific\nconsumer project.", + "The client application of the consumer request is invalid for the\nspecific consumer project.", + "The API targeted by this request is invalid for the specified consumer\nproject.", + "The consumer's API key is invalid.", + "The consumer's API Key has expired.", + "The consumer's API Key was not found in config record.", + "The consumer's spatula header is invalid.", + "The consumer's LOAS role is invalid.", + "The consumer's LOAS role has no associated project.", + "The consumer's LOAS project is not `ACTIVE` in LoquatV2.", + "Request is not allowed as per security policies defined in Org Policy.", + "The backend server for looking up project id/number is unavailable.", + "The backend server for checking service status is unavailable.", + "The backend server for checking billing status is unavailable.", + "The backend server for checking quota limits is unavailable.", + "The Spanner for looking up LOAS project is unavailable.", + "Cloud Resource Manager backend server is unavailable.", + "Backend server for evaluating security policy is unavailable." + ] } }, - "id": "StartReconciliationRequest" + "id": "CheckError" }, "QuotaInfo": { + "description": "Contains the quota information for a quota check response.", + "type": "object", "properties": { + "limitExceeded": { + "description": "Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.", + "type": "array", + "items": { + "type": "string" + } + }, "quotaConsumed": { - "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n", - "type": "object", "additionalProperties": { "format": "int32", "type": "integer" - } + }, + "description": "Map of quota group name to the actual number of tokens consumed. If the\nquota check was not successful, then this will not be populated due to no\nquota consumption.\n\nWe are not merging this field with 'quota_metrics' field because of the\ncomplexity of scaling in Chemist client code base. For simplicity, we will\nkeep this field for Castor (that scales quota usage) and 'quota_metrics'\nfor SuperQuota (that doesn't scale quota usage).\n", + "type": "object" }, "quotaMetrics": { "description": "Quota metrics to indicate the usage. Depending on the check request, one or\nmore of the following metrics will be included:\n\n1. For rate quota, per quota group or per quota metric incremental usage\nwill be specified using the following delta metric:\n \"serviceruntime.googleapis.com/api/consumer/quota_used_count\"\n\n2. For allocation quota, per quota metric total usage will be specified\nusing the following gauge metric:\n \"serviceruntime.googleapis.com/allocation/consumer/quota_used_count\"\n\n3. For both rate quota and allocation quota, the quota limit reached\ncondition will be specified using the following boolean metric:\n \"serviceruntime.googleapis.com/quota/exceeded\"", @@ -1149,18 +1169,9 @@ "items": { "$ref": "MetricValueSet" } - }, - "limitExceeded": { - "description": "Quota Metrics that have exceeded quota limits.\nFor QuotaGroup-based quota, this is QuotaGroup.name\nFor QuotaLimit-based quota, this is QuotaLimit.name\nSee: google.api.Quota\nDeprecated: Use quota_metrics to get per quota group limit exceeded status.", - "type": "array", - "items": { - "type": "string" - } } }, - "id": "QuotaInfo", - "description": "Contains the quota information for a quota check response.", - "type": "object" + "id": "QuotaInfo" }, "ConsumerInfo": { "description": "`ConsumerInfo` provides information about the consumer project.", @@ -1175,6 +1186,8 @@ "id": "ConsumerInfo" }, "CheckRequest": { + "description": "Request message for the Check method.", + "type": "object", "properties": { "serviceConfigId": { "description": "Specifies which version of service configuration should be used to process\nthe request.\n\nIf unspecified or no matching version can be found, the\nlatest one will be used.", @@ -1193,41 +1206,10 @@ "type": "boolean" } }, - "id": "CheckRequest", - "description": "Request message for the Check method.", - "type": "object" + "id": "CheckRequest" }, "QuotaOperation": { - "description": "Represents information regarding a quota operation.", - "type": "object", "properties": { - "quotaMode": { - "type": "string", - "enumDescriptions": [ - "Guard against implicit default. Must not be used.", - "For AllocateQuota request, allocates quota for the amount specified in\nthe service configuration or specified using the quota metrics. If the\namount is higher than the available quota, allocation error will be\nreturned and no quota will be allocated.", - "The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the amount is\nhigher than the available quota, request does not fail but all available\nquota will be allocated.", - "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either." - ], - "enum": [ - "UNSPECIFIED", - "NORMAL", - "BEST_EFFORT", - "CHECK_ONLY" - ], - "description": "Quota mode for this operation." - }, - "methodName": { - "description": "Fully qualified name of the API method for which this quota operation is\nrequested. This name is used for matching quota rules or metric rules and\nbilling status rules defined in service configuration.\n\nThis field should not be set if any of the following is true:\n(1) the quota operation is performed on non-API resources.\n(2) quota_metrics is set because the caller is doing quota override.\n\nExample of an RPC method name:\n google.example.library.v1.LibraryService.CreateShelf", - "type": "string" - }, - "quotaMetrics": { - "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.\n\nThis field is mutually exclusive with method_name.", - "type": "array", - "items": { - "$ref": "MetricValueSet" - } - }, "labels": { "additionalProperties": { "type": "string" @@ -1242,21 +1224,50 @@ "operationId": { "description": "Identity of the operation. This is expected to be unique within the scope\nof the service that generated the operation, and guarantees idempotency in\ncase of retries.\n\nUUID version 4 is recommended, though not required. In scenarios where an\noperation is computed from existing information and an idempotent id is\ndesirable for deduplication purpose, UUID version 5 is recommended. See\nRFC 4122 for details.", "type": "string" + }, + "quotaMode": { + "enumDescriptions": [ + "Guard against implicit default. Must not be used.", + "For AllocateQuota request, allocates quota for the amount specified in\nthe service configuration or specified using the quota metrics. If the\namount is higher than the available quota, allocation error will be\nreturned and no quota will be allocated.", + "The operation allocates quota for the amount specified in the service\nconfiguration or specified using the quota metrics. If the amount is\nhigher than the available quota, request does not fail but all available\nquota will be allocated.", + "For AllocateQuota request, only checks if there is enough quota\navailable and does not change the available quota. No lock is placed on\nthe available quota either." + ], + "enum": [ + "UNSPECIFIED", + "NORMAL", + "BEST_EFFORT", + "CHECK_ONLY" + ], + "description": "Quota mode for this operation.", + "type": "string" + }, + "methodName": { + "description": "Fully qualified name of the API method for which this quota operation is\nrequested. This name is used for matching quota rules or metric rules and\nbilling status rules defined in service configuration.\n\nThis field should not be set if any of the following is true:\n(1) the quota operation is performed on non-API resources.\n(2) quota_metrics is set because the caller is doing quota override.\n\nExample of an RPC method name:\n google.example.library.v1.LibraryService.CreateShelf", + "type": "string" + }, + "quotaMetrics": { + "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.\n\nThis field is mutually exclusive with method_name.", + "type": "array", + "items": { + "$ref": "MetricValueSet" + } } }, - "id": "QuotaOperation" + "id": "QuotaOperation", + "description": "Represents information regarding a quota operation.", + "type": "object" }, "EndReconciliationRequest": { "description": "Request message for QuotaController.EndReconciliation.", "type": "object", "properties": { + "reconciliationOperation": { + "description": "Operation that describes the quota reconciliation.", + "$ref": "QuotaOperation" + }, "serviceConfigId": { "description": "Specifies which version of service configuration should be used to process\nthe request. If unspecified or no matching version can be found, the latest\none will be used.", "type": "string" - }, - "reconciliationOperation": { - "$ref": "QuotaOperation", - "description": "Operation that describes the quota reconciliation." } }, "id": "EndReconciliationRequest" @@ -1277,45 +1288,38 @@ "id": "ReportInfo" }, "Operation": { + "description": "Represents information regarding an operation.", + "type": "object", "properties": { - "endTime": { - "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.", - "format": "google-datetime", - "type": "string" - }, - "operationName": { - "description": "Fully qualified name of the operation. Reserved for future use.", - "type": "string" - }, "startTime": { "description": "Required. Start time of the operation.", "format": "google-datetime", "type": "string" }, "importance": { + "enumDescriptions": [ + "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.", + "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.", + "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level." + ], "enum": [ "LOW", "HIGH", "DEBUG" ], "description": "DO NOT USE. This is an experimental field.", - "type": "string", - "enumDescriptions": [ - "The API implementation may cache and aggregate the data.\nThe data may be lost when rare and unexpected system failures occur.", - "The API implementation doesn't cache and aggregate the data.\nIf the method returns successfully, it's guaranteed that the data has\nbeen persisted in durable storage.", - "In addition to the behavior described in HIGH, DEBUG enables\nadditional validation logic that is only useful during the onboarding\nprocess. This is only available to Google internal services and\nthe service must be whitelisted by chemist-dev@google.com in order\nto use this level." - ] + "type": "string" }, "resourceContainer": { "description": "DO NOT USE. This field is deprecated, use \"resources\" field instead.\nThe resource name of the parent of a resource in the resource hierarchy.\n\nThis can be in one of the following formats:\n - “projects/\u003cproject-id or project-number\u003e”\n - “folders/\u003cfolder-id\u003e”\n - “organizations/\u003corganization-id\u003e”", "type": "string" }, "labels": { - "type": "object", "additionalProperties": { "type": "string" }, - "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE)." + "description": "Labels describing the operation. Only the following labels are allowed:\n\n- Labels describing monitored resources as defined in\n the service configuration.\n- Default labels of metric values. When specified, labels defined in the\n metric value override these default.\n- The following labels defined by Google Cloud Platform:\n - `cloud.googleapis.com/location` describing the location where the\n operation happened,\n - `servicecontrol.googleapis.com/user_agent` describing the user agent\n of the API request,\n - `servicecontrol.googleapis.com/service_agent` describing the service\n used to handle the API request (e.g. ESP),\n - `servicecontrol.googleapis.com/platform` describing the platform\n where the API is served (e.g. GAE, GCE, GKE).", + "type": "object" }, "resources": { "description": "The resources that are involved in the operation.", @@ -1332,11 +1336,11 @@ } }, "userLabels": { - "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.", - "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "User defined labels for the resource that this operation is associated\nwith. Only a combination of 1000 user labels per consumer project are\nallowed.", + "type": "object" }, "metricValueSets": { "description": "Represents information about this operation. Each MetricValueSet\ncorresponds to a metric defined in the service configuration.\nThe data type used in the MetricValueSet must agree with\nthe data type specified in the metric definition.\n\nWithin a single operation, it is not allowed to have more than one\nMetricValue instances that have the same metric names and identical\nlabel value combinations. If a request has such duplicated MetricValue\ninstances, the entire request is rejected with\nan invalid argument error.", @@ -1346,8 +1350,8 @@ } }, "quotaProperties": { - "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed.", - "$ref": "QuotaProperties" + "$ref": "QuotaProperties", + "description": "Represents the properties needed for quota check. Applicable only if this\noperation is for a quota check request. If this is not specified, no quota\ncheck will be performed." }, "consumerId": { "description": "Identity of the consumer who is using the service.\nThis field should be filled in for the operations initiated by a\nconsumer, but not for service-initiated operations that are\nnot related to a specific consumer.\n\nThis can be in one of the following formats:\n project:\u003cproject_id\u003e,\n project_number:\u003cproject_number\u003e,\n api_key:\u003capi_key\u003e.", @@ -1356,15 +1360,20 @@ "operationId": { "description": "Identity of the operation. This must be unique within the scope of the\nservice that generated the operation. If the service calls\nCheck() and Report() on the same operation, the two calls should carry\nthe same id.\n\nUUID version 4 is recommended, though not required.\nIn scenarios where an operation is computed from existing information\nand an idempotent id is desirable for deduplication purpose, UUID version 5\nis recommended. See RFC 4122 for details.", "type": "string" + }, + "endTime": { + "description": "End time of the operation.\nRequired when the operation is used in ServiceController.Report,\nbut optional when the operation is used in ServiceController.Check.", + "format": "google-datetime", + "type": "string" + }, + "operationName": { + "description": "Fully qualified name of the operation. Reserved for future use.", + "type": "string" } }, - "id": "Operation", - "description": "Represents information regarding an operation.", - "type": "object" + "id": "Operation" }, "ReportResponse": { - "description": "Response message for the Report method.", - "type": "object", "properties": { "reportErrors": { "description": "Partial failures, one for each `Operation` in the request that failed\nprocessing. There are three possible combinations of the RPC status:\n\n1. The combination of a successful RPC status and an empty `report_errors`\n list indicates a complete success where all `Operations` in the\n request are processed successfully.\n2. The combination of a successful RPC status and a non-empty\n `report_errors` list indicates a partial success where some\n `Operations` in the request succeeded. Each\n `Operation` that failed processing has a corresponding item\n in this list.\n3. A failed RPC status indicates a general non-deterministic failure.\n When this happens, it's impossible to know which of the\n 'Operations' in the request succeeded or failed.", @@ -1385,36 +1394,8 @@ "type": "string" } }, - "id": "ReportResponse" - }, - "CheckResponse": { - "properties": { - "operationId": { - "description": "The same operation_id value used in the CheckRequest.\nUsed for logging and diagnostics purposes.", - "type": "string" - }, - "checkErrors": { - "description": "Indicate the decision of the check.\n\nIf no check errors are present, the service should process the operation.\nOtherwise the service should use the list of errors to determine the\nappropriate action.", - "type": "array", - "items": { - "$ref": "CheckError" - } - }, - "checkInfo": { - "$ref": "CheckInfo", - "description": "Feedback data returned from the server during processing a Check request." - }, - "quotaInfo": { - "$ref": "QuotaInfo", - "description": "Quota information for the check request associated with this response.\n" - }, - "serviceConfigId": { - "description": "The actual config id used to process the request.", - "type": "string" - } - }, - "id": "CheckResponse", - "description": "Response message for the Check method.", + "id": "ReportResponse", + "description": "Response message for the Report method.", "type": "object" } }, @@ -1423,5 +1404,24 @@ "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "canonicalName": "Service Control" + "canonicalName": "Service Control", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/servicecontrol": { + "description": "Manage your Google Service Control data" + } + } + } + }, + "rootUrl": "https://servicecontrol.googleapis.com/", + "ownerDomain": "google.com", + "name": "servicecontrol", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Service Control API", + "ownerName": "Google" }
diff --git a/servicemanagement/v1/servicemanagement-api.json b/servicemanagement/v1/servicemanagement-api.json index df2aaf4..51dc359 100644 --- a/servicemanagement/v1/servicemanagement-api.json +++ b/servicemanagement/v1/servicemanagement-api.json
@@ -1,18 +1,2053 @@ { + "ownerName": "Google", + "resources": { + "services": { + "methods": { + "list": { + "response": { + "$ref": "ListServicesResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "parameters": { + "consumerId": { + "location": "query", + "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e", + "type": "string" + }, + "pageToken": { + "description": "Token identifying which result to start with; returned by a previous list\ncall.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Requested size of the next page of data.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "producerProjectId": { + "location": "query", + "description": "Include services produced by the specified project.", + "type": "string" + } + }, + "flatPath": "v1/services", + "path": "v1/services", + "id": "servicemanagement.services.list", + "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\"." + }, + "create": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": {}, + "flatPath": "v1/services", + "path": "v1/services", + "id": "servicemanagement.services.create", + "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e", + "request": { + "$ref": "ManagedService" + } + }, + "generateConfigReport": { + "response": { + "$ref": "GenerateConfigReportResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": {}, + "flatPath": "v1/services:generateConfigReport", + "path": "v1/services:generateConfigReport", + "id": "servicemanagement.services.generateConfigReport", + "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.", + "request": { + "$ref": "GenerateConfigReportRequest" + } + }, + "get": { + "path": "v1/services/{serviceName}", + "id": "servicemanagement.services.get", + "description": "Gets a managed service. Authentication is required unless the service is\npublic.", + "response": { + "$ref": "ManagedService" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "GET", + "parameters": { + "serviceName": { + "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "flatPath": "v1/services/{serviceName}" + }, + "testIamPermissions": { + "flatPath": "v1/services/{servicesId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "servicemanagement.services.testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^services/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ] + }, + "getConfig": { + "response": { + "$ref": "Service" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "GET", + "parameters": { + "serviceName": { + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string", + "location": "path" + }, + "configId": { + "description": "The id of the service configuration resource.", + "type": "string", + "location": "query" + }, + "view": { + "enum": [ + "BASIC", + "FULL" + ], + "description": "Specifies which parts of the Service Config should be returned in the\nresponse.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "flatPath": "v1/services/{serviceName}/config", + "path": "v1/services/{serviceName}/config", + "id": "servicemanagement.services.getConfig", + "description": "Gets a service configuration (version) for a managed service." + }, + "enable": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST", + "parameters": { + "serviceName": { + "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/services/{serviceName}:enable", + "path": "v1/services/{serviceName}:enable", + "id": "servicemanagement.services.enable", + "request": { + "$ref": "EnableServiceRequest" + }, + "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e" + }, + "delete": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "serviceName": { + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "flatPath": "v1/services/{serviceName}", + "path": "v1/services/{serviceName}", + "id": "servicemanagement.services.delete", + "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "DELETE" + }, + "setIamPolicy": { + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^services/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/services/{servicesId}:setIamPolicy", + "id": "servicemanagement.services.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy" + }, + "disable": { + "httpMethod": "POST", + "parameterOrder": [ + "serviceName" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "serviceName": { + "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/services/{serviceName}:disable", + "id": "servicemanagement.services.disable", + "path": "v1/services/{serviceName}:disable", + "request": { + "$ref": "DisableServiceRequest" + }, + "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e" + }, + "getIamPolicy": { + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "pattern": "^services/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "flatPath": "v1/services/{servicesId}:getIamPolicy", + "id": "servicemanagement.services.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy" + }, + "undelete": { + "httpMethod": "POST", + "parameterOrder": [ + "serviceName" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "serviceName": { + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/services/{serviceName}:undelete", + "id": "servicemanagement.services.undelete", + "path": "v1/services/{serviceName}:undelete", + "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e" + } + }, + "resources": { + "consumers": { + "methods": { + "getIamPolicy": { + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string", + "pattern": "^services/[^/]+/consumers/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy", + "id": "servicemanagement.services.consumers.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy" + }, + "setIamPolicy": { + "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "resource": { + "pattern": "^services/[^/]+/consumers/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "id": "servicemanagement.services.consumers.setIamPolicy" + }, + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "parameters": { + "resource": { + "pattern": "^services/[^/]+/consumers/[^/]+$", + "location": "path", + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "servicemanagement.services.consumers.testIamPermissions", + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning." + } + } + }, + "rollouts": { + "methods": { + "list": { + "response": { + "$ref": "ListServiceRolloutsResponse" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "parameters": { + "filter": { + "location": "query", + "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'", + "type": "string" + }, + "serviceName": { + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string" + }, + "pageToken": { + "type": "string", + "location": "query", + "description": "The token of the page to retrieve." + }, + "pageSize": { + "location": "query", + "description": "The max number of items to include in the response list.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1/services/{serviceName}/rollouts", + "path": "v1/services/{serviceName}/rollouts", + "id": "servicemanagement.services.rollouts.list", + "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest." + }, + "get": { + "path": "v1/services/{serviceName}/rollouts/{rolloutId}", + "id": "servicemanagement.services.rollouts.get", + "description": "Gets a service configuration rollout.", + "response": { + "$ref": "Rollout" + }, + "parameterOrder": [ + "serviceName", + "rolloutId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "parameters": { + "serviceName": { + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string" + }, + "rolloutId": { + "required": true, + "type": "string", + "location": "path", + "description": "The id of the rollout resource." + } + }, + "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}" + }, + "create": { + "flatPath": "v1/services/{serviceName}/rollouts", + "path": "v1/services/{serviceName}/rollouts", + "id": "servicemanagement.services.rollouts.create", + "request": { + "$ref": "Rollout" + }, + "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST", + "parameters": { + "serviceName": { + "required": true, + "type": "string", + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ] + } + } + }, + "configs": { + "methods": { + "list": { + "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.", + "response": { + "$ref": "ListServiceConfigsResponse" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "parameters": { + "serviceName": { + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The token of the page to retrieve.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The max number of items to include in the response list.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1/services/{serviceName}/configs", + "path": "v1/services/{serviceName}/configs", + "id": "servicemanagement.services.configs.list" + }, + "get": { + "response": { + "$ref": "Service" + }, + "parameterOrder": [ + "serviceName", + "configId" + ], + "httpMethod": "GET", + "parameters": { + "serviceName": { + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string" + }, + "configId": { + "description": "The id of the service configuration resource.", + "required": true, + "type": "string", + "location": "path" + }, + "view": { + "location": "query", + "enum": [ + "BASIC", + "FULL" + ], + "description": "Specifies which parts of the Service Config should be returned in the\nresponse.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only", + "https://www.googleapis.com/auth/service.management", + "https://www.googleapis.com/auth/service.management.readonly" + ], + "flatPath": "v1/services/{serviceName}/configs/{configId}", + "path": "v1/services/{serviceName}/configs/{configId}", + "id": "servicemanagement.services.configs.get", + "description": "Gets a service configuration (version) for a managed service." + }, + "create": { + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "serviceName": { + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/services/{serviceName}/configs", + "path": "v1/services/{serviceName}/configs", + "id": "servicemanagement.services.configs.create", + "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.", + "request": { + "$ref": "Service" + }, + "response": { + "$ref": "Service" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST" + }, + "submit": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "serviceName" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "serviceName": { + "location": "path", + "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/services/{serviceName}/configs:submit", + "path": "v1/services/{serviceName}/configs:submit", + "id": "servicemanagement.services.configs.submit", + "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e", + "request": { + "$ref": "SubmitConfigSourceRequest" + } + } + } + } + } + }, + "operations": { + "methods": { + "list": { + "httpMethod": "GET", + "parameterOrder": [], + "response": { + "$ref": "ListOperationsResponse" + }, + "parameters": { + "filter": { + "type": "string", + "location": "query", + "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`" + }, + "name": { + "location": "query", + "description": "Not used.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/operations", + "id": "servicemanagement.operations.list", + "path": "v1/operations", + "description": "Lists service operations that match the specified filter in the request." + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^operations/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/operations/{operationsId}", + "id": "servicemanagement.operations.get", + "path": "v1/{+name}", + "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." + } + } + } + }, + "parameters": { + "upload_protocol": { + "type": "string", + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "type": "string", + "location": "query", + "description": "JSONP" + }, + "$.xgafv": { + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format." + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "type": "string", + "location": "query", + "description": "OAuth access token." + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + } + }, + "version": "v1", + "baseUrl": "https://servicemanagement.googleapis.com/", + "servicePath": "", + "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.", + "kind": "discovery#restDescription", + "basePath": "", "revision": "20171229", "documentationLink": "https://cloud.google.com/service-management/", "id": "servicemanagement:v1", "discoveryVersion": "v1", "schemas": { + "Status": { + "id": "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.", + "type": "object", + "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 is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "type": "any", + "description": "Properties of the object. Contains field @type with type URL." + } + } + }, + "code": { + "type": "integer", + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32" + } + } + }, + "Binding": { + "id": "Binding", + "description": "Associates `members` with a `role`.", + "type": "object", + "properties": { + "role": { + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" + }, + "condition": { + "$ref": "Expr", + "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL." + }, + "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AuthProvider": { + "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", + "type": "object", + "properties": { + "jwksUri": { + "type": "string", + "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs" + }, + "audiences": { + "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", + "type": "string" + }, + "id": { + "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".", + "type": "string" + }, + "issuer": { + "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com", + "type": "string" + }, + "authorizationUrl": { + "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.", + "type": "string" + } + }, + "id": "AuthProvider" + }, + "Service": { + "type": "object", + "properties": { + "http": { + "description": "HTTP configuration.", + "$ref": "Http" + }, + "backend": { + "$ref": "Backend", + "description": "API backend configuration." + }, + "systemParameters": { + "$ref": "SystemParameters", + "description": "System parameter configuration." + }, + "documentation": { + "$ref": "Documentation", + "description": "Additional API documentation." + }, + "monitoredResources": { + "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", + "type": "array", + "items": { + "$ref": "MonitoredResourceDescriptor" + } + }, + "logging": { + "description": "Logging configuration.", + "$ref": "Logging" + }, + "enums": { + "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum", + "type": "array", + "items": { + "$ref": "Enum" + } + }, + "context": { + "description": "Context configuration.", + "$ref": "Context" + }, + "id": { + "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", + "type": "string" + }, + "usage": { + "$ref": "Usage", + "description": "Configuration controlling usage of this service." + }, + "metrics": { + "type": "array", + "items": { + "$ref": "MetricDescriptor" + }, + "description": "Defines the metrics used by this service." + }, + "authentication": { + "$ref": "Authentication", + "description": "Auth configuration." + }, + "experimental": { + "$ref": "Experimental", + "description": "Experimental configuration." + }, + "control": { + "$ref": "Control", + "description": "Configuration for the service control plane." + }, + "configVersion": { + "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.", + "format": "uint32", + "type": "integer" + }, + "monitoring": { + "$ref": "Monitoring", + "description": "Monitoring configuration." + }, + "systemTypes": { + "type": "array", + "items": { + "$ref": "Type" + }, + "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF." + }, + "producerProjectId": { + "description": "The Google project that owns this service.", + "type": "string" + }, + "visibility": { + "$ref": "Visibility", + "description": "API visibility configuration." + }, + "quota": { + "description": "Quota configuration.", + "$ref": "Quota" + }, + "name": { + "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", + "type": "string" + }, + "billing": { + "description": "Billing configuration.", + "$ref": "Billing" + }, + "customError": { + "description": "Custom error configuration.", + "$ref": "CustomError" + }, + "title": { + "description": "The product title for this service.", + "type": "string" + }, + "endpoints": { + "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.", + "type": "array", + "items": { + "$ref": "Endpoint" + } + }, + "apis": { + "type": "array", + "items": { + "$ref": "Api" + }, + "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files." + }, + "logs": { + "description": "Defines the logs used by this service.", + "type": "array", + "items": { + "$ref": "LogDescriptor" + } + }, + "types": { + "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32", + "type": "array", + "items": { + "$ref": "Type" + } + }, + "sourceInfo": { + "$ref": "SourceInfo", + "description": "Output only. The source information for this configuration if available." + } + }, + "id": "Service", + "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth" + }, + "EnumValue": { + "type": "object", + "properties": { + "number": { + "description": "Enum value number.", + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string", + "description": "Enum value name." + }, + "options": { + "type": "array", + "items": { + "$ref": "Option" + }, + "description": "Protocol buffer options." + } + }, + "id": "EnumValue", + "description": "Enum value definition." + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "The standard List next-page token.", + "type": "string" + }, + "operations": { + "type": "array", + "items": { + "$ref": "Operation" + }, + "description": "A list of operations that matches the specified filter in the request." + } + }, + "id": "ListOperationsResponse" + }, + "CustomHttpPattern": { + "description": "A custom pattern is used for defining custom HTTP verb.", + "type": "object", + "properties": { + "path": { + "description": "The path matched by this custom verb.", + "type": "string" + }, + "kind": { + "type": "string", + "description": "The name of this custom HTTP verb." + } + }, + "id": "CustomHttpPattern" + }, + "OperationMetadata": { + "description": "The metadata associated with a long running operation resource.", + "type": "object", + "properties": { + "startTime": { + "description": "The start time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "resourceNames": { + "description": "The full name of the resources that this operation is directly\nassociated with.", + "type": "array", + "items": { + "type": "string" + } + }, + "steps": { + "description": "Detailed status information for each step. The order is undetermined.", + "type": "array", + "items": { + "$ref": "Step" + } + }, + "progressPercentage": { + "description": "Percentage of completion of this operation, ranging from 0 to 100.", + "format": "int32", + "type": "integer" + } + }, + "id": "OperationMetadata" + }, + "SystemParameterRule": { + "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.", + "type": "object", + "properties": { + "selector": { + "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "parameters": { + "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.", + "type": "array", + "items": { + "$ref": "SystemParameter" + } + } + }, + "id": "SystemParameterRule" + }, + "VisibilityRule": { + "description": "A visibility rule provides visibility configuration for an individual API\nelement.", + "type": "object", + "properties": { + "restriction": { + "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", + "type": "string" + }, + "selector": { + "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + } + }, + "id": "VisibilityRule" + }, + "HttpRule": { + "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.", + "type": "object", + "properties": { + "mediaUpload": { + "$ref": "MediaUpload", + "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods." + }, + "selector": { + "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "custom": { + "$ref": "CustomHttpPattern", + "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients." + }, + "get": { + "type": "string", + "description": "Used for listing and getting information about resources." + }, + "patch": { + "description": "Used for updating a resource.", + "type": "string" + }, + "put": { + "description": "Used for updating a resource.", + "type": "string" + }, + "delete": { + "type": "string", + "description": "Used for deleting a resource." + }, + "body": { + "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", + "type": "string" + }, + "mediaDownload": { + "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.", + "$ref": "MediaDownload" + }, + "post": { + "description": "Used for creating a resource.", + "type": "string" + }, + "additionalBindings": { + "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", + "type": "array", + "items": { + "$ref": "HttpRule" + } + }, + "responseBody": { + "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.", + "type": "string" + } + }, + "id": "HttpRule" + }, + "MonitoringDestination": { + "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).", + "type": "object", + "properties": { + "monitoredResource": { + "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", + "type": "string" + }, + "metrics": { + "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "MonitoringDestination" + }, + "Visibility": { + "type": "object", + "properties": { + "rules": { + "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "VisibilityRule" + } + } + }, + "id": "Visibility", + "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate." + }, + "ConfigChange": { + "type": "object", + "properties": { + "newValue": { + "type": "string", + "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED." + }, + "changeType": { + "enum": [ + "CHANGE_TYPE_UNSPECIFIED", + "ADDED", + "REMOVED", + "MODIFIED" + ], + "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.", + "type": "string", + "enumDescriptions": [ + "No value was provided.", + "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.", + "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.", + "The changed object exists in both service configurations, but its value\nis different." + ] + }, + "element": { + "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]", + "type": "string" + }, + "oldValue": { + "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.", + "type": "string" + }, + "advices": { + "type": "array", + "items": { + "$ref": "Advice" + }, + "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change." + } + }, + "id": "ConfigChange", + "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility." + }, + "SystemParameters": { + "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.", + "type": "object", + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "SystemParameterRule" + }, + "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order." + } + }, + "id": "SystemParameters" + }, + "Rollout": { + "description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config.", + "type": "object", + "properties": { + "rolloutId": { + "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'", + "type": "string" + }, + "deleteServiceStrategy": { + "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly.", + "$ref": "DeleteServiceStrategy" + }, + "createTime": { + "type": "string", + "description": "Creation time of the rollout. Readonly.", + "format": "google-datetime" + }, + "status": { + "enumDescriptions": [ + "No status specified.", + "The Rollout is in progress.", + "The Rollout has completed successfully.", + "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.", + "The Rollout has failed and the rollback attempt has failed too.", + "The Rollout has not started yet and is pending for execution.", + "The Rollout has failed and rolled back to the previous successful\nRollout." + ], + "enum": [ + "ROLLOUT_STATUS_UNSPECIFIED", + "IN_PROGRESS", + "SUCCESS", + "CANCELLED", + "FAILED", + "PENDING", + "FAILED_ROLLED_BACK" + ], + "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.", + "type": "string" + }, + "serviceName": { + "description": "The name of the service associated with this Rollout.", + "type": "string" + }, + "createdBy": { + "description": "The user who created the Rollout. Readonly.", + "type": "string" + }, + "trafficPercentStrategy": { + "$ref": "TrafficPercentStrategy", + "description": "Google Service Control selects service configurations based on\ntraffic percentage." + } + }, + "id": "Rollout" + }, + "Quota": { + "properties": { + "limits": { + "description": "List of `QuotaLimit` definitions for the service.", + "type": "array", + "items": { + "$ref": "QuotaLimit" + } + }, + "metricRules": { + "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.", + "type": "array", + "items": { + "$ref": "MetricRule" + } + } + }, + "id": "Quota", + "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", + "type": "object" + }, + "GenerateConfigReportRequest": { + "type": "object", + "properties": { + "oldConfig": { + "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "newConfig": { + "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "id": "GenerateConfigReportRequest", + "description": "Request message for GenerateConfigReport method." + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "updateMask": { + "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", + "format": "google-fieldmask", + "type": "string" + }, + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest" + }, + "Step": { + "description": "Represents the status of one operation step.", + "type": "object", + "properties": { + "status": { + "enumDescriptions": [ + "Unspecifed code.", + "The operation or step has completed without errors.", + "The operation or step has not started yet.", + "The operation or step is in progress.", + "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.", + "The operation or step has completed with cancellation." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "DONE", + "NOT_STARTED", + "IN_PROGRESS", + "FAILED", + "CANCELLED" + ], + "description": "The status code.", + "type": "string" + }, + "description": { + "description": "The short description of the step.", + "type": "string" + } + }, + "id": "Step" + }, + "DeleteServiceStrategy": { + "properties": {}, + "id": "DeleteServiceStrategy", + "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.", + "type": "object" + }, + "LoggingDestination": { + "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", + "type": "object", + "properties": { + "logs": { + "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", + "type": "array", + "items": { + "type": "string" + } + }, + "monitoredResource": { + "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.", + "type": "string" + } + }, + "id": "LoggingDestination" + }, + "Option": { + "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", + "type": "object", + "properties": { + "value": { + "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.", + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + }, + "name": { + "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.", + "type": "string" + } + }, + "id": "Option" + }, + "Logging": { + "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history", + "type": "object", + "properties": { + "consumerDestinations": { + "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "LoggingDestination" + } + }, + "producerDestinations": { + "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.", + "type": "array", + "items": { + "$ref": "LoggingDestination" + } + } + }, + "id": "Logging" + }, + "Method": { + "id": "Method", + "description": "Method represents a method of an API interface.", + "type": "object", + "properties": { + "requestStreaming": { + "description": "If true, the request is streamed.", + "type": "boolean" + }, + "syntax": { + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ], + "description": "The source syntax of this method.", + "type": "string" + }, + "responseTypeUrl": { + "description": "The URL of the output message type.", + "type": "string" + }, + "options": { + "description": "Any metadata attached to the method.", + "type": "array", + "items": { + "$ref": "Option" + } + }, + "responseStreaming": { + "description": "If true, the response is streamed.", + "type": "boolean" + }, + "name": { + "description": "The simple name of this method.", + "type": "string" + }, + "requestTypeUrl": { + "description": "A URL of the input message type.", + "type": "string" + } + } + }, + "QuotaLimit": { + "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.", + "type": "object", + "properties": { + "duration": { + "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.", + "type": "string" + }, + "freeTier": { + "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "defaultLimit": { + "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "description": { + "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).", + "type": "string" + }, + "metric": { + "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.", + "type": "string" + }, + "displayName": { + "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.", + "type": "string" + }, + "values": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.", + "type": "object" + }, + "unit": { + "type": "string", + "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax." + }, + "maxLimit": { + "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.", + "type": "string" + } + }, + "id": "QuotaLimit" + }, + "ConfigRef": { + "description": "Represents a service configuration with its name and id.", + "type": "object", + "properties": { + "name": { + "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".", + "type": "string" + } + }, + "id": "ConfigRef" + }, + "ListServiceRolloutsResponse": { + "description": "Response message for ListServiceRollouts method.", + "type": "object", + "properties": { + "nextPageToken": { + "type": "string", + "description": "The token of the next page of results." + }, + "rollouts": { + "description": "The list of rollout resources.", + "type": "array", + "items": { + "$ref": "Rollout" + } + } + }, + "id": "ListServiceRolloutsResponse" + }, + "Mixin": { + "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }", + "type": "object", + "properties": { + "root": { + "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.", + "type": "string" + }, + "name": { + "type": "string", + "description": "The fully qualified name of the interface which is included." + } + }, + "id": "Mixin" + }, + "FlowOperationMetadata": { + "type": "object", + "properties": { + "resourceNames": { + "description": "The full name of the resources that this flow is directly associated with.", + "type": "array", + "items": { + "type": "string" + } + }, + "flowName": { + "type": "string", + "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum." + }, + "cancelState": { + "enumDescriptions": [ + "Default state, cancellable but not cancelled.", + "The operation has proceeded past the point of no return and cannot\nbe cancelled.", + "The operation has been cancelled, work should cease\nand any needed rollback steps executed." + ], + "enum": [ + "RUNNING", + "UNCANCELLABLE", + "CANCELLED" + ], + "description": "The state of the operation with respect to cancellation.", + "type": "string" + }, + "deadline": { + "type": "string", + "description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations", + "format": "google-datetime" + }, + "operationType": { + "description": "Operation type which is a flow type and subtype info as that is missing in\nour datastore otherwise. This maps to the ordinal value of the enum:\njcg/api/tenant/operations/OperationNamespace.java", + "format": "int32", + "type": "integer" + }, + "startTime": { + "description": "The start time of the operation.", + "format": "google-datetime", + "type": "string" + }, + "surface": { + "enum": [ + "UNSPECIFIED_OP_SERVICE", + "SERVICE_MANAGEMENT", + "SERVICE_USAGE", + "SERVICE_CONSUMER_MANAGEMENT" + ], + "type": "string", + "enumDescriptions": [ + "", + "", + "", + "TenancyUnit, ServiceNetworking fall under this" + ] + } + }, + "id": "FlowOperationMetadata", + "description": "The metadata associated with a long running operation resource." + }, + "CustomError": { + "type": "object", + "properties": { + "types": { + "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.", + "type": "array", + "items": { + "type": "string" + } + }, + "rules": { + "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "CustomErrorRule" + } + } + }, + "id": "CustomError", + "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError" + }, + "Http": { + "type": "object", + "properties": { + "fullyDecodeReservedExpansion": { + "type": "boolean", + "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches." + }, + "rules": { + "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "HttpRule" + } + } + }, + "id": "Http", + "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods." + }, + "SourceInfo": { + "description": "Source information used to create a Service Config", + "type": "object", + "properties": { + "sourceFiles": { + "description": "All files used during config generation.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + } + }, + "id": "SourceInfo" + }, + "Control": { + "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.", + "type": "object", + "properties": { + "environment": { + "type": "string", + "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled." + } + }, + "id": "Control" + }, + "SystemParameter": { + "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.", + "type": "object", + "properties": { + "httpHeader": { + "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.", + "type": "string" + }, + "name": { + "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.", + "type": "string" + }, + "urlQueryParameter": { + "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.", + "type": "string" + } + }, + "id": "SystemParameter" + }, + "Field": { + "description": "A single field of a message type.", + "type": "object", + "properties": { + "typeUrl": { + "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", + "type": "string" + }, + "number": { + "description": "The field number.", + "format": "int32", + "type": "integer" + }, + "kind": { + "enumDescriptions": [ + "Field type unknown.", + "Field type double.", + "Field type float.", + "Field type int64.", + "Field type uint64.", + "Field type int32.", + "Field type fixed64.", + "Field type fixed32.", + "Field type bool.", + "Field type string.", + "Field type group. Proto2 syntax only, and deprecated.", + "Field type message.", + "Field type bytes.", + "Field type uint32.", + "Field type enum.", + "Field type sfixed32.", + "Field type sfixed64.", + "Field type sint32.", + "Field type sint64." + ], + "enum": [ + "TYPE_UNKNOWN", + "TYPE_DOUBLE", + "TYPE_FLOAT", + "TYPE_INT64", + "TYPE_UINT64", + "TYPE_INT32", + "TYPE_FIXED64", + "TYPE_FIXED32", + "TYPE_BOOL", + "TYPE_STRING", + "TYPE_GROUP", + "TYPE_MESSAGE", + "TYPE_BYTES", + "TYPE_UINT32", + "TYPE_ENUM", + "TYPE_SFIXED32", + "TYPE_SFIXED64", + "TYPE_SINT32", + "TYPE_SINT64" + ], + "description": "The field type.", + "type": "string" + }, + "jsonName": { + "type": "string", + "description": "The field JSON name." + }, + "options": { + "description": "The protocol buffer options.", + "type": "array", + "items": { + "$ref": "Option" + } + }, + "oneofIndex": { + "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.", + "format": "int32", + "type": "integer" + }, + "cardinality": { + "enumDescriptions": [ + "For fields with unknown cardinality.", + "For optional fields.", + "For required fields. Proto2 syntax only.", + "For repeated fields." + ], + "enum": [ + "CARDINALITY_UNKNOWN", + "CARDINALITY_OPTIONAL", + "CARDINALITY_REQUIRED", + "CARDINALITY_REPEATED" + ], + "description": "The field cardinality.", + "type": "string" + }, + "packed": { + "description": "Whether to use alternative packed wire representation.", + "type": "boolean" + }, + "defaultValue": { + "description": "The string value of the default value of this field. Proto2 syntax only.", + "type": "string" + }, + "name": { + "description": "The field name.", + "type": "string" + } + }, + "id": "Field" + }, + "Monitoring": { + "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count", + "type": "object", + "properties": { + "consumerDestinations": { + "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "MonitoringDestination" + } + }, + "producerDestinations": { + "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", + "type": "array", + "items": { + "$ref": "MonitoringDestination" + } + } + }, + "id": "Monitoring" + }, + "TestIamPermissionsRequest": { + "properties": { + "permissions": { + "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest", + "description": "Request message for `TestIamPermissions` method.", + "type": "object" + }, + "Enum": { + "description": "Enum type definition.", + "type": "object", + "properties": { + "options": { + "type": "array", + "items": { + "$ref": "Option" + }, + "description": "Protocol buffer options." + }, + "sourceContext": { + "description": "The source context.", + "$ref": "SourceContext" + }, + "syntax": { + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ], + "description": "The source syntax.", + "type": "string", + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ] + }, + "name": { + "description": "Enum type name.", + "type": "string" + }, + "enumvalue": { + "description": "Enum value definitions.", + "type": "array", + "items": { + "$ref": "EnumValue" + } + } + }, + "id": "Enum" + }, "LabelDescriptor": { + "description": "A description of a label.", + "type": "object", "properties": { "key": { "description": "The label key.", "type": "string" }, "description": { - "description": "A human-readable description for the label.", - "type": "string" + "type": "string", + "description": "A human-readable description for the label." }, "valueType": { "type": "string", @@ -29,11 +2064,10 @@ "description": "The type of data that can be assigned to the label." } }, - "id": "LabelDescriptor", - "description": "A description of a label.", - "type": "object" + "id": "LabelDescriptor" }, "Diagnostic": { + "id": "Diagnostic", "description": "Represents a diagnostic message (error or warning)", "type": "object", "properties": { @@ -57,29 +2091,50 @@ "type": "string", "description": "File name and line number of the error or warning." } - }, - "id": "Diagnostic" + } }, "EnableServiceRequest": { - "id": "EnableServiceRequest", "description": "Request message for EnableService method.", "type": "object", "properties": { "consumerId": { - "type": "string", - "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id." + "description": "The identity of consumer resource which service enablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.", + "type": "string" } - } + }, + "id": "EnableServiceRequest" }, "Type": { - "type": "object", "properties": { + "oneofs": { + "description": "The list of types appearing in `oneof` definitions in this type.", + "type": "array", + "items": { + "type": "string" + } + }, + "syntax": { + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ], + "description": "The source syntax.", + "type": "string" + }, + "sourceContext": { + "description": "The source context.", + "$ref": "SourceContext" + }, "options": { - "description": "The protocol buffer options.", "type": "array", "items": { "$ref": "Option" - } + }, + "description": "The protocol buffer options." }, "fields": { "description": "The list of fields.", @@ -91,48 +2146,16 @@ "name": { "type": "string", "description": "The fully qualified message name." - }, - "oneofs": { - "description": "The list of types appearing in `oneof` definitions in this type.", - "type": "array", - "items": { - "type": "string" - } - }, - "syntax": { - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax.", - "type": "string", - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ] - }, - "sourceContext": { - "$ref": "SourceContext", - "description": "The source context." } }, "id": "Type", - "description": "A protocol buffer message type." + "description": "A protocol buffer message type.", + "type": "object" }, "GenerateConfigReportResponse": { + "description": "Response message for GenerateConfigReport method.", "type": "object", "properties": { - "diagnostics": { - "type": "array", - "items": { - "$ref": "Diagnostic" - }, - "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to." - }, - "serviceName": { - "description": "Name of the service this report belongs to.", - "type": "string" - }, "changeReports": { "description": "list of ChangeReport, each corresponding to comparison between two\nservice configurations.", "type": "array", @@ -141,43 +2164,55 @@ } }, "id": { - "description": "ID of the service configuration this report belongs to.", + "type": "string", + "description": "ID of the service configuration this report belongs to." + }, + "diagnostics": { + "description": "Errors / Linter warnings associated with the service definition this\nreport\nbelongs to.", + "type": "array", + "items": { + "$ref": "Diagnostic" + } + }, + "serviceName": { + "description": "Name of the service this report belongs to.", "type": "string" } }, - "id": "GenerateConfigReportResponse", - "description": "Response message for GenerateConfigReport method." + "id": "GenerateConfigReportResponse" }, "ListServiceConfigsResponse": { + "description": "Response message for ListServiceConfigs method.", "type": "object", "properties": { + "nextPageToken": { + "description": "The token of the next page of results.", + "type": "string" + }, "serviceConfigs": { "description": "The list of service configuration resources.", "type": "array", "items": { "$ref": "Service" } - }, - "nextPageToken": { - "description": "The token of the next page of results.", - "type": "string" } }, - "id": "ListServiceConfigsResponse", - "description": "Response message for ListServiceConfigs method." + "id": "ListServiceConfigsResponse" }, "Experimental": { "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.", "type": "object", "properties": { "authorization": { - "$ref": "AuthorizationConfig", - "description": "Authorization configuration." + "description": "Authorization configuration.", + "$ref": "AuthorizationConfig" } }, "id": "Experimental" }, "Backend": { + "description": "`Backend` defines the backend configuration for a service.", + "type": "object", "properties": { "rules": { "description": "A list of API backend rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", @@ -187,14 +2222,16 @@ } } }, - "id": "Backend", - "description": "`Backend` defines the backend configuration for a service.", - "type": "object" + "id": "Backend" }, "AuditConfig": { "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", "type": "object", "properties": { + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + }, "auditLogConfigs": { "description": "The configuration for logging of each type of permission.\nNext ID: 4", "type": "array", @@ -207,15 +2244,12 @@ "items": { "type": "string" } - }, - "service": { - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", - "type": "string" } }, "id": "AuditConfig" }, "SubmitConfigSourceRequest": { + "id": "SubmitConfigSourceRequest", "description": "Request message for SubmitConfigSource method.", "type": "object", "properties": { @@ -227,8 +2261,7 @@ "description": "Optional. If set, this will result in the generation of a\n`google.api.Service` configuration based on the `ConfigSource` provided,\nbut the generated config and the sources will NOT be persisted.", "type": "boolean" } - }, - "id": "SubmitConfigSourceRequest" + } }, "DocumentationRule": { "description": "A documentation rule provides information about individual API elements.", @@ -300,6 +2333,34 @@ "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.", "type": "object", "properties": { + "metricKind": { + "type": "string", + "enumDescriptions": [ + "Do not use this default value.", + "An instantaneous measurement of a value.", + "The change in a value during a time interval.", + "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints." + ], + "enum": [ + "METRIC_KIND_UNSPECIFIED", + "GAUGE", + "DELTA", + "CUMULATIVE" + ], + "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported." + }, + "displayName": { + "type": "string", + "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota." + }, + "description": { + "description": "A detailed description of the metric, which can be used in documentation.", + "type": "string" + }, + "unit": { + "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.", + "type": "string" + }, "labels": { "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.", "type": "array", @@ -316,8 +2377,6 @@ "type": "string" }, "valueType": { - "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", - "type": "string", "enumDescriptions": [ "Do not use this default value.", "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.", @@ -335,34 +2394,8 @@ "STRING", "DISTRIBUTION", "MONEY" - ] - }, - "metricKind": { - "enumDescriptions": [ - "Do not use this default value.", - "An instantaneous measurement of a value.", - "The change in a value during a time interval.", - "A value accumulated over a time interval. Cumulative\nmeasurements in a time series should have the same start time\nand increasing end times, until an event resets the cumulative\nvalue to zero and sets a new start time for the following\npoints." ], - "enum": [ - "METRIC_KIND_UNSPECIFIED", - "GAUGE", - "DELTA", - "CUMULATIVE" - ], - "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", - "type": "string" - }, - "displayName": { - "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota.", - "type": "string" - }, - "description": { - "description": "A detailed description of the metric, which can be used in documentation.", - "type": "string" - }, - "unit": { - "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.", + "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", "type": "string" } }, @@ -373,11 +2406,11 @@ "type": "object", "properties": { "consumerDestinations": { + "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.", "type": "array", "items": { "$ref": "BillingDestination" - }, - "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination." + } } }, "id": "Billing" @@ -427,20 +2460,12 @@ "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true", "type": "object", "properties": { - "name": { - "description": "The canonical name of this endpoint.", - "type": "string" - }, - "target": { - "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".", - "type": "string" - }, "aliases": { + "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on.", "type": "array", "items": { "type": "string" - }, - "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on." + } }, "features": { "description": "The list of features enabled on this endpoint.", @@ -452,6 +2477,14 @@ "allowCors": { "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.", "type": "boolean" + }, + "name": { + "description": "The canonical name of this endpoint.", + "type": "string" + }, + "target": { + "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".", + "type": "string" } }, "id": "Endpoint" @@ -461,8 +2494,8 @@ "type": "object", "properties": { "canonicalScopes": { - "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read", - "type": "string" + "type": "string", + "description": "The list of publicly documented OAuth scopes that are allowed access. An\nOAuth token containing any of these scopes will be accepted.\n\nExample:\n\n canonical_scopes: https://www.googleapis.com/auth/calendar,\n https://www.googleapis.com/auth/calendar.read" } }, "id": "OAuthRequirements" @@ -471,23 +2504,23 @@ "description": "Configuration controlling usage of a service.", "type": "object", "properties": { - "producerNotificationChannel": { - "type": "string", - "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview." - }, - "rules": { - "type": "array", - "items": { - "$ref": "UsageRule" - }, - "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order." - }, "requirements": { + "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.", "type": "array", "items": { "type": "string" - }, - "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'." + } + }, + "producerNotificationChannel": { + "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.", + "type": "string" + }, + "rules": { + "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "UsageRule" + } } }, "id": "Usage" @@ -513,7 +2546,6 @@ "id": "TestIamPermissionsResponse" }, "Context": { - "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.", "type": "object", "properties": { "rules": { @@ -524,22 +2556,24 @@ } } }, - "id": "Context" + "id": "Context", + "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`." }, "LogDescriptor": { + "id": "LogDescriptor", "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer", "type": "object", "properties": { "labels": { + "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", "type": "array", "items": { "$ref": "LabelDescriptor" - }, - "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid." + } }, "name": { - "type": "string", - "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.]." + "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].", + "type": "string" }, "description": { "type": "string", @@ -549,12 +2583,9 @@ "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.", "type": "string" } - }, - "id": "LogDescriptor" + } }, "ConfigFile": { - "description": "Generic specification of a source configuration file", - "type": "object", "properties": { "filePath": { "description": "The file name of the configuration file (full or relative path).", @@ -586,27 +2617,37 @@ "type": "string" } }, - "id": "ConfigFile" + "id": "ConfigFile", + "description": "Generic specification of a source configuration file", + "type": "object" }, "CustomErrorRule": { "description": "A custom error rule.", "type": "object", "properties": { + "isErrorType": { + "type": "boolean", + "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload." + }, "selector": { "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.", "type": "string" - }, - "isErrorType": { - "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.", - "type": "boolean" } }, "id": "CustomErrorRule" }, "MonitoredResourceDescriptor": { + "id": "MonitoredResourceDescriptor", "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.", "type": "object", "properties": { + "labels": { + "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + }, "name": { "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.", "type": "string" @@ -622,31 +2663,36 @@ "type": { "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.", "type": "string" - }, - "labels": { - "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } } - }, - "id": "MonitoredResourceDescriptor" + } }, "CustomAuthRequirements": { "description": "Configuration for a custom authentication provider.", "type": "object", "properties": { "provider": { - "type": "string", - "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice)." + "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).", + "type": "string" } }, "id": "CustomAuthRequirements" }, "MediaDownload": { + "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", "type": "object", "properties": { + "completeNotification": { + "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.", + "type": "boolean" + }, + "enabled": { + "type": "boolean", + "description": "Whether download is enabled." + }, + "downloadService": { + "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.", + "type": "string" + }, "maxDirectDownloadSize": { "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.", "format": "int64", @@ -659,22 +2705,9 @@ "useDirectDownload": { "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.", "type": "boolean" - }, - "completeNotification": { - "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.", - "type": "boolean" - }, - "enabled": { - "description": "Whether download is enabled.", - "type": "boolean" - }, - "downloadService": { - "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the download service if one is used for download.", - "type": "string" } }, - "id": "MediaDownload", - "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods." + "id": "MediaDownload" }, "ChangeReport": { "description": "Change report associated with a particular service configuration.\n\nIt contains a list of ConfigChanges based on the comparison between\ntwo service configurations.", @@ -691,6 +2724,7 @@ "id": "ChangeReport" }, "DisableServiceRequest": { + "id": "DisableServiceRequest", "description": "Request message for DisableService method.", "type": "object", "properties": { @@ -698,11 +2732,9 @@ "description": "The identity of consumer resource which service disablement will be\napplied to.\n\nThe Google Service Management implementation accepts the following\nforms:\n- \"project:\u003cproject_id\u003e\"\n\nNote: this is made compatible with\ngoogle.api.servicecontrol.v1.Operation.consumer_id.", "type": "string" } - }, - "id": "DisableServiceRequest" + } }, "SubmitConfigSourceResponse": { - "id": "SubmitConfigSourceResponse", "description": "Response message for SubmitConfigSource method.", "type": "object", "properties": { @@ -710,28 +2742,11 @@ "$ref": "Service", "description": "The generated service configuration." } - } + }, + "id": "SubmitConfigSourceResponse" }, "MediaUpload": { - "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", - "type": "object", "properties": { - "completeNotification": { - "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.", - "type": "boolean" - }, - "progressNotification": { - "description": "Whether to receive a notification for progress changes of media upload.", - "type": "boolean" - }, - "enabled": { - "type": "boolean", - "description": "Whether upload is enabled." - }, - "dropzone": { - "type": "string", - "description": "Name of the Scotty dropzone to use for the current API." - }, "startNotification": { "description": "Whether to receive a notification on the start of media upload.", "type": "boolean" @@ -746,35 +2761,52 @@ "type": "string" }, "mimeTypes": { + "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.", "type": "array", "items": { "type": "string" - }, - "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns." + } + }, + "completeNotification": { + "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.", + "type": "boolean" + }, + "progressNotification": { + "description": "Whether to receive a notification for progress changes of media upload.", + "type": "boolean" + }, + "enabled": { + "description": "Whether upload is enabled.", + "type": "boolean" + }, + "dropzone": { + "description": "Name of the Scotty dropzone to use for the current API.", + "type": "string" } }, - "id": "MediaUpload" + "id": "MediaUpload", + "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", + "type": "object" }, "BillingDestination": { + "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).", + "type": "object", "properties": { + "monitoredResource": { + "type": "string", + "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section." + }, "metrics": { "description": "Names of the metrics to report to this billing destination.\nEach name must be defined in Service.metrics section.", "type": "array", "items": { "type": "string" } - }, - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", - "type": "string" } }, - "id": "BillingDestination", - "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).", - "type": "object" + "id": "BillingDestination" }, "Advice": { - "id": "Advice", "description": "Generated advice about this change, used for providing more\ninformation about how a change will affect the existing service.", "type": "object", "properties": { @@ -782,9 +2814,11 @@ "description": "Useful description for why this advice was applied and what actions should\nbe taken to mitigate any implied risks.", "type": "string" } - } + }, + "id": "Advice" }, "ManagedService": { + "description": "The full representation of a Service that is managed by\nGoogle Service Management.", "type": "object", "properties": { "producerProjectId": { @@ -796,8 +2830,7 @@ "type": "string" } }, - "id": "ManagedService", - "description": "The full representation of a Service that is managed by\nGoogle Service Management." + "id": "ManagedService" }, "UsageRule": { "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true", @@ -819,19 +2852,19 @@ "id": "UsageRule" }, "AuthRequirement": { - "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "type": "object", "properties": { - "audiences": { - "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", - "type": "string" - }, "providerId": { "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth", "type": "string" + }, + "audiences": { + "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", + "type": "string" } }, - "id": "AuthRequirement" + "id": "AuthRequirement", + "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32)." }, "TrafficPercentStrategy": { "description": "Strategy that specifies how clients of Google Service Controller want to\nsend traffic to use different config versions. This is generally\nused by API proxy to split traffic based on your configured precentage for\neach config version.\n\nOne example of how to gradually rollout a new service configuration using\nthis\nstrategy:\nDay 1\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160206\"\n traffic_percent_strategy {\n percentages: {\n \"example.googleapis.com/20160201\": 70.00\n \"example.googleapis.com/20160206\": 30.00\n }\n }\n }\n\nDay 2\n\n Rollout {\n id: \"example.googleapis.com/rollout_20160207\"\n traffic_percent_strategy: {\n percentages: {\n \"example.googleapis.com/20160206\": 100.00\n }\n }\n }", @@ -853,6 +2886,17 @@ "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.", "type": "object", "properties": { + "pages": { + "description": "The top level pages for the documentation set.", + "type": "array", + "items": { + "$ref": "Page" + } + }, + "summary": { + "type": "string", + "description": "A short summary of what the service does. Can only be provided by\nplain text." + }, "documentationRootUrl": { "description": "The URL to the root of documentation.", "type": "string" @@ -865,18 +2909,7 @@ } }, "overview": { - "type": "string", - "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field." - }, - "pages": { - "description": "The top level pages for the documentation set.", - "type": "array", - "items": { - "$ref": "Page" - } - }, - "summary": { - "description": "A short summary of what the service does. Can only be provided by\nplain text.", + "description": "Declares a single overview page. For example:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n overview: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nThis is a shortcut for the following declaration (using pages style):\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: ...\n pages:\n - name: Overview\n content: (== include overview.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nNote: you cannot specify both `overview` field and `pages` field.", "type": "string" } } @@ -893,8 +2926,6 @@ } }, "logType": { - "description": "The log type that this config enables.", - "type": "string", "enumDescriptions": [ "Default case. Should never be this.", "Admin reads. Example: CloudIAM getIamPolicy", @@ -906,12 +2937,15 @@ "ADMIN_READ", "DATA_WRITE", "DATA_READ" - ] + ], + "description": "The log type that this config enables.", + "type": "string" } }, "id": "AuditLogConfig" }, "ConfigSource": { + "id": "ConfigSource", "description": "Represents a source file which is used to generate the service configuration\ndefined by `google.api.Service`.", "type": "object", "properties": { @@ -926,14 +2960,22 @@ "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", "type": "string" } - }, - "id": "ConfigSource" + } }, "BackendRule": { "id": "BackendRule", "description": "A backend rule provides configuration for an individual API element.", "type": "object", "properties": { + "selector": { + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "deadline": { + "type": "number", + "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.", + "format": "double" + }, "minDeadline": { "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.", "format": "double", @@ -942,15 +2984,6 @@ "address": { "description": "The address of the API backend.", "type": "string" - }, - "selector": { - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "deadline": { - "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.", - "format": "double", - "type": "number" } } }, @@ -978,8 +3011,8 @@ "description": "The requirements for OAuth credentials." }, "customAuth": { - "description": "Configuration for custom authentication.", - "$ref": "CustomAuthRequirements" + "$ref": "CustomAuthRequirements", + "description": "Configuration for custom authentication." } }, "id": "AuthenticationRule" @@ -996,8 +3029,10 @@ "id": "UndeleteServiceResponse" }, "Policy": { - "type": "object", "properties": { + "iamOwned": { + "type": "boolean" + }, "etag": { "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", "format": "byte", @@ -1021,47 +3056,26 @@ "items": { "$ref": "Binding" } - }, - "iamOwned": { - "type": "boolean" } }, "id": "Policy", - "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs)." + "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam/docs).", + "type": "object" }, "Api": { + "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.", "type": "object", "properties": { - "name": { - "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name.", - "type": "string" - }, - "syntax": { - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ], - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax of the service.", - "type": "string" - }, - "sourceContext": { - "$ref": "SourceContext", - "description": "Source context for the protocol buffer service represented by this\nmessage." - }, "version": { "description": "A version string for this interface. If specified, must have the form\n`major-version.minor-version`, as in `1.10`. If the minor version is\nomitted, it defaults to zero. If the entire version field is empty, the\nmajor version is derived from the package name, as outlined below. If the\nfield is not empty, the version in the package name will be verified to be\nconsistent with what is provided here.\n\nThe versioning schema uses [semantic\nversioning](http://semver.org) where the major version number\nindicates a breaking change and the minor version an additive,\nnon-breaking change. Both version numbers are signals to users\nwhat to expect from different versions, and should be carefully\nchosen based on the product plan.\n\nThe major version is also reflected in the package name of the\ninterface, which must end in `v\u003cmajor-version\u003e`, as in\n`google.feature.v1`. For major versions 0 and 1, the suffix can\nbe omitted. Zero major versions must only be used for\nexperimental, non-GA interfaces.\n", "type": "string" }, "mixins": { + "description": "Included interfaces. See Mixin.", "type": "array", "items": { "$ref": "Mixin" - }, - "description": "Included interfaces. See Mixin." + } }, "options": { "description": "Any metadata attached to the interface.", @@ -1076,10 +3090,29 @@ "items": { "$ref": "Method" } + }, + "name": { + "type": "string", + "description": "The fully qualified name of this interface, including package name\nfollowed by the interface's simple name." + }, + "syntax": { + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ], + "description": "The source syntax of the service.", + "type": "string" + }, + "sourceContext": { + "description": "Source context for the protocol buffer service represented by this\nmessage.", + "$ref": "SourceContext" } }, - "id": "Api", - "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology." + "id": "Api" }, "MetricRule": { "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.", @@ -1091,8 +3124,8 @@ }, "metricCosts": { "additionalProperties": { - "type": "string", - "format": "int64" + "format": "int64", + "type": "string" }, "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.", "type": "object" @@ -1101,25 +3134,25 @@ "id": "MetricRule" }, "Authentication": { - "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", "type": "object", "properties": { - "rules": { - "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "AuthenticationRule" - } - }, "providers": { "description": "Defines a set of authentication providers that a service supports.", "type": "array", "items": { "$ref": "AuthProvider" } + }, + "rules": { + "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", + "type": "array", + "items": { + "$ref": "AuthenticationRule" + } } }, - "id": "Authentication" + "id": "Authentication", + "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth" }, "Operation": { "id": "Operation", @@ -1131,16 +3164,16 @@ "type": "boolean" }, "response": { - "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", "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" + "type": "string", + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`." }, "error": { "$ref": "Status", @@ -1160,6 +3193,10 @@ "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.", "type": "object", "properties": { + "content": { + "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.", + "type": "string" + }, "subpages": { "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.", "type": "array", @@ -1170,1192 +3207,14 @@ "name": { "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.", "type": "string" - }, - "content": { - "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.", - "type": "string" } }, "id": "Page" - }, - "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 is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "code": { - "type": "integer", - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32" - } - }, - "id": "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.", - "type": "object" - }, - "Binding": { - "properties": { - "members": { - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", - "type": "array", - "items": { - "type": "string" - } - }, - "role": { - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", - "type": "string" - }, - "condition": { - "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL.", - "$ref": "Expr" - } - }, - "id": "Binding", - "description": "Associates `members` with a `role`.", - "type": "object" - }, - "AuthProvider": { - "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", - "type": "object", - "properties": { - "jwksUri": { - "description": "URL of the provider's public key set to validate signature of the JWT. See\n[OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata).\nOptional if the key set document:\n - can be retrieved from\n [OpenID Discovery](https://openid.net/specs/openid-connect-discovery-1_0.html\n of the issuer.\n - can be inferred from the email domain of the issuer (e.g. a Google service account).\n\nExample: https://www.googleapis.com/oauth2/v1/certs", - "type": "string" - }, - "audiences": { - "description": "The list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", - "type": "string" - }, - "id": { - "description": "The unique identifier of the auth provider. It will be referred to by\n`AuthRequirement.provider_id`.\n\nExample: \"bookstore_auth\".", - "type": "string" - }, - "issuer": { - "type": "string", - "description": "Identifies the principal that issued the JWT. See\nhttps://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.1\nUsually a URL or an email address.\n\nExample: https://securetoken.google.com\nExample: 1234567-compute@developer.gserviceaccount.com" - }, - "authorizationUrl": { - "description": "Redirect URL if JWT token is required but no present or is expired.\nImplement authorizationUrl of securityDefinitions in OpenAPI spec.", - "type": "string" - } - }, - "id": "AuthProvider" - }, - "Service": { - "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", - "type": "object", - "properties": { - "usage": { - "$ref": "Usage", - "description": "Configuration controlling usage of this service." - }, - "metrics": { - "type": "array", - "items": { - "$ref": "MetricDescriptor" - }, - "description": "Defines the metrics used by this service." - }, - "authentication": { - "$ref": "Authentication", - "description": "Auth configuration." - }, - "experimental": { - "description": "Experimental configuration.", - "$ref": "Experimental" - }, - "control": { - "$ref": "Control", - "description": "Configuration for the service control plane." - }, - "configVersion": { - "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.", - "format": "uint32", - "type": "integer" - }, - "monitoring": { - "$ref": "Monitoring", - "description": "Monitoring configuration." - }, - "systemTypes": { - "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.", - "type": "array", - "items": { - "$ref": "Type" - } - }, - "producerProjectId": { - "description": "The Google project that owns this service.", - "type": "string" - }, - "visibility": { - "description": "API visibility configuration.", - "$ref": "Visibility" - }, - "quota": { - "$ref": "Quota", - "description": "Quota configuration." - }, - "name": { - "type": "string", - "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`." - }, - "billing": { - "$ref": "Billing", - "description": "Billing configuration." - }, - "customError": { - "description": "Custom error configuration.", - "$ref": "CustomError" - }, - "title": { - "description": "The product title for this service.", - "type": "string" - }, - "endpoints": { - "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.", - "type": "array", - "items": { - "$ref": "Endpoint" - } - }, - "apis": { - "description": "A list of API interfaces exported by this service. Only the `name` field\nof the google.protobuf.Api needs to be provided by the configuration\nauthor, as the remaining fields will be derived from the IDL during the\nnormalization process. It is an error to specify an API interface here\nwhich cannot be resolved against the associated IDL files.", - "type": "array", - "items": { - "$ref": "Api" - } - }, - "logs": { - "description": "Defines the logs used by this service.", - "type": "array", - "items": { - "$ref": "LogDescriptor" - } - }, - "types": { - "description": "A list of all proto message types included in this API service.\nTypes referenced directly or indirectly by the `apis` are\nautomatically included. Messages which are not referenced but\nshall be included, such as types used by the `google.protobuf.Any` type,\nshould be listed here by name. Example:\n\n types:\n - name: google.protobuf.Int32", - "type": "array", - "items": { - "$ref": "Type" - } - }, - "sourceInfo": { - "description": "Output only. The source information for this configuration if available.", - "$ref": "SourceInfo" - }, - "http": { - "$ref": "Http", - "description": "HTTP configuration." - }, - "backend": { - "$ref": "Backend", - "description": "API backend configuration." - }, - "systemParameters": { - "description": "System parameter configuration.", - "$ref": "SystemParameters" - }, - "documentation": { - "description": "Additional API documentation.", - "$ref": "Documentation" - }, - "monitoredResources": { - "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", - "type": "array", - "items": { - "$ref": "MonitoredResourceDescriptor" - } - }, - "logging": { - "$ref": "Logging", - "description": "Logging configuration." - }, - "enums": { - "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum", - "type": "array", - "items": { - "$ref": "Enum" - } - }, - "context": { - "$ref": "Context", - "description": "Context configuration." - }, - "id": { - "type": "string", - "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead." - } - }, - "id": "Service" - }, - "EnumValue": { - "description": "Enum value definition.", - "type": "object", - "properties": { - "name": { - "description": "Enum value name.", - "type": "string" - }, - "options": { - "description": "Protocol buffer options.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "number": { - "description": "Enum value number.", - "format": "int32", - "type": "integer" - } - }, - "id": "EnumValue" - }, - "ListOperationsResponse": { - "type": "object", - "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Operation" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations." - }, - "CustomHttpPattern": { - "description": "A custom pattern is used for defining custom HTTP verb.", - "type": "object", - "properties": { - "path": { - "description": "The path matched by this custom verb.", - "type": "string" - }, - "kind": { - "description": "The name of this custom HTTP verb.", - "type": "string" - } - }, - "id": "CustomHttpPattern" - }, - "OperationMetadata": { - "type": "object", - "properties": { - "resourceNames": { - "description": "The full name of the resources that this operation is directly\nassociated with.", - "type": "array", - "items": { - "type": "string" - } - }, - "steps": { - "type": "array", - "items": { - "$ref": "Step" - }, - "description": "Detailed status information for each step. The order is undetermined." - }, - "progressPercentage": { - "type": "integer", - "description": "Percentage of completion of this operation, ranging from 0 to 100.", - "format": "int32" - }, - "startTime": { - "description": "The start time of the operation.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "OperationMetadata", - "description": "The metadata associated with a long running operation resource." - }, - "SystemParameterRule": { - "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.", - "type": "object", - "properties": { - "parameters": { - "description": "Define parameters. Multiple names may be defined for a parameter.\nFor a given method call, only one of them should be used. If multiple\nnames are used the behavior is implementation-dependent.\nIf none of the specified names are present the behavior is\nparameter-dependent.", - "type": "array", - "items": { - "$ref": "SystemParameter" - } - }, - "selector": { - "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "SystemParameterRule" - }, - "VisibilityRule": { - "description": "A visibility rule provides visibility configuration for an individual API\nelement.", - "type": "object", - "properties": { - "restriction": { - "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", - "type": "string" - }, - "selector": { - "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "VisibilityRule" - }, - "HttpRule": { - "type": "object", - "properties": { - "mediaUpload": { - "$ref": "MediaUpload", - "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods." - }, - "selector": { - "description": "Selects methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "custom": { - "description": "The custom pattern is used for specifying an HTTP method that is not\nincluded in the `pattern` field, such as HEAD, or \"*\" to leave the\nHTTP method unspecified for this rule. The wild-card rule is useful\nfor services that provide content to Web (HTML) clients.", - "$ref": "CustomHttpPattern" - }, - "get": { - "description": "Used for listing and getting information about resources.", - "type": "string" - }, - "patch": { - "description": "Used for updating a resource.", - "type": "string" - }, - "put": { - "description": "Used for updating a resource.", - "type": "string" - }, - "delete": { - "description": "Used for deleting a resource.", - "type": "string" - }, - "body": { - "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", - "type": "string" - }, - "mediaDownload": { - "$ref": "MediaDownload", - "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration." - }, - "post": { - "description": "Used for creating a resource.", - "type": "string" - }, - "additionalBindings": { - "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", - "type": "array", - "items": { - "$ref": "HttpRule" - } - }, - "responseBody": { - "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.", - "type": "string" - } - }, - "id": "HttpRule", - "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields." - }, - "MonitoringDestination": { - "type": "object", - "properties": { - "metrics": { - "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.", - "type": "array", - "items": { - "type": "string" - } - }, - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", - "type": "string" - } - }, - "id": "MonitoringDestination", - "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project)." - }, - "Visibility": { - "id": "Visibility", - "description": "`Visibility` defines restrictions for the visibility of service\nelements. Restrictions are specified using visibility labels\n(e.g., TRUSTED_TESTER) that are elsewhere linked to users and projects.\n\nUsers and projects can have access to more than one visibility label. The\neffective visibility for multiple labels is the union of each label's\nelements, plus any unrestricted elements.\n\nIf an element and its parents have no restrictions, visibility is\nunconditionally granted.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: TRUSTED_TESTER\n - selector: google.calendar.Calendar.Delegate\n restriction: GOOGLE_INTERNAL\n\nHere, all methods are publicly visible except for the restricted methods\nEnhancedSearch and Delegate.", - "type": "object", - "properties": { - "rules": { - "description": "A list of visibility rules that apply to individual API elements.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "VisibilityRule" - } - } - } - }, - "ConfigChange": { - "type": "object", - "properties": { - "changeType": { - "description": "The type for this change, either ADDED, REMOVED, or MODIFIED.", - "type": "string", - "enumDescriptions": [ - "No value was provided.", - "The changed object exists in the 'new' service configuration, but not\nin the 'old' service configuration.", - "The changed object exists in the 'old' service configuration, but not\nin the 'new' service configuration.", - "The changed object exists in both service configurations, but its value\nis different." - ], - "enum": [ - "CHANGE_TYPE_UNSPECIFIED", - "ADDED", - "REMOVED", - "MODIFIED" - ] - }, - "element": { - "description": "Object hierarchy path to the change, with levels separated by a '.'\ncharacter. For repeated fields, an applicable unique identifier field is\nused for the index (usually selector, name, or id). For maps, the term\n'key' is used. If the field has no unique identifier, the numeric index\nis used.\nExamples:\n- visibility.rules[selector==\"google.LibraryService.CreateBook\"].restriction\n- quota.metric_rules[selector==\"google\"].metric_costs[key==\"reads\"].value\n- logging.producer_destinations[0]", - "type": "string" - }, - "oldValue": { - "description": "Value of the changed object in the old Service configuration,\nin JSON format. This field will not be populated if ChangeType == ADDED.", - "type": "string" - }, - "advices": { - "description": "Collection of advice provided for this change, useful for determining the\npossible impact of this change.", - "type": "array", - "items": { - "$ref": "Advice" - } - }, - "newValue": { - "type": "string", - "description": "Value of the changed object in the new Service configuration,\nin JSON format. This field will not be populated if ChangeType == REMOVED." - } - }, - "id": "ConfigChange", - "description": "Output generated from semantically comparing two versions of a service\nconfiguration.\n\nIncludes detailed information about a field that have changed with\napplicable advice about potential consequences for the change, such as\nbackwards-incompatibility." - }, - "SystemParameters": { - "description": "### System parameter configuration\n\nA system parameter is a special kind of parameter defined by the API\nsystem, not by an individual API. It is typically mapped to an HTTP header\nand/or a URL query parameter. This configuration specifies which methods\nchange the names of the system parameters.", - "type": "object", - "properties": { - "rules": { - "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "SystemParameterRule" - } - } - }, - "id": "SystemParameters" - }, - "Rollout": { - "id": "Rollout", - "description": "A rollout resource that defines how service configuration versions are pushed\nto control plane systems. Typically, you create a new version of the\nservice config, and then create a Rollout to push the service config.", - "type": "object", - "properties": { - "createdBy": { - "description": "The user who created the Rollout. Readonly.", - "type": "string" - }, - "trafficPercentStrategy": { - "$ref": "TrafficPercentStrategy", - "description": "Google Service Control selects service configurations based on\ntraffic percentage." - }, - "rolloutId": { - "type": "string", - "description": "Optional unique identifier of this Rollout. Only lower case letters, digits\n and '-' are allowed.\n\nIf not specified by client, the server will generate one. The generated id\nwill have the form of \u003cdate\u003e\u003crevision number\u003e, where \"date\" is the create\ndate in ISO 8601 format. \"revision number\" is a monotonically increasing\npositive number that is reset every day for each service.\nAn example of the generated rollout_id is '2016-02-16r1'" - }, - "deleteServiceStrategy": { - "$ref": "DeleteServiceStrategy", - "description": "The strategy associated with a rollout to delete a `ManagedService`.\nReadonly." - }, - "createTime": { - "description": "Creation time of the rollout. Readonly.", - "format": "google-datetime", - "type": "string" - }, - "status": { - "description": "The status of this rollout. Readonly. In case of a failed rollout,\nthe system will automatically rollback to the current Rollout\nversion. Readonly.", - "type": "string", - "enumDescriptions": [ - "No status specified.", - "The Rollout is in progress.", - "The Rollout has completed successfully.", - "The Rollout has been cancelled. This can happen if you have overlapping\nRollout pushes, and the previous ones will be cancelled.", - "The Rollout has failed and the rollback attempt has failed too.", - "The Rollout has not started yet and is pending for execution.", - "The Rollout has failed and rolled back to the previous successful\nRollout." - ], - "enum": [ - "ROLLOUT_STATUS_UNSPECIFIED", - "IN_PROGRESS", - "SUCCESS", - "CANCELLED", - "FAILED", - "PENDING", - "FAILED_ROLLED_BACK" - ] - }, - "serviceName": { - "description": "The name of the service associated with this Rollout.", - "type": "string" - } - } - }, - "Quota": { - "properties": { - "limits": { - "description": "List of `QuotaLimit` definitions for the service.", - "type": "array", - "items": { - "$ref": "QuotaLimit" - } - }, - "metricRules": { - "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.", - "type": "array", - "items": { - "$ref": "MetricRule" - } - } - }, - "id": "Quota", - "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", - "type": "object" - }, - "GenerateConfigReportRequest": { - "id": "GenerateConfigReportRequest", - "description": "Request message for GenerateConfigReport method.", - "type": "object", - "properties": { - "oldConfig": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service configuration against which the comparison will be done.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service" - }, - "newConfig": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service configuration for which we want to generate the report.\nFor this version of API, the supported types are\ngoogle.api.servicemanagement.v1.ConfigRef,\ngoogle.api.servicemanagement.v1.ConfigSource,\nand google.api.Service", - "type": "object" - } - } - }, - "SetIamPolicyRequest": { - "type": "object", - "properties": { - "updateMask": { - "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" - }, - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." - } - }, - "id": "SetIamPolicyRequest", - "description": "Request message for `SetIamPolicy` method." - }, - "Step": { - "type": "object", - "properties": { - "status": { - "enumDescriptions": [ - "Unspecifed code.", - "The operation or step has completed without errors.", - "The operation or step has not started yet.", - "The operation or step is in progress.", - "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.", - "The operation or step has completed with cancellation." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "DONE", - "NOT_STARTED", - "IN_PROGRESS", - "FAILED", - "CANCELLED" - ], - "description": "The status code.", - "type": "string" - }, - "description": { - "description": "The short description of the step.", - "type": "string" - } - }, - "id": "Step", - "description": "Represents the status of one operation step." - }, - "DeleteServiceStrategy": { - "properties": {}, - "id": "DeleteServiceStrategy", - "description": "Strategy used to delete a service. This strategy is a placeholder only\nused by the system generated rollout to delete a service.", - "type": "object" - }, - "LoggingDestination": { - "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", - "type": "object", - "properties": { - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.", - "type": "string" - }, - "logs": { - "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "LoggingDestination" - }, - "Option": { - "id": "Option", - "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", - "type": "object", - "properties": { - "name": { - "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.", - "type": "string" - }, - "value": { - "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - } - }, - "Logging": { - "type": "object", - "properties": { - "consumerDestinations": { - "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "LoggingDestination" - } - }, - "producerDestinations": { - "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.", - "type": "array", - "items": { - "$ref": "LoggingDestination" - } - } - }, - "id": "Logging", - "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history" - }, - "Method": { - "description": "Method represents a method of an API interface.", - "type": "object", - "properties": { - "requestTypeUrl": { - "description": "A URL of the input message type.", - "type": "string" - }, - "requestStreaming": { - "description": "If true, the request is streamed.", - "type": "boolean" - }, - "syntax": { - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax of this method.", - "type": "string", - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ] - }, - "responseTypeUrl": { - "description": "The URL of the output message type.", - "type": "string" - }, - "options": { - "description": "Any metadata attached to the method.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "responseStreaming": { - "description": "If true, the response is streamed.", - "type": "boolean" - }, - "name": { - "description": "The simple name of this method.", - "type": "string" - } - }, - "id": "Method" - }, - "QuotaLimit": { - "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.", - "type": "object", - "properties": { - "name": { - "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.", - "type": "string" - }, - "duration": { - "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.", - "type": "string" - }, - "freeTier": { - "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "defaultLimit": { - "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "description": { - "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).", - "type": "string" - }, - "metric": { - "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.", - "type": "string" - }, - "displayName": { - "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.", - "type": "string" - }, - "values": { - "additionalProperties": { - "type": "string", - "format": "int64" - }, - "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.", - "type": "object" - }, - "unit": { - "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.", - "type": "string" - }, - "maxLimit": { - "type": "string", - "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", - "format": "int64" - } - }, - "id": "QuotaLimit" - }, - "ConfigRef": { - "description": "Represents a service configuration with its name and id.", - "type": "object", - "properties": { - "name": { - "description": "Resource name of a service config. It must have the following\nformat: \"services/{service name}/configs/{config id}\".", - "type": "string" - } - }, - "id": "ConfigRef" - }, - "ListServiceRolloutsResponse": { - "description": "Response message for ListServiceRollouts method.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "The token of the next page of results.", - "type": "string" - }, - "rollouts": { - "description": "The list of rollout resources.", - "type": "array", - "items": { - "$ref": "Rollout" - } - } - }, - "id": "ListServiceRolloutsResponse" - }, - "Mixin": { - "type": "object", - "properties": { - "name": { - "description": "The fully qualified name of the interface which is included.", - "type": "string" - }, - "root": { - "description": "If non-empty specifies a path under which inherited HTTP paths\nare rooted.", - "type": "string" - } - }, - "id": "Mixin", - "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }" - }, - "FlowOperationMetadata": { - "properties": { - "resourceNames": { - "description": "The full name of the resources that this flow is directly associated with.", - "type": "array", - "items": { - "type": "string" - } - }, - "flowName": { - "description": "The name of the top-level flow corresponding to this operation.\nMust be equal to the \"name\" field for a FlowName enum.", - "type": "string" - }, - "cancelState": { - "enum": [ - "RUNNING", - "UNCANCELLABLE", - "CANCELLED" - ], - "description": "The state of the operation with respect to cancellation.", - "type": "string", - "enumDescriptions": [ - "Default state, cancellable but not cancelled.", - "The operation has proceeded past the point of no return and cannot\nbe cancelled.", - "The operation has been cancelled, work should cease\nand any needed rollback steps executed." - ] - }, - "deadline": { - "description": "Deadline for the flow to complete, to prevent orphaned Operations.\n\nIf the flow has not completed by this time, it may be terminated by\nthe engine, or force-failed by Operation lookup.\n\nNote that this is not a hard deadline after which the Flow will\ndefinitely be failed, rather it is a deadline after which it is reasonable\nto suspect a problem and other parts of the system may kill operation\nto ensure we don't have orphans.\nsee also: go/prevent-orphaned-operations", - "format": "google-datetime", - "type": "string" - }, - "operationType": { - "description": "Operation type which is a flow type and subtype info as that is missing in\nour datastore otherwise. This maps to the ordinal value of the enum:\njcg/api/tenant/operations/OperationNamespace.java", - "format": "int32", - "type": "integer" - }, - "startTime": { - "description": "The start time of the operation.", - "format": "google-datetime", - "type": "string" - }, - "surface": { - "type": "string", - "enumDescriptions": [ - "", - "", - "", - "TenancyUnit, ServiceNetworking fall under this" - ], - "enum": [ - "UNSPECIFIED_OP_SERVICE", - "SERVICE_MANAGEMENT", - "SERVICE_USAGE", - "SERVICE_CONSUMER_MANAGEMENT" - ] - } - }, - "id": "FlowOperationMetadata", - "description": "The metadata associated with a long running operation resource.", - "type": "object" - }, - "CustomError": { - "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError", - "type": "object", - "properties": { - "types": { - "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.", - "type": "array", - "items": { - "type": "string" - } - }, - "rules": { - "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "CustomErrorRule" - } - } - }, - "id": "CustomError" - }, - "Http": { - "properties": { - "rules": { - "description": "A list of HTTP configuration rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", - "type": "array", - "items": { - "$ref": "HttpRule" - } - }, - "fullyDecodeReservedExpansion": { - "description": "When set to true, URL path parmeters will be fully URI-decoded except in\ncases of single segment matches in reserved expansion, where \"%2F\" will be\nleft encoded.\n\nThe default behavior is to not decode RFC 6570 reserved characters in multi\nsegment matches.", - "type": "boolean" - } - }, - "id": "Http", - "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.", - "type": "object" - }, - "SourceInfo": { - "description": "Source information used to create a Service Config", - "type": "object", - "properties": { - "sourceFiles": { - "description": "All files used during config generation.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - } - }, - "id": "SourceInfo" - }, - "Control": { - "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.", - "type": "object", - "properties": { - "environment": { - "description": "The service control environment to use. If empty, no control plane\nfeature (like quota and billing) will be enabled.", - "type": "string" - } - }, - "id": "Control" - }, - "SystemParameter": { - "type": "object", - "properties": { - "urlQueryParameter": { - "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.", - "type": "string" - }, - "httpHeader": { - "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.", - "type": "string" - }, - "name": { - "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.", - "type": "string" - } - }, - "id": "SystemParameter", - "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent." - }, - "Field": { - "type": "object", - "properties": { - "kind": { - "enumDescriptions": [ - "Field type unknown.", - "Field type double.", - "Field type float.", - "Field type int64.", - "Field type uint64.", - "Field type int32.", - "Field type fixed64.", - "Field type fixed32.", - "Field type bool.", - "Field type string.", - "Field type group. Proto2 syntax only, and deprecated.", - "Field type message.", - "Field type bytes.", - "Field type uint32.", - "Field type enum.", - "Field type sfixed32.", - "Field type sfixed64.", - "Field type sint32.", - "Field type sint64." - ], - "enum": [ - "TYPE_UNKNOWN", - "TYPE_DOUBLE", - "TYPE_FLOAT", - "TYPE_INT64", - "TYPE_UINT64", - "TYPE_INT32", - "TYPE_FIXED64", - "TYPE_FIXED32", - "TYPE_BOOL", - "TYPE_STRING", - "TYPE_GROUP", - "TYPE_MESSAGE", - "TYPE_BYTES", - "TYPE_UINT32", - "TYPE_ENUM", - "TYPE_SFIXED32", - "TYPE_SFIXED64", - "TYPE_SINT32", - "TYPE_SINT64" - ], - "description": "The field type.", - "type": "string" - }, - "jsonName": { - "description": "The field JSON name.", - "type": "string" - }, - "options": { - "description": "The protocol buffer options.", - "type": "array", - "items": { - "$ref": "Option" - } - }, - "oneofIndex": { - "description": "The index of the field type in `Type.oneofs`, for message or enumeration\ntypes. The first type has index 1; zero means the type is not in the list.", - "format": "int32", - "type": "integer" - }, - "cardinality": { - "enum": [ - "CARDINALITY_UNKNOWN", - "CARDINALITY_OPTIONAL", - "CARDINALITY_REQUIRED", - "CARDINALITY_REPEATED" - ], - "description": "The field cardinality.", - "type": "string", - "enumDescriptions": [ - "For fields with unknown cardinality.", - "For optional fields.", - "For required fields. Proto2 syntax only.", - "For repeated fields." - ] - }, - "packed": { - "description": "Whether to use alternative packed wire representation.", - "type": "boolean" - }, - "defaultValue": { - "description": "The string value of the default value of this field. Proto2 syntax only.", - "type": "string" - }, - "name": { - "description": "The field name.", - "type": "string" - }, - "typeUrl": { - "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", - "type": "string" - }, - "number": { - "description": "The field number.", - "format": "int32", - "type": "integer" - } - }, - "id": "Field", - "description": "A single field of a message type." - }, - "Monitoring": { - "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count", - "type": "object", - "properties": { - "consumerDestinations": { - "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "MonitoringDestination" - } - }, - "producerDestinations": { - "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", - "type": "array", - "items": { - "$ref": "MonitoringDestination" - } - } - }, - "id": "Monitoring" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "The set of permissions to check for the `resource`. Permissions with\nwildcards (such as '*' or 'storage.*') are not allowed. For more\ninformation see\n[IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" - }, - "Enum": { - "id": "Enum", - "description": "Enum type definition.", - "type": "object", - "properties": { - "options": { - "type": "array", - "items": { - "$ref": "Option" - }, - "description": "Protocol buffer options." - }, - "sourceContext": { - "$ref": "SourceContext", - "description": "The source context." - }, - "syntax": { - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ], - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax.", - "type": "string" - }, - "name": { - "description": "Enum type name.", - "type": "string" - }, - "enumvalue": { - "description": "Enum value definitions.", - "type": "array", - "items": { - "$ref": "EnumValue" - } - } - } } }, "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "protocol": "rest", "canonicalName": "Service Management", @@ -2382,864 +3241,5 @@ "name": "servicemanagement", "batchPath": "batch", "fullyEncodeReservedExpansion": true, - "title": "Google Service Management API", - "ownerName": "Google", - "resources": { - "services": { - "methods": { - "setIamPolicy": { - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Policy" - }, - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/services/{servicesId}:setIamPolicy", - "id": "servicemanagement.services.setIamPolicy", - "path": "v1/{+resource}:setIamPolicy" - }, - "disable": { - "id": "servicemanagement.services.disable", - "path": "v1/services/{serviceName}:disable", - "request": { - "$ref": "DisableServiceRequest" - }, - "description": "Disables a service for a project, so it can no longer be\nbe used for the project. It prevents accidental usage that may cause\nunexpected billing charges or security leaks.\n\nOperation\u003cresponse: DisableServiceResponse\u003e", - "httpMethod": "POST", - "parameterOrder": [ - "serviceName" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "serviceName": { - "required": true, - "type": "string", - "location": "path", - "description": "Name of the service to disable. Specifying an unknown service name\nwill cause the request to fail." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/services/{serviceName}:disable" - }, - "getIamPolicy": { - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Policy" - }, - "parameters": { - "resource": { - "pattern": "^services/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "flatPath": "v1/services/{servicesId}:getIamPolicy", - "id": "servicemanagement.services.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." - }, - "undelete": { - "description": "Revives a previously deleted managed service. The method restores the\nservice using the configuration at the time the service was deleted.\nThe target service must exist and must have been deleted within the\nlast 30 days.\n\nOperation\u003cresponse: UndeleteServiceResponse\u003e", - "httpMethod": "POST", - "parameterOrder": [ - "serviceName" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "serviceName": { - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/services/{serviceName}:undelete", - "id": "servicemanagement.services.undelete", - "path": "v1/services/{serviceName}:undelete" - }, - "list": { - "path": "v1/services", - "id": "servicemanagement.services.list", - "description": "Lists managed services.\n\nReturns all public services. For authenticated users, also returns all\nservices the calling user has \"servicemanagement.services.get\" permission\nfor.\n\n**BETA:** If the caller specifies the `consumer_id`, it returns only the\nservices enabled on the consumer. The `consumer_id` must have the format\nof \"project:{PROJECT-ID}\".", - "response": { - "$ref": "ListServicesResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "parameters": { - "consumerId": { - "location": "query", - "description": "Include services consumed by the specified consumer.\n\nThe Google Service Management implementation accepts the following\nforms:\n- project:\u003cproject_id\u003e", - "type": "string" - }, - "pageToken": { - "type": "string", - "location": "query", - "description": "Token identifying which result to start with; returned by a previous list\ncall." - }, - "pageSize": { - "location": "query", - "description": "Requested size of the next page of data.", - "format": "int32", - "type": "integer" - }, - "producerProjectId": { - "description": "Include services produced by the specified project.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/services" - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": {}, - "flatPath": "v1/services", - "path": "v1/services", - "id": "servicemanagement.services.create", - "description": "Creates a new managed service.\nPlease note one producer project can own no more than 20 services.\n\nOperation\u003cresponse: ManagedService\u003e", - "request": { - "$ref": "ManagedService" - } - }, - "generateConfigReport": { - "response": { - "$ref": "GenerateConfigReportResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": {}, - "flatPath": "v1/services:generateConfigReport", - "path": "v1/services:generateConfigReport", - "id": "servicemanagement.services.generateConfigReport", - "description": "Generates and returns a report (errors, warnings and changes from\nexisting configurations) associated with\nGenerateConfigReportRequest.new_value\n\nIf GenerateConfigReportRequest.old_value is specified,\nGenerateConfigReportRequest will contain a single ChangeReport based on the\ncomparison between GenerateConfigReportRequest.new_value and\nGenerateConfigReportRequest.old_value.\nIf GenerateConfigReportRequest.old_value is not specified, this method\nwill compare GenerateConfigReportRequest.new_value with the last pushed\nservice configuration.", - "request": { - "$ref": "GenerateConfigReportRequest" - } - }, - "get": { - "flatPath": "v1/services/{serviceName}", - "path": "v1/services/{serviceName}", - "id": "servicemanagement.services.get", - "description": "Gets a managed service. Authentication is required unless the service is\npublic.", - "response": { - "$ref": "ManagedService" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "GET", - "parameters": { - "serviceName": { - "location": "path", - "description": "The name of the service. See the `ServiceManager` overview for naming\nrequirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ] - }, - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "flatPath": "v1/services/{servicesId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "servicemanagement.services.testIamPermissions" - }, - "getConfig": { - "response": { - "$ref": "Service" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "GET", - "parameters": { - "view": { - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "FULL" - ], - "description": "Specifies which parts of the Service Config should be returned in the\nresponse." - }, - "serviceName": { - "location": "path", - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string" - }, - "configId": { - "type": "string", - "location": "query", - "description": "The id of the service configuration resource." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "flatPath": "v1/services/{serviceName}/config", - "path": "v1/services/{serviceName}/config", - "id": "servicemanagement.services.getConfig", - "description": "Gets a service configuration (version) for a managed service." - }, - "enable": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "POST", - "parameters": { - "serviceName": { - "description": "Name of the service to enable. Specifying an unknown service name will\ncause the request to fail.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/services/{serviceName}:enable", - "path": "v1/services/{serviceName}:enable", - "id": "servicemanagement.services.enable", - "request": { - "$ref": "EnableServiceRequest" - }, - "description": "Enables a service for a project, so it can be used\nfor the project. See\n[Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: EnableServiceResponse\u003e" - }, - "delete": { - "description": "Deletes a managed service. This method will change the service to the\n`Soft-Delete` state for 30 days. Within this period, service producers may\ncall UndeleteService to restore the service.\nAfter 30 days, the service will be permanently deleted.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": { - "serviceName": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`." - } - }, - "flatPath": "v1/services/{serviceName}", - "path": "v1/services/{serviceName}", - "id": "servicemanagement.services.delete" - } - }, - "resources": { - "consumers": { - "methods": { - "getIamPolicy": { - "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:getIamPolicy", - "id": "servicemanagement.services.consumers.getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset.", - "httpMethod": "POST", - "parameterOrder": [ - "resource" - ], - "response": { - "$ref": "Policy" - }, - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/consumers/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ] - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": { - "resource": { - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", - "required": true, - "type": "string", - "pattern": "^services/[^/]+/consumers/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "servicemanagement.services.consumers.setIamPolicy", - "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy.", - "request": { - "$ref": "SetIamPolicyRequest" - } - }, - "testIamPermissions": { - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.\n\nNote: This operation is designed to be used for building permission-aware\nUIs and command-line tools, not for authorization checking. This operation\nmay \"fail open\" without warning.", - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "required": true, - "type": "string", - "pattern": "^services/[^/]+/consumers/[^/]+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "flatPath": "v1/services/{servicesId}/consumers/{consumersId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "servicemanagement.services.consumers.testIamPermissions" - } - } - }, - "rollouts": { - "methods": { - "list": { - "flatPath": "v1/services/{serviceName}/rollouts", - "path": "v1/services/{serviceName}/rollouts", - "id": "servicemanagement.services.rollouts.list", - "description": "Lists the history of the service configuration rollouts for a managed\nservice, from the newest to the oldest.", - "response": { - "$ref": "ListServiceRolloutsResponse" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "parameters": { - "serviceName": { - "location": "path", - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string" - }, - "pageToken": { - "description": "The token of the page to retrieve.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The max number of items to include in the response list.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "Use `filter` to return subset of rollouts.\nThe following filters are supported:\n -- To limit the results to only those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'SUCCESS',\n use filter='status=SUCCESS'\n -- To limit the results to those in\n [status](google.api.servicemanagement.v1.RolloutStatus) 'CANCELLED'\n or 'FAILED', use filter='status=CANCELLED OR status=FAILED'", - "type": "string" - } - } - }, - "get": { - "flatPath": "v1/services/{serviceName}/rollouts/{rolloutId}", - "path": "v1/services/{serviceName}/rollouts/{rolloutId}", - "id": "servicemanagement.services.rollouts.get", - "description": "Gets a service configuration rollout.", - "response": { - "$ref": "Rollout" - }, - "parameterOrder": [ - "serviceName", - "rolloutId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "parameters": { - "serviceName": { - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string", - "location": "path" - }, - "rolloutId": { - "location": "path", - "description": "The id of the rollout resource.", - "required": true, - "type": "string" - } - } - }, - "create": { - "request": { - "$ref": "Rollout" - }, - "description": "Creates a new service configuration rollout. Based on rollout, the\nGoogle Service Management will roll out the service configurations to\ndifferent backend services. For example, the logging configuration will be\npushed to Google Cloud Logging.\n\nPlease note that any previous pending and running Rollouts and associated\nOperations will be automatically cancelled so that the latest Rollout will\nnot be blocked by previous Rollouts.\n\nOperation\u003cresponse: Rollout\u003e", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "POST", - "parameters": { - "serviceName": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/services/{serviceName}/rollouts", - "path": "v1/services/{serviceName}/rollouts", - "id": "servicemanagement.services.rollouts.create" - } - } - }, - "configs": { - "methods": { - "submit": { - "flatPath": "v1/services/{serviceName}/configs:submit", - "path": "v1/services/{serviceName}/configs:submit", - "id": "servicemanagement.services.configs.submit", - "description": "Creates a new service configuration (version) for a managed service based\non\nuser-supplied configuration source files (for example: OpenAPI\nSpecification). This method stores the source configurations as well as the\ngenerated service configuration. To rollout the service configuration to\nother services,\nplease call CreateServiceRollout.\n\nOperation\u003cresponse: SubmitConfigSourceResponse\u003e", - "request": { - "$ref": "SubmitConfigSourceRequest" - }, - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": { - "serviceName": { - "required": true, - "type": "string", - "location": "path", - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`." - } - } - }, - "list": { - "description": "Lists the history of the service configuration for a managed service,\nfrom the newest to the oldest.", - "response": { - "$ref": "ListServiceConfigsResponse" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "parameters": { - "serviceName": { - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string", - "location": "path" - }, - "pageToken": { - "description": "The token of the page to retrieve.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The max number of items to include in the response list.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v1/services/{serviceName}/configs", - "path": "v1/services/{serviceName}/configs", - "id": "servicemanagement.services.configs.list" - }, - "get": { - "response": { - "$ref": "Service" - }, - "parameterOrder": [ - "serviceName", - "configId" - ], - "httpMethod": "GET", - "parameters": { - "view": { - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "FULL" - ], - "description": "Specifies which parts of the Service Config should be returned in the\nresponse." - }, - "serviceName": { - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string", - "location": "path" - }, - "configId": { - "required": true, - "type": "string", - "location": "path", - "description": "The id of the service configuration resource." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only", - "https://www.googleapis.com/auth/service.management", - "https://www.googleapis.com/auth/service.management.readonly" - ], - "flatPath": "v1/services/{serviceName}/configs/{configId}", - "path": "v1/services/{serviceName}/configs/{configId}", - "id": "servicemanagement.services.configs.get", - "description": "Gets a service configuration (version) for a managed service." - }, - "create": { - "response": { - "$ref": "Service" - }, - "parameterOrder": [ - "serviceName" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": { - "serviceName": { - "description": "The name of the service. See the [overview](/service-management/overview)\nfor naming requirements. For example: `example.googleapis.com`.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/services/{serviceName}/configs", - "path": "v1/services/{serviceName}/configs", - "id": "servicemanagement.services.configs.create", - "description": "Creates a new service configuration (version) for a managed service.\nThis method only stores the service configuration. To roll out the service\nconfiguration to backend systems please call\nCreateServiceRollout.", - "request": { - "$ref": "Service" - } - } - } - } - } - }, - "operations": { - "methods": { - "list": { - "id": "servicemanagement.operations.list", - "path": "v1/operations", - "description": "Lists service operations that match the specified filter in the request.", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListOperationsResponse" - }, - "parameters": { - "name": { - "description": "Not used.", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The maximum number of operations to return. If unspecified, defaults to\n50. The maximum value is 100.", - "format": "int32", - "type": "integer" - }, - "filter": { - "location": "query", - "description": "A string for filtering Operations.\n The following filter fields are supported:\n\n * serviceName: Required. Only `=` operator is allowed.\n * startTime: The time this job was started, in ISO 8601 format.\n Allowed operators are `\u003e=`, `\u003e`, `\u003c=`, and `\u003c`.\n * status: Can be `done`, `in_progress`, or `failed`. Allowed\n operators are `=`, and `!=`.\n\n Filter expression supports conjunction (AND) and disjunction (OR)\n logical operators. However, the serviceName restriction must be at the\n top-level and can only be combined with other restrictions via the AND\n logical operator.\n\n Examples:\n\n * `serviceName={some-service}.googleapis.com`\n * `serviceName={some-service}.googleapis.com AND startTime\u003e=\"2017-02-01\"`\n * `serviceName={some-service}.googleapis.com AND status=done`\n * `serviceName={some-service}.googleapis.com AND (status=done OR startTime\u003e=\"2017-02-01\")`", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/operations" - }, - "get": { - "id": "servicemanagement.operations.get", - "path": "v1/{+name}", - "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", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "pattern": "^operations/.+$", - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/operations/{operationsId}" - } - } - } - }, - "parameters": { - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ] - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - } - }, - "version": "v1", - "baseUrl": "https://servicemanagement.googleapis.com/", - "servicePath": "", - "description": "Google Service Management allows service producers to publish their services on Google Cloud Platform so that they can be discovered and used by service consumers.", - "kind": "discovery#restDescription", - "basePath": "" + "title": "Google Service Management API" }
diff --git a/serviceuser/v1/serviceuser-api.json b/serviceuser/v1/serviceuser-api.json index 35c6160..aa01e83 100644 --- a/serviceuser/v1/serviceuser-api.json +++ b/serviceuser/v1/serviceuser-api.json
@@ -1,217 +1,246 @@ { - "discoveryVersion": "v1", - "version_module": true, - "schemas": { - "Quota": { - "properties": { - "limits": { - "description": "List of `QuotaLimit` definitions for the service.", - "type": "array", - "items": { - "$ref": "QuotaLimit" + "ownerDomain": "google.com", + "name": "serviceuser", + "batchPath": "batch", + "title": "Google Service User API", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "services": { + "methods": { + "list": { + "flatPath": "v1/projects/{projectsId}/services", + "path": "v1/{+parent}/services", + "id": "serviceuser.projects.services.list", + "description": "List enabled services for the specified consumer.", + "response": { + "$ref": "ListEnabledServicesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "parameters": { + "pageToken": { + "description": "Token identifying which result to start with; returned by a previous list\ncall.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "Requested size of the next page of data.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "location": "path", + "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + } + } + }, + "disable": { + "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e", + "request": { + "$ref": "DisableServiceRequest" + }, + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "parameters": { + "name": { + "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/services/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable", + "path": "v1/{+name}:disable", + "id": "serviceuser.projects.services.disable" + }, + "enable": { + "request": { + "$ref": "EnableServiceRequest" + }, + "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "location": "path", + "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/services/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/service.management" + ], + "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable", + "path": "v1/{+name}:enable", + "id": "serviceuser.projects.services.enable" + } } - }, - "metricRules": { - "type": "array", - "items": { - "$ref": "MetricRule" - }, - "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics." - } - }, - "id": "Quota", - "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", - "type": "object" - }, - "Step": { - "type": "object", - "properties": { - "status": { - "enum": [ - "STATUS_UNSPECIFIED", - "DONE", - "NOT_STARTED", - "IN_PROGRESS", - "FAILED", - "CANCELLED" - ], - "description": "The status code.", - "type": "string", - "enumDescriptions": [ - "Unspecifed code.", - "The operation or step has completed without errors.", - "The operation or step has not started yet.", - "The operation or step is in progress.", - "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.", - "The operation or step has completed with cancellation." - ] - }, - "description": { - "description": "The short description of the step.", - "type": "string" - } - }, - "id": "Step", - "description": "Represents the status of one operation step." - }, - "LoggingDestination": { - "properties": { - "monitoredResource": { - "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.", - "type": "string" - }, - "logs": { - "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "LoggingDestination", - "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", - "type": "object" - }, - "Option": { - "id": "Option", - "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", - "type": "object", - "properties": { - "name": { - "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.", - "type": "string" - }, - "value": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.", - "type": "object" } } }, - "Logging": { - "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history", - "type": "object", - "properties": { - "consumerDestinations": { - "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "LoggingDestination" - } - }, - "producerDestinations": { - "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.", - "type": "array", - "items": { - "$ref": "LoggingDestination" - } - } - }, - "id": "Logging" - }, - "Method": { - "description": "Method represents a method of an API interface.", - "type": "object", - "properties": { - "responseStreaming": { - "description": "If true, the response is streamed.", - "type": "boolean" - }, - "name": { - "description": "The simple name of this method.", - "type": "string" - }, - "requestTypeUrl": { - "description": "A URL of the input message type.", - "type": "string" - }, - "requestStreaming": { - "description": "If true, the request is streamed.", - "type": "boolean" - }, - "syntax": { - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ], - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax of this method.", - "type": "string" - }, - "responseTypeUrl": { - "description": "The URL of the output message type.", - "type": "string" - }, - "options": { - "description": "Any metadata attached to the method.", - "type": "array", - "items": { - "$ref": "Option" - } - } - }, - "id": "Method" - }, - "QuotaLimit": { - "type": "object", - "properties": { - "description": { - "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).", - "type": "string" - }, - "metric": { - "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.", - "type": "string" - }, - "displayName": { - "type": "string", - "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration." - }, - "values": { - "additionalProperties": { - "format": "int64", - "type": "string" + "services": { + "methods": { + "search": { + "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for.", + "response": { + "$ref": "SearchServicesResponse" }, - "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.", - "type": "object" - }, - "unit": { - "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.", - "type": "string" - }, - "maxLimit": { - "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "name": { - "type": "string", - "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters." - }, - "duration": { - "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.", - "type": "string" - }, - "freeTier": { - "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" - }, - "defaultLimit": { - "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.", - "format": "int64", - "type": "string" + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "pageToken": { + "description": "Token identifying which result to start with; returned by a previous list\ncall.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Requested size of the next page of data.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], + "flatPath": "v1/services:search", + "path": "v1/services:search", + "id": "serviceuser.services.search" } - }, - "id": "QuotaLimit", - "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`." + } + } + }, + "parameters": { + "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.", + "type": "string", + "location": "query" }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + } + }, + "version": "v1", + "baseUrl": "https://serviceuser.googleapis.com/", + "servicePath": "", + "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", + "kind": "discovery#restDescription", + "basePath": "", + "revision": "20171229", + "documentationLink": "https://cloud.google.com/service-management/", + "id": "serviceuser:v1", + "discoveryVersion": "v1", + "version_module": true, + "schemas": { "Mixin": { "description": "Declares an API Interface to be included in this interface. The including\ninterface must redeclare all the methods from the included interface, but\ndocumentation and options are inherited as follows:\n\n- If after comment and whitespace stripping, the documentation\n string of the redeclared method is empty, it will be inherited\n from the original method.\n\n- Each annotation belonging to the service config (http,\n visibility) which is not set in the redeclared method will be\n inherited.\n\n- If an http annotation is inherited, the path pattern will be\n modified as follows. Any version prefix will be replaced by the\n version of the including interface plus the root path if\n specified.\n\nExample of a simple mixin:\n\n package google.acl.v1;\n service AccessControl {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v1/{resource=**}:getAcl\";\n }\n }\n\n package google.storage.v2;\n service Storage {\n // rpc GetAcl(GetAclRequest) returns (Acl);\n\n // Get a data record.\n rpc GetData(GetDataRequest) returns (Data) {\n option (google.api.http).get = \"/v2/{resource=**}\";\n }\n }\n\nExample of a mixin configuration:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n\nThe mixin construct implies that all methods in `AccessControl` are\nalso declared with same name and request/response types in\n`Storage`. A documentation generator or annotation processor will\nsee the effective `Storage.GetAcl` method after inherting\ndocumentation and annotations as follows:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/{resource=**}:getAcl\";\n }\n ...\n }\n\nNote how the version in the path pattern changed from `v1` to `v2`.\n\nIf the `root` field in the mixin is specified, it should be a\nrelative path under which inherited HTTP paths are placed. Example:\n\n apis:\n - name: google.storage.v2.Storage\n mixins:\n - name: google.acl.v1.AccessControl\n root: acls\n\nThis implies the following inherited HTTP annotation:\n\n service Storage {\n // Get the underlying ACL object.\n rpc GetAcl(GetAclRequest) returns (Acl) {\n option (google.api.http).get = \"/v2/acls/{resource=**}:getAcl\";\n }\n ...\n }", "type": "object", @@ -228,13 +257,15 @@ "id": "Mixin" }, "CustomError": { + "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError", + "type": "object", "properties": { "types": { + "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'.", "type": "array", "items": { "type": "string" - }, - "description": "The list of custom error detail types, e.g. 'google.foo.v1.CustomError'." + } }, "rules": { "description": "The list of custom error rules that apply to individual API messages.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", @@ -244,9 +275,7 @@ } } }, - "id": "CustomError", - "description": "Customize service error responses. For example, list any service\nspecific protobuf types that can appear in error detail lists of\nerror responses.\n\nExample:\n\n custom_error:\n types:\n - google.foo.v1.CustomError\n - google.foo.v1.AnotherError", - "type": "object" + "id": "CustomError" }, "Http": { "description": "Defines the HTTP configuration for an API service. It contains a list of\nHttpRule, each specifying the mapping of an RPC method\nto one or more HTTP REST API methods.", @@ -267,22 +296,22 @@ "id": "Http" }, "SourceInfo": { + "description": "Source information used to create a Service Config", + "type": "object", "properties": { "sourceFiles": { "description": "All files used during config generation.", "type": "array", "items": { + "type": "object", "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "type": "object" + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } } } }, - "id": "SourceInfo", - "description": "Source information used to create a Service Config", - "type": "object" + "id": "SourceInfo" }, "Control": { "description": "Selects and configures the service controller used by the service. The\nservice controller handles features like abuse, quota, billing, logging,\nmonitoring, etc.", @@ -296,8 +325,13 @@ "id": "Control" }, "SystemParameter": { + "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent.", "type": "object", "properties": { + "httpHeader": { + "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.", + "type": "string" + }, "name": { "description": "Define the name of the parameter, such as \"api_key\" . It is case sensitive.", "type": "string" @@ -305,28 +339,39 @@ "urlQueryParameter": { "description": "Define the URL query parameter name to use for the parameter. It is case\nsensitive.", "type": "string" - }, - "httpHeader": { - "description": "Define the HTTP header name to use for the parameter. It is case\ninsensitive.", - "type": "string" } }, - "id": "SystemParameter", - "description": "Define a parameter's name and location. The parameter may be passed as either\nan HTTP header or a URL query parameter, and if both are passed the behavior\nis implementation-dependent." + "id": "SystemParameter" + }, + "Monitoring": { + "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count", + "type": "object", + "properties": { + "consumerDestinations": { + "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "MonitoringDestination" + } + }, + "producerDestinations": { + "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", + "type": "array", + "items": { + "$ref": "MonitoringDestination" + } + } + }, + "id": "Monitoring" }, "Field": { "description": "A single field of a message type.", "type": "object", "properties": { - "typeUrl": { - "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", + "jsonName": { + "description": "The field JSON name.", "type": "string" }, - "number": { - "description": "The field number.", - "format": "int32", - "type": "integer" - }, "kind": { "enumDescriptions": [ "Field type unknown.", @@ -373,10 +418,6 @@ "description": "The field type.", "type": "string" }, - "jsonName": { - "description": "The field JSON name.", - "type": "string" - }, "options": { "description": "The protocol buffer options.", "type": "array", @@ -390,6 +431,8 @@ "type": "integer" }, "cardinality": { + "description": "The field cardinality.", + "type": "string", "enumDescriptions": [ "For fields with unknown cardinality.", "For optional fields.", @@ -401,9 +444,7 @@ "CARDINALITY_OPTIONAL", "CARDINALITY_REQUIRED", "CARDINALITY_REPEATED" - ], - "description": "The field cardinality.", - "type": "string" + ] }, "packed": { "description": "Whether to use alternative packed wire representation.", @@ -416,33 +457,20 @@ "name": { "description": "The field name.", "type": "string" + }, + "typeUrl": { + "description": "The field type URL, without the scheme, for message or enumeration\ntypes. Example: `\"type.googleapis.com/google.protobuf.Timestamp\"`.", + "type": "string" + }, + "number": { + "description": "The field number.", + "format": "int32", + "type": "integer" } }, "id": "Field" }, - "Monitoring": { - "description": "Monitoring configuration of the service.\n\nThe example below shows how to configure monitored resources and metrics\nfor monitoring. In the example, a monitored resource and two metrics are\ndefined. The `library.googleapis.com/book/returned_count` metric is sent\nto both producer and consumer projects, whereas the\n`library.googleapis.com/book/overdue_count` metric is only sent to the\nconsumer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/returned_count\n metric_kind: DELTA\n value_type: INT64\n labels:\n - key: /customer_id\n - name: library.googleapis.com/book/overdue_count\n metric_kind: GAUGE\n value_type: INT64\n labels:\n - key: /customer_id\n monitoring:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/returned_count\n - library.googleapis.com/book/overdue_count", - "type": "object", - "properties": { - "consumerDestinations": { - "description": "Monitoring configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "MonitoringDestination" - } - }, - "producerDestinations": { - "description": "Monitoring configurations for sending metrics to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A metric can be used in at most\none producer destination.", - "type": "array", - "items": { - "$ref": "MonitoringDestination" - } - } - }, - "id": "Monitoring" - }, "Enum": { - "id": "Enum", "description": "Enum type definition.", "type": "object", "properties": { @@ -469,6 +497,8 @@ "description": "The source context." }, "syntax": { + "description": "The source syntax.", + "type": "string", "enumDescriptions": [ "Syntax `proto2`.", "Syntax `proto3`." @@ -476,11 +506,16 @@ "enum": [ "SYNTAX_PROTO2", "SYNTAX_PROTO3" - ], - "description": "The source syntax.", - "type": "string" + ] } - } + }, + "id": "Enum" + }, + "EnableServiceRequest": { + "description": "Request message for EnableService method.", + "type": "object", + "properties": {}, + "id": "EnableServiceRequest" }, "LabelDescriptor": { "description": "A description of a label.", @@ -495,32 +530,49 @@ "type": "string" }, "valueType": { + "enumDescriptions": [ + "A variable-length string. This is the default.", + "Boolean; true or false.", + "A 64-bit signed integer." + ], "enum": [ "STRING", "BOOL", "INT64" ], "description": "The type of data that can be assigned to the label.", - "type": "string", - "enumDescriptions": [ - "A variable-length string. This is the default.", - "Boolean; true or false.", - "A 64-bit signed integer." - ] + "type": "string" } }, "id": "LabelDescriptor" }, - "EnableServiceRequest": { - "id": "EnableServiceRequest", - "description": "Request message for EnableService method.", - "type": "object", - "properties": {} - }, "Type": { "description": "A protocol buffer message type.", "type": "object", "properties": { + "oneofs": { + "description": "The list of types appearing in `oneof` definitions in this type.", + "type": "array", + "items": { + "type": "string" + } + }, + "syntax": { + "description": "The source syntax.", + "type": "string", + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ] + }, + "sourceContext": { + "$ref": "SourceContext", + "description": "The source context." + }, "options": { "description": "The protocol buffer options.", "type": "array", @@ -538,34 +590,12 @@ "name": { "description": "The fully qualified message name.", "type": "string" - }, - "oneofs": { - "description": "The list of types appearing in `oneof` definitions in this type.", - "type": "array", - "items": { - "type": "string" - } - }, - "syntax": { - "enum": [ - "SYNTAX_PROTO2", - "SYNTAX_PROTO3" - ], - "description": "The source syntax.", - "type": "string", - "enumDescriptions": [ - "Syntax `proto2`.", - "Syntax `proto3`." - ] - }, - "sourceContext": { - "$ref": "SourceContext", - "description": "The source context." } }, "id": "Type" }, "Experimental": { + "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users.", "type": "object", "properties": { "authorization": { @@ -573,8 +603,7 @@ "$ref": "AuthorizationConfig" } }, - "id": "Experimental", - "description": "Experimental service configuration. These configuration options can\nonly be used by whitelisted users." + "id": "Experimental" }, "Backend": { "description": "`Backend` defines the backend configuration for a service.", @@ -590,25 +619,6 @@ }, "id": "Backend" }, - "DocumentationRule": { - "description": "A documentation rule provides information about individual API elements.", - "type": "object", - "properties": { - "selector": { - "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.", - "type": "string" - }, - "description": { - "description": "Description of the selected API(s).", - "type": "string" - }, - "deprecationDescription": { - "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.", - "type": "string" - } - }, - "id": "DocumentationRule" - }, "AuthorizationConfig": { "description": "Configuration of authorization.\n\nThis section determines the authorization provider, if unspecified, then no\nauthorization check will be done.\n\nExample:\n\n experimental:\n authorization:\n provider: firebaserules.googleapis.com", "type": "object", @@ -620,13 +630,29 @@ }, "id": "AuthorizationConfig" }, - "ContextRule": { + "DocumentationRule": { + "description": "A documentation rule provides information about individual API elements.", "type": "object", "properties": { - "selector": { - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "description": { + "description": "Description of the selected API(s).", "type": "string" }, + "deprecationDescription": { + "description": "Deprecation description of the selected element(s). It can be provided if an\nelement is marked as `deprecated`.", + "type": "string" + }, + "selector": { + "description": "The selector is a comma-separated list of patterns. Each pattern is a\nqualified name of the element which may end in \"*\", indicating a wildcard.\nWildcards are only allowed at the end and for a whole component of the\nqualified name, i.e. \"foo.*\" is ok, but not \"foo.b*\" or \"foo.*.bar\". To\nspecify a default for all applicable elements, the whole pattern \"*\"\nis used.", + "type": "string" + } + }, + "id": "DocumentationRule" + }, + "ContextRule": { + "description": "A context rule provides information about the context for an individual API\nelement.", + "type": "object", + "properties": { "provided": { "description": "A list of full type names of provided contexts.", "type": "array", @@ -640,29 +666,41 @@ "items": { "type": "string" } + }, + "selector": { + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" } }, - "id": "ContextRule", - "description": "A context rule provides information about the context for an individual API\nelement." + "id": "ContextRule" }, - "Billing": { - "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", + "SourceContext": { + "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.", "type": "object", "properties": { - "consumerDestinations": { - "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.", - "type": "array", - "items": { - "$ref": "BillingDestination" - } + "fileName": { + "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.", + "type": "string" } }, - "id": "Billing" + "id": "SourceContext" }, "MetricDescriptor": { "description": "Defines a metric type and its schema. Once a metric descriptor is created,\ndeleting or altering it stops data collection and makes the metric type's\nexisting data unusable.", "type": "object", "properties": { + "displayName": { + "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota.", + "type": "string" + }, + "description": { + "description": "A detailed description of the metric, which can be used in documentation.", + "type": "string" + }, + "unit": { + "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.", + "type": "string" + }, "labels": { "description": "The set of labels that can be used to describe a specific\ninstance of this metric type. For example, the\n`appengine.googleapis.com/http/server/response_latencies` metric\ntype has a label for the HTTP response code, `response_code`, so\nyou can look at latencies for successful responses or just\nfor responses that failed.", "type": "array", @@ -679,6 +717,8 @@ "type": "string" }, "valueType": { + "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", + "type": "string", "enumDescriptions": [ "Do not use this default value.", "The value is a boolean.\nThis value type can be used only if the metric kind is `GAUGE`.", @@ -696,9 +736,7 @@ "STRING", "DISTRIBUTION", "MONEY" - ], - "description": "Whether the measurement is an integer, a floating-point number, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", - "type": "string" + ] }, "metricKind": { "enumDescriptions": [ @@ -715,65 +753,23 @@ ], "description": "Whether the metric records instantaneous values, changes to a value, etc.\nSome combinations of `metric_kind` and `value_type` might not be supported.", "type": "string" - }, - "displayName": { - "description": "A concise name for the metric, which can be displayed in user interfaces.\nUse sentence case without an ending period, for example \"Request count\".\nThis field is optional but it is recommended to be set for any metrics\nassociated with user-visible concepts, such as Quota.", - "type": "string" - }, - "description": { - "description": "A detailed description of the metric, which can be used in documentation.", - "type": "string" - }, - "unit": { - "description": "The unit in which the metric value is reported. It is only applicable\nif the `value_type` is `INT64`, `DOUBLE`, or `DISTRIBUTION`. The\nsupported units are a subset of [The Unified Code for Units of\nMeasure](http://unitsofmeasure.org/ucum.html) standard:\n\n**Basic units (UNIT)**\n\n* `bit` bit\n* `By` byte\n* `s` second\n* `min` minute\n* `h` hour\n* `d` day\n\n**Prefixes (PREFIX)**\n\n* `k` kilo (10**3)\n* `M` mega (10**6)\n* `G` giga (10**9)\n* `T` tera (10**12)\n* `P` peta (10**15)\n* `E` exa (10**18)\n* `Z` zetta (10**21)\n* `Y` yotta (10**24)\n* `m` milli (10**-3)\n* `u` micro (10**-6)\n* `n` nano (10**-9)\n* `p` pico (10**-12)\n* `f` femto (10**-15)\n* `a` atto (10**-18)\n* `z` zepto (10**-21)\n* `y` yocto (10**-24)\n* `Ki` kibi (2**10)\n* `Mi` mebi (2**20)\n* `Gi` gibi (2**30)\n* `Ti` tebi (2**40)\n\n**Grammar**\n\nThe grammar includes the dimensionless unit `1`, such as `1/s`.\n\nThe grammar also includes these connectors:\n\n* `/` division (as an infix operator, e.g. `1/s`).\n* `.` multiplication (as an infix operator, e.g. `GBy.d`)\n\nThe grammar for a unit is as follows:\n\n Expression = Component { \".\" Component } { \"/\" Component } ;\n\n Component = [ PREFIX ] UNIT [ Annotation ]\n | Annotation\n | \"1\"\n ;\n\n Annotation = \"{\" NAME \"}\" ;\n\nNotes:\n\n* `Annotation` is just a comment if it follows a `UNIT` and is\n equivalent to `1` if it is used alone. For examples,\n `{requests}/s == 1/s`, `By{transmitted}/s == By/s`.\n* `NAME` is a sequence of non-blank printable ASCII characters not\n containing '{' or '}'.", - "type": "string" } }, "id": "MetricDescriptor" }, - "SourceContext": { - "description": "`SourceContext` represents information about the source of a\nprotobuf element, like the file in which it is defined.", + "Billing": { + "description": "Billing related configuration of the service.\n\nThe following example shows how to configure monitored resources and metrics\nfor billing:\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n metrics:\n - name: library.googleapis.com/book/borrowed_count\n metric_kind: DELTA\n value_type: INT64\n billing:\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n metrics:\n - library.googleapis.com/book/borrowed_count", "type": "object", "properties": { - "fileName": { - "description": "The path-qualified name of the .proto file that contained the associated\nprotobuf element. For example: `\"google/protobuf/source_context.proto\"`.", - "type": "string" - } - }, - "id": "SourceContext" - }, - "Endpoint": { - "type": "object", - "properties": { - "name": { - "description": "The canonical name of this endpoint.", - "type": "string" - }, - "target": { - "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".", - "type": "string" - }, - "aliases": { + "consumerDestinations": { + "description": "Billing configurations for sending metrics to the consumer project.\nThere can be multiple consumer destinations per service, each one must have\na different monitored resource type. A metric can be used in at most\none consumer destination.", "type": "array", "items": { - "type": "string" - }, - "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on." - }, - "features": { - "description": "The list of features enabled on this endpoint.", - "type": "array", - "items": { - "type": "string" + "$ref": "BillingDestination" } - }, - "allowCors": { - "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.", - "type": "boolean" } }, - "id": "Endpoint", - "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true" + "id": "Billing" }, "ListEnabledServicesResponse": { "description": "Response message for `ListEnabledServices` method.", @@ -793,6 +789,39 @@ }, "id": "ListEnabledServicesResponse" }, + "Endpoint": { + "description": "`Endpoint` describes a network endpoint that serves a set of APIs.\nA service may expose any number of endpoints, and all endpoints share the\nsame service configuration, such as quota configuration and monitoring\nconfiguration.\n\nExample service configuration:\n\n name: library-example.googleapis.com\n endpoints:\n # Below entry makes 'google.example.library.v1.Library'\n # API be served from endpoint address library-example.googleapis.com.\n # It also allows HTTP OPTIONS calls to be passed to the backend, for\n # it to decide whether the subsequent cross-origin request is\n # allowed to proceed.\n - name: library-example.googleapis.com\n allow_cors: true", + "type": "object", + "properties": { + "aliases": { + "description": "DEPRECATED: This field is no longer supported. Instead of using aliases,\nplease specify multiple google.api.Endpoint for each of the intended\naliases.\n\nAdditional names that this endpoint will be hosted on.", + "type": "array", + "items": { + "type": "string" + } + }, + "features": { + "description": "The list of features enabled on this endpoint.", + "type": "array", + "items": { + "type": "string" + } + }, + "allowCors": { + "description": "Allowing\n[CORS](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing), aka\ncross-domain traffic, would allow the backends served from this endpoint to\nreceive and respond to HTTP OPTIONS requests. The response will be used by\nthe browser to determine whether the subsequent cross-origin request is\nallowed to proceed.", + "type": "boolean" + }, + "name": { + "description": "The canonical name of this endpoint.", + "type": "string" + }, + "target": { + "description": "The specification of an Internet routable address of API frontend that will\nhandle requests to this [API Endpoint](https://cloud.google.com/apis/design/glossary).\nIt should be either a valid IPv4 address or a fully-qualified domain name.\nFor example, \"8.8.8.8\" or \"myservice.appspot.com\".", + "type": "string" + } + }, + "id": "Endpoint" + }, "OAuthRequirements": { "description": "OAuth scopes are a way to define data and permissions on data. For example,\nthere are scopes defined for \"Read-only access to Google Calendar\" and\n\"Access to Cloud Platform\". Users can consent to a scope for an application,\ngiving it permission to access that data on their behalf.\n\nOAuth scope specifications should be fairly coarse grained; a user will need\nto see and understand the text description of what your scope means.\n\nIn most cases: use one or at most two OAuth scopes for an entire family of\nproducts. If your product has multiple APIs, you should probably be sharing\nthe OAuth scope across all of those APIs.\n\nWhen you need finer grained OAuth consent screens: talk with your product\nmanagement about how developers will use them in practice.\n\nPlease note that even though each of the canonical scopes is enough for a\nrequest to be accepted and passed to the backend, a request can still fail\ndue to the backend requiring additional scopes or permissions.", "type": "object", @@ -808,9 +837,16 @@ "description": "Configuration controlling usage of a service.", "type": "object", "properties": { + "requirements": { + "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'.", + "type": "array", + "items": { + "type": "string" + } + }, "producerNotificationChannel": { - "type": "string", - "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview." + "description": "The full resource name of a channel used for sending notifications to the\nservice producer.\n\nGoogle Service Management currently only supports\n[Google Cloud Pub/Sub](https://cloud.google.com/pubsub) as a notification\nchannel. To use Google Cloud Pub/Sub as the channel, this must be the name\nof a Cloud Pub/Sub topic that uses the Cloud Pub/Sub topic name format\ndocumented in https://cloud.google.com/pubsub/docs/overview.", + "type": "string" }, "rules": { "description": "A list of usage rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", @@ -818,19 +854,11 @@ "items": { "$ref": "UsageRule" } - }, - "requirements": { - "type": "array", - "items": { - "type": "string" - }, - "description": "Requirements that must be satisfied before a consumer project can use the\nservice. Each requirement is of the form \u003cservice.name\u003e/\u003crequirement-id\u003e;\nfor example 'serviceusage.googleapis.com/billing-enabled'." } }, "id": "Usage" }, "Context": { - "id": "Context", "description": "`Context` defines which contexts an API requests.\n\nExample:\n\n context:\n rules:\n - selector: \"*\"\n requested:\n - google.rpc.context.ProjectContext\n - google.rpc.context.OriginContext\n\nThe above specifies that all methods in the API request\n`google.rpc.context.ProjectContext` and\n`google.rpc.context.OriginContext`.\n\nAvailable context types are defined in package\n`google.rpc.context`.", "type": "object", "properties": { @@ -841,12 +869,20 @@ "$ref": "ContextRule" } } - } + }, + "id": "Context" }, "LogDescriptor": { "description": "A description of a log type. Example in YAML format:\n\n - name: library.googleapis.com/activity_history\n description: The history of borrowing and returning library items.\n display_name: Activity\n labels:\n - key: /customer_id\n description: Identifier of a library customer", "type": "object", "properties": { + "labels": { + "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + }, "name": { "description": "The name of the log. It must be less than 512 characters long and can\ninclude the following characters: upper- and lower-case alphanumeric\ncharacters [A-Za-z0-9], and punctuation characters including\nslash, underscore, hyphen, period [/_-.].", "type": "string" @@ -858,36 +894,21 @@ "displayName": { "description": "The human-readable name for this log. This information appears on\nthe user interface and should be concise.", "type": "string" - }, - "labels": { - "description": "The set of labels that are available to describe a specific log entry.\nRuntime requests that contain labels not specified here are\nconsidered invalid.", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } } }, "id": "LogDescriptor" }, - "CustomErrorRule": { - "properties": { - "selector": { - "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "isErrorType": { - "type": "boolean", - "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload." - } - }, - "id": "CustomErrorRule", - "description": "A custom error rule.", - "type": "object" - }, "MonitoredResourceDescriptor": { "description": "An object that describes the schema of a MonitoredResource object using a\ntype name and a set of labels. For example, the monitored resource\ndescriptor for Google Compute Engine VM instances has a type of\n`\"gce_instance\"` and specifies the use of the labels `\"instance_id\"` and\n`\"zone\"` to identify particular VM instances.\n\nDifferent APIs can support different monitored resource types. APIs generally\nprovide a `list` method that returns the monitored resource descriptors used\nby the API.", "type": "object", "properties": { + "labels": { + "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.", + "type": "array", + "items": { + "$ref": "LabelDescriptor" + } + }, "name": { "description": "Optional. The resource name of the monitored resource descriptor:\n`\"projects/{project_id}/monitoredResourceDescriptors/{type}\"` where\n{type} is the value of the `type` field in this object and\n{project_id} is a project ID that provides API-specific context for\naccessing the type. APIs that do not use project information can use the\nresource name format `\"monitoredResourceDescriptors/{type}\"`.", "type": "string" @@ -903,17 +924,36 @@ "type": { "description": "Required. The monitored resource type. For example, the type\n`\"cloudsql_database\"` represents databases in Google Cloud SQL.\nThe maximum length of this value is 256 characters.", "type": "string" - }, - "labels": { - "description": "Required. A set of labels used to describe instances of this monitored\nresource type. For example, an individual Google Cloud SQL database is\nidentified by values for the labels `\"database_id\"` and `\"zone\"`.", - "type": "array", - "items": { - "$ref": "LabelDescriptor" - } } }, "id": "MonitoredResourceDescriptor" }, + "CustomErrorRule": { + "description": "A custom error rule.", + "type": "object", + "properties": { + "isErrorType": { + "description": "Mark this message as possible payload in error response. Otherwise,\nobjects of this type will be filtered when they appear in error payload.", + "type": "boolean" + }, + "selector": { + "description": "Selects messages to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + } + }, + "id": "CustomErrorRule" + }, + "CustomAuthRequirements": { + "description": "Configuration for a custom authentication provider.", + "type": "object", + "properties": { + "provider": { + "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).", + "type": "string" + } + }, + "id": "CustomAuthRequirements" + }, "MediaDownload": { "description": "Defines the Media configuration for a service in case of a download.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", "type": "object", @@ -930,15 +970,15 @@ "description": "A boolean that determines whether a notification for the completion of a\ndownload should be sent to the backend.", "type": "boolean" }, + "maxDirectDownloadSize": { + "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.", + "format": "int64", + "type": "string" + }, "dropzone": { "description": "Name of the Scotty dropzone to use for the current API.", "type": "string" }, - "maxDirectDownloadSize": { - "type": "string", - "description": "Optional maximum acceptable size for direct download.\nThe size is specified in bytes.", - "format": "int64" - }, "useDirectDownload": { "description": "A boolean that determines if direct download from ESF should be used for\ndownload of this media.", "type": "boolean" @@ -946,17 +986,6 @@ }, "id": "MediaDownload" }, - "CustomAuthRequirements": { - "type": "object", - "properties": { - "provider": { - "description": "A configuration string containing connection information for the\nauthentication provider, typically formatted as a SmartService string\n(go/smartservice).", - "type": "string" - } - }, - "id": "CustomAuthRequirements", - "description": "Configuration for a custom authentication provider." - }, "DisableServiceRequest": { "description": "Request message for DisableService method.", "type": "object", @@ -964,6 +993,8 @@ "id": "DisableServiceRequest" }, "SearchServicesResponse": { + "description": "Response message for SearchServices method.", + "type": "object", "properties": { "services": { "description": "Services available publicly or available to the authenticated caller.", @@ -977,14 +1008,20 @@ "type": "string" } }, - "id": "SearchServicesResponse", - "description": "Response message for SearchServices method.", - "type": "object" + "id": "SearchServicesResponse" }, "MediaUpload": { "description": "Defines the Media configuration for a service in case of an upload.\nUse this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead [][google.bytestream.RestByteStream] as an API to\nyour configuration for Bytestream methods.", "type": "object", "properties": { + "startNotification": { + "description": "Whether to receive a notification on the start of media upload.", + "type": "boolean" + }, + "uploadService": { + "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.", + "type": "string" + }, "mimeTypes": { "description": "An array of mimetype patterns. Esf will only accept uploads that match one\nof the given patterns.", "type": "array", @@ -997,34 +1034,28 @@ "format": "int64", "type": "string" }, - "completeNotification": { - "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.", + "enabled": { + "description": "Whether upload is enabled.", "type": "boolean" }, "progressNotification": { "description": "Whether to receive a notification for progress changes of media upload.", "type": "boolean" }, - "enabled": { - "description": "Whether upload is enabled.", + "completeNotification": { + "description": "A boolean that determines whether a notification for the completion of an\nupload should be sent to the backend. These notifications will not be seen\nby the client and will not consume quota.", "type": "boolean" }, "dropzone": { "description": "Name of the Scotty dropzone to use for the current API.", "type": "string" - }, - "startNotification": { - "description": "Whether to receive a notification on the start of media upload.", - "type": "boolean" - }, - "uploadService": { - "description": "DO NOT USE FIELDS BELOW THIS LINE UNTIL THIS WARNING IS REMOVED.\n\nSpecify name of the upload service if one is used for upload.", - "type": "string" } }, "id": "MediaUpload" }, "BillingDestination": { + "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).", + "type": "object", "properties": { "monitoredResource": { "description": "The monitored resource type. The type must be defined in\nService.monitored_resources section.", @@ -1038,11 +1069,11 @@ } } }, - "id": "BillingDestination", - "description": "Configuration of a specific billing destination (Currently only support\nbill against consumer project).", - "type": "object" + "id": "BillingDestination" }, "UsageRule": { + "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true", + "type": "object", "properties": { "selector": { "description": "Selects the methods to which this rule applies. Use '*' to indicate all\nmethods in all APIs.\n\nRefer to selector for syntax details.", @@ -1057,26 +1088,26 @@ "type": "boolean" } }, - "id": "UsageRule", - "description": "Usage configuration rules for the service.\n\nNOTE: Under development.\n\n\nUse this rule to configure unregistered calls for the service. Unregistered\ncalls are calls that do not contain consumer project identity.\n(Example: calls that do not contain an API key).\nBy default, API methods do not allow unregistered calls, and each method call\nmust be identified by a consumer project identity. Use this rule to\nallow/disallow unregistered calls.\n\nExample of an API that wants to allow unregistered calls for entire service.\n\n usage:\n rules:\n - selector: \"*\"\n allow_unregistered_calls: true\n\nExample of a method that wants to allow unregistered calls.\n\n usage:\n rules:\n - selector: \"google.example.library.v1.LibraryService.CreateBook\"\n allow_unregistered_calls: true", - "type": "object" + "id": "UsageRule" }, "AuthRequirement": { "description": "User-defined authentication requirements, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", "type": "object", "properties": { - "audiences": { - "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", - "type": "string" - }, "providerId": { "description": "id from authentication provider.\n\nExample:\n\n provider_id: bookstore_auth", "type": "string" + }, + "audiences": { + "description": "NOTE: This will be deprecated soon, once AuthProvider.audiences is\nimplemented and accepted in all the runtime components.\n\nThe list of JWT\n[audiences](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32#section-4.1.3).\nthat are allowed to access. A JWT containing any of these audiences will\nbe accepted. When this setting is absent, only JWTs with audience\n\"https://Service_name/API_name\"\nwill be accepted. For example, if no audiences are in the setting,\nLibraryService API will only accept JWTs with the following audience\n\"https://library-example.googleapis.com/google.example.library.v1.LibraryService\".\n\nExample:\n\n audiences: bookstore_android.apps.googleusercontent.com,\n bookstore_web.apps.googleusercontent.com", + "type": "string" } }, "id": "AuthRequirement" }, "Documentation": { + "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.", + "type": "object", "properties": { "summary": { "description": "A short summary of what the service does. Can only be provided by\nplain text.", @@ -1098,18 +1129,17 @@ "type": "string" }, "pages": { + "description": "The top level pages for the documentation set.", "type": "array", "items": { "$ref": "Page" - }, - "description": "The top level pages for the documentation set." + } } }, - "id": "Documentation", - "description": "`Documentation` provides the information for describing a service.\n\nExample:\n\u003cpre\u003e\u003ccode\u003edocumentation:\n summary: \u003e\n The Google Calendar API gives access\n to most calendar features.\n pages:\n - name: Overview\n content: (== include google/foo/overview.md ==)\n - name: Tutorial\n content: (== include google/foo/tutorial.md ==)\n subpages;\n - name: Java\n content: (== include google/foo/tutorial_java.md ==)\n rules:\n - selector: google.calendar.Calendar.Get\n description: \u003e\n ...\n - selector: google.calendar.Calendar.Put\n description: \u003e\n ...\n\u003c/code\u003e\u003c/pre\u003e\nDocumentation is provided in markdown syntax. In addition to\nstandard markdown features, definition lists, tables and fenced\ncode blocks are supported. Section headers can be provided and are\ninterpreted relative to the section nesting of the context where\na documentation fragment is embedded.\n\nDocumentation from the IDL is merged with documentation defined\nvia the config at normalization time, where documentation provided\nby config rules overrides IDL provided.\n\nA number of constructs specific to the API platform are supported\nin documentation text.\n\nIn order to reference a proto element, the following\nnotation can be used:\n\u003cpre\u003e\u003ccode\u003e[fully.qualified.proto.name][]\u003c/code\u003e\u003c/pre\u003e\nTo override the display text used for the link, this can be used:\n\u003cpre\u003e\u003ccode\u003e[display text][fully.qualified.proto.name]\u003c/code\u003e\u003c/pre\u003e\nText can be excluded from doc using the following notation:\n\u003cpre\u003e\u003ccode\u003e(-- internal comment --)\u003c/code\u003e\u003c/pre\u003e\nComments can be made conditional using a visibility label. The below\ntext will be only rendered if the `BETA` label is available:\n\u003cpre\u003e\u003ccode\u003e(--BETA: comment for BETA users --)\u003c/code\u003e\u003c/pre\u003e\nA few directives are available in documentation. Note that\ndirectives must appear on a single line to be properly\nidentified. The `include` directive includes a markdown file from\nan external source:\n\u003cpre\u003e\u003ccode\u003e(== include path/to/file ==)\u003c/code\u003e\u003c/pre\u003e\nThe `resource_for` directive marks a message to be the resource of\na collection in REST view. If it is not specified, tools attempt\nto infer the resource from the operations in a collection:\n\u003cpre\u003e\u003ccode\u003e(== resource_for v1.shelves.books ==)\u003c/code\u003e\u003c/pre\u003e\nThe directive `suppress_warning` does not directly affect documentation\nand is documented together with service config validation.", - "type": "object" + "id": "Documentation" }, "AuthenticationRule": { + "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored.", "type": "object", "properties": { "requirements": { @@ -1136,21 +1166,12 @@ "$ref": "CustomAuthRequirements" } }, - "id": "AuthenticationRule", - "description": "Authentication rules for the service.\n\nBy default, if a method has any authentication requirements, every request\nmust include a valid credential matching one of the requirements.\nIt's an error to include more than one kind of credential in a single\nrequest.\n\nIf a method doesn't have any auth requirements, request credentials will be\nignored." + "id": "AuthenticationRule" }, "BackendRule": { + "description": "A backend rule provides configuration for an individual API element.", "type": "object", "properties": { - "selector": { - "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - }, - "deadline": { - "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.", - "format": "double", - "type": "number" - }, "minDeadline": { "description": "Minimum deadline in seconds needed for this method. Calls having deadline\nvalue lower than this will be rejected.", "format": "double", @@ -1159,13 +1180,30 @@ "address": { "description": "The address of the API backend.", "type": "string" + }, + "selector": { + "description": "Selects the methods to which this rule applies.\n\nRefer to selector for syntax details.", + "type": "string" + }, + "deadline": { + "description": "The number of seconds to wait for a response from a request. The default\ndeadline for gRPC is infinite (no deadline) and HTTP requests is 5 seconds.", + "format": "double", + "type": "number" } }, - "id": "BackendRule", - "description": "A backend rule provides configuration for an individual API element." + "id": "BackendRule" }, "Api": { + "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.", + "type": "object", "properties": { + "options": { + "description": "Any metadata attached to the interface.", + "type": "array", + "items": { + "$ref": "Option" + } + }, "methods": { "description": "The methods of this interface, in unspecified order.", "type": "array", @@ -1178,7 +1216,6 @@ "type": "string" }, "syntax": { - "type": "string", "enumDescriptions": [ "Syntax `proto2`.", "Syntax `proto3`." @@ -1187,7 +1224,8 @@ "SYNTAX_PROTO2", "SYNTAX_PROTO3" ], - "description": "The source syntax of the service." + "description": "The source syntax of the service.", + "type": "string" }, "sourceContext": { "$ref": "SourceContext", @@ -1203,20 +1241,12 @@ "items": { "$ref": "Mixin" } - }, - "options": { - "type": "array", - "items": { - "$ref": "Option" - }, - "description": "Any metadata attached to the interface." } }, - "id": "Api", - "description": "Api is a light-weight descriptor for an API Interface.\n\nInterfaces are also described as \"protocol buffer services\" in some contexts,\nsuch as by the \"service\" keyword in a .proto file, but they are different\nfrom API Services, which represent a concrete implementation of an interface\nas opposed to simply a description of methods and bindings. They are also\nsometimes simply referred to as \"APIs\" in other contexts, such as the name of\nthis message itself. See https://cloud.google.com/apis/design/glossary for\ndetailed terminology.", - "type": "object" + "id": "Api" }, "MetricRule": { + "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call.", "type": "object", "properties": { "selector": { @@ -1224,18 +1254,19 @@ "type": "string" }, "metricCosts": { - "type": "object", "additionalProperties": { "format": "int64", "type": "string" }, - "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative." + "description": "Metrics to update when the selected methods are called, and the associated\ncost applied to each metric.\n\nThe key of the map is the metric name, and the values are the amount\nincreased for the metric against which the quota limits are defined.\nThe value must not be negative.", + "type": "object" } }, - "id": "MetricRule", - "description": "Bind API methods to metrics. Binding a method to a metric causes that\nmetric's configured quota behaviors to apply to the method call." + "id": "MetricRule" }, "Authentication": { + "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", + "type": "object", "properties": { "rules": { "description": "A list of authentication rules that apply to individual API methods.\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", @@ -1245,19 +1276,16 @@ } }, "providers": { + "description": "Defines a set of authentication providers that a service supports.", "type": "array", "items": { "$ref": "AuthProvider" - }, - "description": "Defines a set of authentication providers that a service supports." + } } }, - "id": "Authentication", - "description": "`Authentication` defines the authentication configuration for an API.\n\nExample for an API targeted for external use:\n\n name: calendar.googleapis.com\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", - "type": "object" + "id": "Authentication" }, "Operation": { - "id": "Operation", "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "properties": { @@ -1266,12 +1294,12 @@ "type": "boolean" }, "response": { + "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", "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", @@ -1282,40 +1310,51 @@ "description": "The error result of the operation in case of failure or cancellation." }, "metadata": { + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" + } } - } + }, + "id": "Operation" }, "Page": { - "id": "Page", "description": "Represents a documentation page. A page can contain subpages to represent\nnested documentation set structure.", "type": "object", "properties": { - "subpages": { - "type": "array", - "items": { - "$ref": "Page" - }, - "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset." - }, - "name": { - "type": "string", - "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`." - }, "content": { "description": "The Markdown content of the page. You can use \u003ccode\u003e(== include {path} ==)\u003c/code\u003e\nto include content from a Markdown file.", "type": "string" + }, + "subpages": { + "description": "Subpages of this page. The order of subpages specified here will be\nhonored in the generated docset.", + "type": "array", + "items": { + "$ref": "Page" + } + }, + "name": { + "description": "The name of the page. It will be used as an identity of the page to\ngenerate URI of the page, text of the link to this page in navigation,\netc. The full page name (start from the root page name to this page\nconcatenated with `.`) can be used as reference to the page in your\ndocumentation. For example:\n\u003cpre\u003e\u003ccode\u003epages:\n- name: Tutorial\n content: (== include tutorial.md ==)\n subpages:\n - name: Java\n content: (== include tutorial_java.md ==)\n\u003c/code\u003e\u003c/pre\u003e\nYou can reference `Java` page using Markdown reference link syntax:\n`Java`.", + "type": "string" } - } + }, + "id": "Page" }, "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.", "type": "object", "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" + }, "details": { "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", @@ -1326,19 +1365,9 @@ }, "type": "object" } - }, - "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" } }, - "id": "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" }, "AuthProvider": { "description": "Configuration for an anthentication provider, including support for\n[JSON Web Token (JWT)](https://tools.ietf.org/html/draft-ietf-oauth-json-web-token-32).", @@ -1371,6 +1400,10 @@ "description": "Enum value definition.", "type": "object", "properties": { + "name": { + "description": "Enum value name.", + "type": "string" + }, "options": { "description": "Protocol buffer options.", "type": "array", @@ -1382,10 +1415,6 @@ "description": "Enum value number.", "format": "int32", "type": "integer" - }, - "name": { - "description": "Enum value name.", - "type": "string" } }, "id": "EnumValue" @@ -1394,102 +1423,13 @@ "description": "`Service` is the root object of Google service configuration schema. It\ndescribes basic information about a service, such as the name and the\ntitle, and delegates other aspects to sub-sections. Each sub-section is\neither a proto message or a repeated proto message that configures a\nspecific aspect, such as auth. See each proto message definition for details.\n\nExample:\n\n type: google.api.Service\n config_version: 3\n name: calendar.googleapis.com\n title: Google Calendar API\n apis:\n - name: google.calendar.v3.Calendar\n authentication:\n providers:\n - id: google_calendar_auth\n jwks_uri: https://www.googleapis.com/oauth2/v1/certs\n issuer: https://securetoken.google.com\n rules:\n - selector: \"*\"\n requirements:\n provider_id: google_calendar_auth", "type": "object", "properties": { - "documentation": { - "description": "Additional API documentation.", - "$ref": "Documentation" - }, - "logging": { - "$ref": "Logging", - "description": "Logging configuration." - }, - "monitoredResources": { - "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", - "type": "array", - "items": { - "$ref": "MonitoredResourceDescriptor" - } - }, - "enums": { - "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum", - "type": "array", - "items": { - "$ref": "Enum" - } - }, - "context": { - "$ref": "Context", - "description": "Context configuration." - }, - "id": { - "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", - "type": "string" - }, - "usage": { - "description": "Configuration controlling usage of this service.", - "$ref": "Usage" - }, - "metrics": { - "description": "Defines the metrics used by this service.", - "type": "array", - "items": { - "$ref": "MetricDescriptor" - } - }, - "authentication": { - "$ref": "Authentication", - "description": "Auth configuration." - }, - "experimental": { - "$ref": "Experimental", - "description": "Experimental configuration." - }, - "control": { - "description": "Configuration for the service control plane.", - "$ref": "Control" - }, - "configVersion": { - "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.", - "format": "uint32", - "type": "integer" - }, - "monitoring": { - "description": "Monitoring configuration.", - "$ref": "Monitoring" - }, - "producerProjectId": { - "description": "The Google project that owns this service.", - "type": "string" - }, - "systemTypes": { - "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.", - "type": "array", - "items": { - "$ref": "Type" - } - }, - "visibility": { - "description": "API visibility configuration.", - "$ref": "Visibility" - }, - "quota": { - "$ref": "Quota", - "description": "Quota configuration." - }, - "billing": { - "description": "Billing configuration.", - "$ref": "Billing" - }, - "name": { - "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", - "type": "string" - }, "customError": { "$ref": "CustomError", "description": "Custom error configuration." }, "title": { - "type": "string", - "description": "The product title for this service." + "description": "The product title for this service.", + "type": "string" }, "endpoints": { "description": "Configuration for network endpoints. If this is empty, then an endpoint\nwith the same name as the service is automatically generated to service all\ndefined APIs.", @@ -1520,20 +1460,109 @@ } }, "sourceInfo": { - "description": "Output only. The source information for this configuration if available.", - "$ref": "SourceInfo" + "$ref": "SourceInfo", + "description": "Output only. The source information for this configuration if available." }, "http": { "$ref": "Http", "description": "HTTP configuration." }, "backend": { - "description": "API backend configuration.", - "$ref": "Backend" + "$ref": "Backend", + "description": "API backend configuration." }, "systemParameters": { - "description": "System parameter configuration.", - "$ref": "SystemParameters" + "$ref": "SystemParameters", + "description": "System parameter configuration." + }, + "documentation": { + "$ref": "Documentation", + "description": "Additional API documentation." + }, + "monitoredResources": { + "description": "Defines the monitored resources used by this service. This is required\nby the Service.monitoring and Service.logging configurations.", + "type": "array", + "items": { + "$ref": "MonitoredResourceDescriptor" + } + }, + "logging": { + "$ref": "Logging", + "description": "Logging configuration." + }, + "context": { + "$ref": "Context", + "description": "Context configuration." + }, + "enums": { + "description": "A list of all enum types included in this API service. Enums\nreferenced directly or indirectly by the `apis` are automatically\nincluded. Enums which are not referenced but shall be included\nshould be listed here by name. Example:\n\n enums:\n - name: google.someapi.v1.SomeEnum", + "type": "array", + "items": { + "$ref": "Enum" + } + }, + "id": { + "description": "A unique ID for a specific instance of this message, typically assigned\nby the client for tracking purpose. If empty, the server may choose to\ngenerate one instead.", + "type": "string" + }, + "usage": { + "description": "Configuration controlling usage of this service.", + "$ref": "Usage" + }, + "metrics": { + "description": "Defines the metrics used by this service.", + "type": "array", + "items": { + "$ref": "MetricDescriptor" + } + }, + "authentication": { + "description": "Auth configuration.", + "$ref": "Authentication" + }, + "experimental": { + "description": "Experimental configuration.", + "$ref": "Experimental" + }, + "control": { + "description": "Configuration for the service control plane.", + "$ref": "Control" + }, + "configVersion": { + "description": "The semantic version of the service configuration. The config version\naffects the interpretation of the service configuration. For example,\ncertain features are enabled by default for certain config versions.\nThe latest config version is `3`.", + "format": "uint32", + "type": "integer" + }, + "monitoring": { + "$ref": "Monitoring", + "description": "Monitoring configuration." + }, + "producerProjectId": { + "description": "The Google project that owns this service.", + "type": "string" + }, + "systemTypes": { + "description": "A list of all proto message types included in this API service.\nIt serves similar purpose as [google.api.Service.types], except that\nthese types are not needed by user-defined APIs. Therefore, they will not\nshow up in the generated discovery doc. This field should only be used\nto define system APIs in ESF.", + "type": "array", + "items": { + "$ref": "Type" + } + }, + "visibility": { + "description": "API visibility configuration.", + "$ref": "Visibility" + }, + "quota": { + "description": "Quota configuration.", + "$ref": "Quota" + }, + "name": { + "description": "The DNS address at which this service is available,\ne.g. `calendar.googleapis.com`.", + "type": "string" + }, + "billing": { + "description": "Billing configuration.", + "$ref": "Billing" } }, "id": "Service" @@ -1542,11 +1571,6 @@ "description": "The metadata associated with a long running operation resource.", "type": "object", "properties": { - "progressPercentage": { - "description": "Percentage of completion of this operation, ranging from 0 to 100.", - "format": "int32", - "type": "integer" - }, "startTime": { "description": "The start time of the operation.", "format": "google-datetime", @@ -1565,11 +1589,17 @@ "items": { "$ref": "Step" } + }, + "progressPercentage": { + "description": "Percentage of completion of this operation, ranging from 0 to 100.", + "format": "int32", + "type": "integer" } }, "id": "OperationMetadata" }, "CustomHttpPattern": { + "description": "A custom pattern is used for defining custom HTTP verb.", "type": "object", "properties": { "kind": { @@ -1581,8 +1611,22 @@ "type": "string" } }, - "id": "CustomHttpPattern", - "description": "A custom pattern is used for defining custom HTTP verb." + "id": "CustomHttpPattern" + }, + "PublishedService": { + "description": "The published version of a Service that is managed by\nGoogle Service Management.", + "type": "object", + "properties": { + "service": { + "description": "The service's published configuration.", + "$ref": "Service" + }, + "name": { + "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com", + "type": "string" + } + }, + "id": "PublishedService" }, "SystemParameterRule": { "description": "Define a system parameter rule mapping system parameter definitions to\nmethods.", @@ -1602,52 +1646,25 @@ }, "id": "SystemParameterRule" }, - "PublishedService": { - "description": "The published version of a Service that is managed by\nGoogle Service Management.", + "VisibilityRule": { + "description": "A visibility rule provides visibility configuration for an individual API\nelement.", "type": "object", "properties": { - "service": { - "$ref": "Service", - "description": "The service's published configuration." + "restriction": { + "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", + "type": "string" }, - "name": { - "description": "The resource name of the service.\n\nA valid name would be:\n- services/serviceuser.googleapis.com", + "selector": { + "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.", "type": "string" } }, - "id": "PublishedService" + "id": "VisibilityRule" }, "HttpRule": { "description": "`HttpRule` defines the mapping of an RPC method to one or more HTTP\nREST API methods. The mapping specifies how different portions of the RPC\nrequest message are mapped to URL path, URL query parameters, and\nHTTP request body. The mapping is typically specified as an\n`google.api.http` annotation on the RPC method,\nsee \"google/api/annotations.proto\" for details.\n\nThe mapping consists of a field specifying the path template and\nmethod kind. The path template can refer to fields in the request\nmessage, as in the example below which describes a REST GET\noperation on a resource collection of messages:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}/{sub.subfield}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n SubMessage sub = 2; // `sub.subfield` is url-mapped\n }\n message Message {\n string text = 1; // content of the resource\n }\n\nThe same http annotation can alternatively be expressed inside the\n`GRPC API Configuration` YAML file.\n\n http:\n rules:\n - selector: \u003cproto_package_name\u003e.Messaging.GetMessage\n get: /v1/messages/{message_id}/{sub.subfield}\n\nThis definition enables an automatic, bidrectional mapping of HTTP\nJSON to RPC. Example:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456/foo` | `GetMessage(message_id: \"123456\" sub: SubMessage(subfield: \"foo\"))`\n\nIn general, not only fields but also field paths can be referenced\nfrom a path pattern. Fields mapped to the path pattern cannot be\nrepeated and must have a primitive (non-message) type.\n\nAny fields in the request message which are not bound by the path\npattern automatically become (optional) HTTP query\nparameters. Assume the following definition of the request message:\n\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http).get = \"/v1/messages/{message_id}\";\n }\n }\n message GetMessageRequest {\n message SubMessage {\n string subfield = 1;\n }\n string message_id = 1; // mapped to the URL\n int64 revision = 2; // becomes a parameter\n SubMessage sub = 3; // `sub.subfield` becomes a parameter\n }\n\n\nThis enables a HTTP JSON to RPC mapping as below:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456?revision=2&sub.subfield=foo` | `GetMessage(message_id: \"123456\" revision: 2 sub: SubMessage(subfield: \"foo\"))`\n\nNote that fields which are mapped to HTTP parameters must have a\nprimitive type or a repeated primitive type. Message types are not\nallowed. In the case of a repeated type, the parameter can be\nrepeated in the URL, as in `...?param=A¶m=B`.\n\nFor HTTP method kinds which allow a request body, the `body` field\nspecifies the mapping. Consider a REST update method on the\nmessage resource collection:\n\n\n service Messaging {\n rpc UpdateMessage(UpdateMessageRequest) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"message\"\n };\n }\n }\n message UpdateMessageRequest {\n string message_id = 1; // mapped to the URL\n Message message = 2; // mapped to the body\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled, where the\nrepresentation of the JSON in the request body is determined by\nprotos JSON encoding:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" message { text: \"Hi!\" })`\n\nThe special name `*` can be used in the body mapping to define that\nevery field not bound by the path template should be mapped to the\nrequest body. This enables the following alternative definition of\nthe update method:\n\n service Messaging {\n rpc UpdateMessage(Message) returns (Message) {\n option (google.api.http) = {\n put: \"/v1/messages/{message_id}\"\n body: \"*\"\n };\n }\n }\n message Message {\n string message_id = 1;\n string text = 2;\n }\n\n\nThe following HTTP JSON to RPC mapping is enabled:\n\nHTTP | RPC\n-----|-----\n`PUT /v1/messages/123456 { \"text\": \"Hi!\" }` | `UpdateMessage(message_id: \"123456\" text: \"Hi!\")`\n\nNote that when using `*` in the body mapping, it is not possible to\nhave HTTP parameters, as all fields not bound by the path end in\nthe body. This makes this option more rarely used in practice of\ndefining REST APIs. The common usage of `*` is in custom methods\nwhich don't use the URL at all for transferring data.\n\nIt is possible to define multiple HTTP methods for one RPC by using\nthe `additional_bindings` option. Example:\n\n service Messaging {\n rpc GetMessage(GetMessageRequest) returns (Message) {\n option (google.api.http) = {\n get: \"/v1/messages/{message_id}\"\n additional_bindings {\n get: \"/v1/users/{user_id}/messages/{message_id}\"\n }\n };\n }\n }\n message GetMessageRequest {\n string message_id = 1;\n string user_id = 2;\n }\n\n\nThis enables the following two alternative HTTP JSON to RPC\nmappings:\n\nHTTP | RPC\n-----|-----\n`GET /v1/messages/123456` | `GetMessage(message_id: \"123456\")`\n`GET /v1/users/me/messages/123456` | `GetMessage(user_id: \"me\" message_id: \"123456\")`\n\n# Rules for HTTP mapping\n\nThe rules for mapping HTTP path, query parameters, and body fields\nto the request message are as follows:\n\n1. The `body` field specifies either `*` or a field path, or is\n omitted. If omitted, it indicates there is no HTTP request body.\n2. Leaf fields (recursive expansion of nested messages in the\n request) can be classified into three types:\n (a) Matched in the URL template.\n (b) Covered by body (if body is `*`, everything except (a) fields;\n else everything under the body field)\n (c) All other fields.\n3. URL query parameters found in the HTTP request are mapped to (c) fields.\n4. Any body sent with an HTTP request can contain only (b) fields.\n\nThe syntax of the path template is as follows:\n\n Template = \"/\" Segments [ Verb ] ;\n Segments = Segment { \"/\" Segment } ;\n Segment = \"*\" | \"**\" | LITERAL | Variable ;\n Variable = \"{\" FieldPath [ \"=\" Segments ] \"}\" ;\n FieldPath = IDENT { \".\" IDENT } ;\n Verb = \":\" LITERAL ;\n\nThe syntax `*` matches a single path segment. The syntax `**` matches zero\nor more path segments, which must be the last part of the path except the\n`Verb`. The syntax `LITERAL` matches literal text in the path.\n\nThe syntax `Variable` matches part of the URL path as specified by its\ntemplate. A variable template must not contain other variables. If a variable\nmatches a single path segment, its template may be omitted, e.g. `{var}`\nis equivalent to `{var=*}`.\n\nIf a variable contains exactly one path segment, such as `\"{var}\"` or\n`\"{var=*}\"`, when such a variable is expanded into a URL path, all characters\nexcept `[-_.~0-9a-zA-Z]` are percent-encoded. Such variables show up in the\nDiscovery Document as `{var}`.\n\nIf a variable contains one or more path segments, such as `\"{var=foo/*}\"`\nor `\"{var=**}\"`, when such a variable is expanded into a URL path, all\ncharacters except `[-_.~/0-9a-zA-Z]` are percent-encoded. Such variables\nshow up in the Discovery Document as `{+var}`.\n\nNOTE: While the single segment variable matches the semantics of\n[RFC 6570](https://tools.ietf.org/html/rfc6570) Section 3.2.2\nSimple String Expansion, the multi segment variable **does not** match\nRFC 6570 Reserved Expansion. The reason is that the Reserved Expansion\ndoes not expand special characters like `?` and `#`, which would lead\nto invalid URLs.\n\nNOTE: the field paths in variables and in the `body` must not refer to\nrepeated fields or map fields.", "type": "object", "properties": { - "delete": { - "description": "Used for deleting a resource.", - "type": "string" - }, - "body": { - "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", - "type": "string" - }, - "mediaDownload": { - "$ref": "MediaDownload", - "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration." - }, - "post": { - "description": "Used for creating a resource.", - "type": "string" - }, - "additionalBindings": { - "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", - "type": "array", - "items": { - "$ref": "HttpRule" - } - }, - "responseBody": { - "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.", - "type": "string" - }, "mediaUpload": { "$ref": "MediaUpload", "description": "Use this only for Scotty Requests. Do not use this for media support using\nBytestream, add instead\n[][google.bytestream.RestByteStream] as an API to your\nconfiguration for Bytestream methods." @@ -1671,25 +1688,37 @@ "put": { "description": "Used for updating a resource.", "type": "string" + }, + "delete": { + "description": "Used for deleting a resource.", + "type": "string" + }, + "body": { + "description": "The name of the request field whose value is mapped to the HTTP body, or\n`*` for mapping all fields not captured by the path pattern to the HTTP\nbody. NOTE: the referred field must not be a repeated field and must be\npresent at the top-level of request message type.", + "type": "string" + }, + "post": { + "description": "Used for creating a resource.", + "type": "string" + }, + "mediaDownload": { + "description": "Use this only for Scotty Requests. Do not use this for bytestream methods.\nFor media support, add instead [][google.bytestream.RestByteStream] as an\nAPI to your configuration.", + "$ref": "MediaDownload" + }, + "additionalBindings": { + "description": "Additional HTTP bindings for the selector. Nested bindings must\nnot contain an `additional_bindings` field themselves (that is,\nthe nesting may only be one level deep).", + "type": "array", + "items": { + "$ref": "HttpRule" + } + }, + "responseBody": { + "description": "The name of the response field whose value is mapped to the HTTP body of\nresponse. Other response fields are ignored. This field is optional. When\nnot set, the response message will be used as HTTP body of response.\nNOTE: the referred field must be not a repeated field and must be present\nat the top-level of response message type.", + "type": "string" } }, "id": "HttpRule" }, - "VisibilityRule": { - "description": "A visibility rule provides visibility configuration for an individual API\nelement.", - "type": "object", - "properties": { - "restriction": { - "description": "A comma-separated list of visibility labels that apply to the `selector`.\nAny of the listed labels can be used to grant the visibility.\n\nIf a rule has multiple labels, removing one of the labels but not all of\nthem can break clients.\n\nExample:\n\n visibility:\n rules:\n - selector: google.calendar.Calendar.EnhancedSearch\n restriction: GOOGLE_INTERNAL, TRUSTED_TESTER\n\nRemoving GOOGLE_INTERNAL from this restriction will break clients that\nrely on this method and only had access to it through GOOGLE_INTERNAL.", - "type": "string" - }, - "selector": { - "description": "Selects methods, messages, fields, enums, etc. to which this rule applies.\n\nRefer to selector for syntax details.", - "type": "string" - } - }, - "id": "VisibilityRule" - }, "MonitoringDestination": { "description": "Configuration of a specific monitoring destination (the producer project\nor the consumer project).", "type": "object", @@ -1699,11 +1728,11 @@ "type": "string" }, "metrics": { + "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section.", "type": "array", "items": { "type": "string" - }, - "description": "Names of the metrics to report to this monitoring destination.\nEach name must be defined in Service.metrics section." + } } }, "id": "MonitoringDestination" @@ -1727,275 +1756,246 @@ "type": "object", "properties": { "rules": { + "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order.", "type": "array", "items": { "$ref": "SystemParameterRule" - }, - "description": "Define system parameters.\n\nThe parameters defined here will override the default parameters\nimplemented by the system. If this field is missing from the service\nconfig, default system parameters will be used. Default system parameters\nand names is implementation-dependent.\n\nExample: define api key for all methods\n\n system_parameters\n rules:\n - selector: \"*\"\n parameters:\n - name: api_key\n url_query_parameter: api_key\n\n\nExample: define 2 api key names for a specific method.\n\n system_parameters\n rules:\n - selector: \"/ListShelves\"\n parameters:\n - name: api_key\n http_header: Api-Key1\n - name: api_key\n http_header: Api-Key2\n\n**NOTE:** All service configuration rules follow \"last one wins\" order." + } } }, "id": "SystemParameters" + }, + "Quota": { + "description": "Quota configuration helps to achieve fairness and budgeting in service\nusage.\n\nThe quota configuration works this way:\n- The service configuration defines a set of metrics.\n- For API calls, the quota.metric_rules maps methods to metrics with\n corresponding costs.\n- The quota.limits defines limits on the metrics, which will be used for\n quota checks at runtime.\n\nAn example quota configuration in yaml format:\n\n quota:\n\n - name: apiWriteQpsPerProject\n metric: library.googleapis.com/write_calls\n unit: \"1/min/{project}\" # rate limit for consumer projects\n values:\n STANDARD: 10000\n\n\n # The metric rules bind all methods to the read_calls metric,\n # except for the UpdateBook and DeleteBook methods. These two methods\n # are mapped to the write_calls metric, with the UpdateBook method\n # consuming at twice rate as the DeleteBook method.\n metric_rules:\n - selector: \"*\"\n metric_costs:\n library.googleapis.com/read_calls: 1\n - selector: google.example.library.v1.LibraryService.UpdateBook\n metric_costs:\n library.googleapis.com/write_calls: 2\n - selector: google.example.library.v1.LibraryService.DeleteBook\n metric_costs:\n library.googleapis.com/write_calls: 1\n\n Corresponding Metric definition:\n\n metrics:\n - name: library.googleapis.com/read_calls\n display_name: Read requests\n metric_kind: DELTA\n value_type: INT64\n\n - name: library.googleapis.com/write_calls\n display_name: Write requests\n metric_kind: DELTA\n value_type: INT64", + "type": "object", + "properties": { + "limits": { + "description": "List of `QuotaLimit` definitions for the service.", + "type": "array", + "items": { + "$ref": "QuotaLimit" + } + }, + "metricRules": { + "description": "List of `MetricRule` definitions, each one mapping a selected method to one\nor more metrics.", + "type": "array", + "items": { + "$ref": "MetricRule" + } + } + }, + "id": "Quota" + }, + "Step": { + "description": "Represents the status of one operation step.", + "type": "object", + "properties": { + "description": { + "description": "The short description of the step.", + "type": "string" + }, + "status": { + "description": "The status code.", + "type": "string", + "enumDescriptions": [ + "Unspecifed code.", + "The operation or step has completed without errors.", + "The operation or step has not started yet.", + "The operation or step is in progress.", + "The operation or step has completed with errors. If the operation is\nrollbackable, the rollback completed with errors too.", + "The operation or step has completed with cancellation." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "DONE", + "NOT_STARTED", + "IN_PROGRESS", + "FAILED", + "CANCELLED" + ] + } + }, + "id": "Step" + }, + "LoggingDestination": { + "description": "Configuration of a specific logging destination (the producer project\nor the consumer project).", + "type": "object", + "properties": { + "logs": { + "description": "Names of the logs to be sent to this destination. Each name must\nbe defined in the Service.logs section. If the log name is\nnot a domain scoped name, it will be automatically prefixed with\nthe service name followed by \"/\".", + "type": "array", + "items": { + "type": "string" + } + }, + "monitoredResource": { + "description": "The monitored resource type. The type must be defined in the\nService.monitored_resources section.", + "type": "string" + } + }, + "id": "LoggingDestination" + }, + "Option": { + "description": "A protocol buffer option, which can be attached to a message, field,\nenumeration, etc.", + "type": "object", + "properties": { + "value": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The option's value packed in an Any message. If the value is a primitive,\nthe corresponding wrapper type defined in google/protobuf/wrappers.proto\nshould be used. If the value is an enum, it should be stored as an int32\nvalue using the google.protobuf.Int32Value type.", + "type": "object" + }, + "name": { + "description": "The option's name. For protobuf built-in options (options defined in\ndescriptor.proto), this is the short name. For example, `\"map_entry\"`.\nFor custom options, it should be the fully-qualified name. For example,\n`\"google.api.http\"`.", + "type": "string" + } + }, + "id": "Option" + }, + "Logging": { + "description": "Logging configuration of the service.\n\nThe following example shows how to configure logs to be sent to the\nproducer and consumer projects. In the example, the `activity_history`\nlog is sent to both the producer and consumer projects, whereas the\n`purchase_history` log is only sent to the producer project.\n\n monitored_resources:\n - type: library.googleapis.com/branch\n labels:\n - key: /city\n description: The city where the library branch is located in.\n - key: /name\n description: The name of the branch.\n logs:\n - name: activity_history\n labels:\n - key: /customer_id\n - name: purchase_history\n logging:\n producer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history\n - purchase_history\n consumer_destinations:\n - monitored_resource: library.googleapis.com/branch\n logs:\n - activity_history", + "type": "object", + "properties": { + "consumerDestinations": { + "description": "Logging configurations for sending logs to the consumer project.\nThere can be multiple consumer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none consumer destination.", + "type": "array", + "items": { + "$ref": "LoggingDestination" + } + }, + "producerDestinations": { + "description": "Logging configurations for sending logs to the producer project.\nThere can be multiple producer destinations, each one must have a\ndifferent monitored resource type. A log can be used in at most\none producer destination.", + "type": "array", + "items": { + "$ref": "LoggingDestination" + } + } + }, + "id": "Logging" + }, + "Method": { + "description": "Method represents a method of an API interface.", + "type": "object", + "properties": { + "requestTypeUrl": { + "description": "A URL of the input message type.", + "type": "string" + }, + "requestStreaming": { + "description": "If true, the request is streamed.", + "type": "boolean" + }, + "syntax": { + "enumDescriptions": [ + "Syntax `proto2`.", + "Syntax `proto3`." + ], + "enum": [ + "SYNTAX_PROTO2", + "SYNTAX_PROTO3" + ], + "description": "The source syntax of this method.", + "type": "string" + }, + "responseTypeUrl": { + "description": "The URL of the output message type.", + "type": "string" + }, + "options": { + "description": "Any metadata attached to the method.", + "type": "array", + "items": { + "$ref": "Option" + } + }, + "responseStreaming": { + "description": "If true, the response is streamed.", + "type": "boolean" + }, + "name": { + "description": "The simple name of this method.", + "type": "string" + } + }, + "id": "Method" + }, + "QuotaLimit": { + "description": "`QuotaLimit` defines a specific limit that applies over a specified duration\nfor a limit type. There can be at most one limit for a duration and limit\ntype combination defined within a `QuotaGroup`.", + "type": "object", + "properties": { + "description": { + "description": "Optional. User-visible, extended description for this quota limit.\nShould be used only when more context is needed to understand this limit\nthan provided by the limit's display name (see: `display_name`).", + "type": "string" + }, + "metric": { + "description": "The name of the metric this quota limit applies to. The quota limits with\nthe same metric will be checked together during runtime. The metric must be\ndefined within the service config.", + "type": "string" + }, + "displayName": { + "description": "User-visible display name for this limit.\nOptional. If not set, the UI will provide a default display name based on\nthe quota configuration. This field can be used to override the default\ndisplay name generated from the configuration.", + "type": "string" + }, + "values": { + "additionalProperties": { + "format": "int64", + "type": "string" + }, + "description": "Tiered limit values. You must specify this as a key:value pair, with an\ninteger value that is the maximum number of requests allowed for the\nspecified unit. Currently only STANDARD is supported.", + "type": "object" + }, + "unit": { + "description": "Specify the unit of the quota limit. It uses the same syntax as\nMetric.unit. The supported unit kinds are determined by the quota\nbackend system.\n\nHere are some examples:\n* \"1/min/{project}\" for quota per minute per project.\n\nNote: the order of unit components is insignificant.\nThe \"1\" at the beginning is required to follow the metric unit syntax.", + "type": "string" + }, + "maxLimit": { + "description": "Maximum number of tokens that can be consumed during the specified\nduration. Client application developers can override the default limit up\nto this maximum. If specified, this value cannot be set to a value less\nthan the default limit. If not specified, it is set to the default limit.\n\nTo allow clients to apply overrides with no upper bound, set this to -1,\nindicating unlimited maximum quota.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "name": { + "description": "Name of the quota limit.\n\nThe name must be provided, and it must be unique within the service. The\nname can only include alphanumeric characters as well as '-'.\n\nThe maximum length of the limit name is 64 characters.", + "type": "string" + }, + "duration": { + "description": "Duration of this limit in textual notation. Example: \"100s\", \"24h\", \"1d\".\nFor duration longer than a day, only multiple of days is supported. We\nsupport only \"100s\" and \"1d\" for now. Additional support will be added in\nthe future. \"0\" indicates indefinite duration.\n\nUsed by group-based quotas only.", + "type": "string" + }, + "freeTier": { + "description": "Free tier value displayed in the Developers Console for this limit.\nThe free tier is the number of tokens that will be subtracted from the\nbilled amount when billing is enabled.\nThis field can only be set on a limit with duration \"1d\", in a billable\ngroup; it is invalid on any other limit. If this field is not set, it\ndefaults to 0, indicating that there is no free tier for this service.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + }, + "defaultLimit": { + "description": "Default number of tokens that can be consumed during the specified\nduration. This is the number of tokens assigned when a client\napplication developer activates the service for his/her project.\n\nSpecifying a value of 0 will block all requests. This can be used if you\nare provisioning quota to selected consumers and blocking others.\nSimilarly, a value of -1 will indicate an unlimited quota. No other\nnegative values are allowed.\n\nUsed by group-based quotas only.", + "format": "int64", + "type": "string" + } + }, + "id": "QuotaLimit" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "canonicalName": "Service User", "auth": { "oauth2": { "scopes": { + "https://www.googleapis.com/auth/service.management": { + "description": "Manage your Google API service configuration" + }, "https://www.googleapis.com/auth/cloud-platform.read-only": { "description": "View your data across Google Cloud Platform services" }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/service.management": { - "description": "Manage your Google API service configuration" } } } }, - "rootUrl": "https://serviceuser.googleapis.com/", - "ownerDomain": "google.com", - "name": "serviceuser", - "batchPath": "batch", - "title": "Google Service User API", - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "services": { - "methods": { - "disable": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "parameters": { - "name": { - "pattern": "^projects/[^/]+/services/[^/]+$", - "location": "path", - "description": "Name of the consumer and the service to disable for that consumer.\n\nThe Service User implementation accepts the following forms for consumer:\n- \"project:\u003cproject_id\u003e\"\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:disable", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/services/{servicesId}:disable", - "id": "serviceuser.projects.services.disable", - "path": "v1/{+name}:disable", - "description": "Disable a service so it can no longer be used with a\nproject. This prevents unintended usage that may cause unexpected billing\ncharges or security leaks.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e", - "request": { - "$ref": "DisableServiceRequest" - } - }, - "enable": { - "id": "serviceuser.projects.services.enable", - "path": "v1/{+name}:enable", - "request": { - "$ref": "EnableServiceRequest" - }, - "description": "Enable a service so it can be used with a project.\nSee [Cloud Auth Guide](https://cloud.google.com/docs/authentication) for\nmore information.\n\nOperation\u003cresponse: google.protobuf.Empty\u003e", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "location": "path", - "description": "Name of the consumer and the service to enable for that consumer.\n\nA valid path would be:\n- /v1/projects/my-project/services/servicemanagement.googleapis.com:enable", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/services/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/service.management" - ], - "flatPath": "v1/projects/{projectsId}/services/{servicesId}:enable" - }, - "list": { - "description": "List enabled services for the specified consumer.", - "response": { - "$ref": "ListEnabledServicesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "pageSize": { - "description": "Requested size of the next page of data.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "parent": { - "description": "List enabled services for the specified parent.\n\nAn example valid parent would be:\n- projects/my-project", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "Token identifying which result to start with; returned by a previous list\ncall.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/projects/{projectsId}/services", - "path": "v1/{+parent}/services", - "id": "serviceuser.projects.services.list" - } - } - } - } - }, - "services": { - "methods": { - "search": { - "description": "Search available services.\n\nWhen no filter is specified, returns all accessible services. For\nauthenticated users, also returns all services the calling user has\n\"servicemanagement.services.bind\" permission for.", - "response": { - "$ref": "SearchServicesResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "parameters": { - "pageToken": { - "description": "Token identifying which result to start with; returned by a previous list\ncall.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Requested size of the next page of data.", - "format": "int32", - "type": "integer" - } - }, - "flatPath": "v1/services:search", - "path": "v1/services:search", - "id": "serviceuser.services.search" - } - } - } - }, - "parameters": { - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - } - }, - "version": "v1", - "baseUrl": "https://serviceuser.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Enables services that service consumers want to use on Google Cloud Platform, lists the available or enabled services, or disables services that service consumers no longer use.", - "servicePath": "", - "basePath": "", - "id": "serviceuser:v1", - "documentationLink": "https://cloud.google.com/service-management/", - "revision": "20171229" + "rootUrl": "https://serviceuser.googleapis.com/" }
diff --git a/sheets/v4/sheets-api.json b/sheets/v4/sheets-api.json index 1816a31..1147ad4 100644 --- a/sheets/v4/sheets-api.json +++ b/sheets/v4/sheets-api.json
@@ -1,17 +1,1292 @@ { - "id": "sheets:v4", - "documentationLink": "https://developers.google.com/sheets/", - "revision": "20171220", "discoveryVersion": "v1", "version_module": true, "schemas": { + "ChartData": { + "properties": { + "sourceRange": { + "description": "The source ranges of the data.", + "$ref": "ChartSourceRange" + } + }, + "id": "ChartData", + "description": "The data included in a domain or series.", + "type": "object" + }, + "BatchGetValuesResponse": { + "properties": { + "valueRanges": { + "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.", + "type": "array", + "items": { + "$ref": "ValueRange" + } + }, + "spreadsheetId": { + "description": "The ID of the spreadsheet the data was retrieved from.", + "type": "string" + } + }, + "id": "BatchGetValuesResponse", + "description": "The response when retrieving more than one range of values in a spreadsheet.", + "type": "object" + }, + "UpdateBandingRequest": { + "description": "Updates properties of the supplied banded range.", + "type": "object", + "properties": { + "bandedRange": { + "$ref": "BandedRange", + "description": "The banded range to update with the new properties." + }, + "fields": { + "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + } + }, + "id": "UpdateBandingRequest" + }, + "Color": { + "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", + "type": "object", + "properties": { + "red": { + "description": "The amount of red in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "green": { + "description": "The amount of green in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "blue": { + "description": "The amount of blue in the color as a value in the interval [0, 1].", + "format": "float", + "type": "number" + }, + "alpha": { + "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", + "format": "float", + "type": "number" + } + }, + "id": "Color" + }, + "PivotGroup": { + "description": "A single grouping (either row or column) in a pivot table.", + "type": "object", + "properties": { + "sortOrder": { + "description": "The order the values in this group should be sorted.", + "type": "string", + "enumDescriptions": [ + "Default value, do not use this.", + "Sort ascending.", + "Sort descending." + ], + "enum": [ + "SORT_ORDER_UNSPECIFIED", + "ASCENDING", + "DESCENDING" + ] + }, + "valueBucket": { + "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values.", + "$ref": "PivotGroupSortValueBucket" + }, + "sourceColumnOffset": { + "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.", + "format": "int32", + "type": "integer" + }, + "showTotals": { + "description": "True if the pivot table should include the totals for this grouping.", + "type": "boolean" + }, + "valueMetadata": { + "description": "Metadata about values in the grouping.", + "type": "array", + "items": { + "$ref": "PivotGroupValueMetadata" + } + } + }, + "id": "PivotGroup" + }, + "PivotTable": { + "description": "A pivot table.", + "type": "object", + "properties": { + "criteria": { + "additionalProperties": { + "$ref": "PivotFilterCriteria" + }, + "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.", + "type": "object" + }, + "rows": { + "description": "Each row grouping in the pivot table.", + "type": "array", + "items": { + "$ref": "PivotGroup" + } + }, + "valueLayout": { + "enumDescriptions": [ + "Values are laid out horizontally (as columns).", + "Values are laid out vertically (as rows)." + ], + "enum": [ + "HORIZONTAL", + "VERTICAL" + ], + "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).", + "type": "string" + }, + "values": { + "description": "A list of values to include in the pivot table.", + "type": "array", + "items": { + "$ref": "PivotValue" + } + }, + "source": { + "$ref": "GridRange", + "description": "The range the pivot table is reading data from." + }, + "columns": { + "description": "Each column grouping in the pivot table.", + "type": "array", + "items": { + "$ref": "PivotGroup" + } + } + }, + "id": "PivotTable" + }, + "ChartSourceRange": { + "description": "Source ranges for a chart.", + "type": "object", + "properties": { + "sources": { + "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12", + "type": "array", + "items": { + "$ref": "GridRange" + } + } + }, + "id": "ChartSourceRange" + }, + "SearchDeveloperMetadataResponse": { + "properties": { + "matchedDeveloperMetadata": { + "description": "The metadata matching the criteria of the search request.", + "type": "array", + "items": { + "$ref": "MatchedDeveloperMetadata" + } + } + }, + "id": "SearchDeveloperMetadataResponse", + "description": "A reply to a developer metadata search request.", + "type": "object" + }, + "ValueRange": { + "properties": { + "range": { + "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.", + "type": "string" + }, + "majorDimension": { + "enumDescriptions": [ + "The default value, do not use.", + "Operates on the rows of a sheet.", + "Operates on the columns of a sheet." + ], + "enum": [ + "DIMENSION_UNSPECIFIED", + "ROWS", + "COLUMNS" + ], + "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.", + "type": "string" + }, + "values": { + "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "any" + } + } + } + }, + "id": "ValueRange", + "description": "Data within a range of the spreadsheet.", + "type": "object" + }, + "AppendCellsRequest": { + "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.", + "type": "object", + "properties": { + "rows": { + "description": "The data to append.", + "type": "array", + "items": { + "$ref": "RowData" + } + }, + "fields": { + "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "sheetId": { + "description": "The sheet ID to append the data to.", + "format": "int32", + "type": "integer" + } + }, + "id": "AppendCellsRequest" + }, + "AddBandingRequest": { + "description": "Adds a new banded range to the spreadsheet.", + "type": "object", + "properties": { + "bandedRange": { + "$ref": "BandedRange", + "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)" + } + }, + "id": "AddBandingRequest" + }, + "Response": { + "description": "A single response from an update.", + "type": "object", + "properties": { + "addFilterView": { + "description": "A reply from adding a filter view.", + "$ref": "AddFilterViewResponse" + }, + "addBanding": { + "description": "A reply from adding a banded range.", + "$ref": "AddBandingResponse" + }, + "addProtectedRange": { + "description": "A reply from adding a protected range.", + "$ref": "AddProtectedRangeResponse" + }, + "duplicateSheet": { + "description": "A reply from duplicating a sheet.", + "$ref": "DuplicateSheetResponse" + }, + "updateEmbeddedObjectPosition": { + "$ref": "UpdateEmbeddedObjectPositionResponse", + "description": "A reply from updating an embedded object's position." + }, + "deleteConditionalFormatRule": { + "$ref": "DeleteConditionalFormatRuleResponse", + "description": "A reply from deleting a conditional format rule." + }, + "duplicateFilterView": { + "$ref": "DuplicateFilterViewResponse", + "description": "A reply from duplicating a filter view." + }, + "addChart": { + "$ref": "AddChartResponse", + "description": "A reply from adding a chart." + }, + "updateDeveloperMetadata": { + "$ref": "UpdateDeveloperMetadataResponse", + "description": "A reply from updating a developer metadata entry." + }, + "findReplace": { + "$ref": "FindReplaceResponse", + "description": "A reply from doing a find/replace." + }, + "addSheet": { + "description": "A reply from adding a sheet.", + "$ref": "AddSheetResponse" + }, + "updateConditionalFormatRule": { + "description": "A reply from updating a conditional format rule.", + "$ref": "UpdateConditionalFormatRuleResponse" + }, + "createDeveloperMetadata": { + "description": "A reply from creating a developer metadata entry.", + "$ref": "CreateDeveloperMetadataResponse" + }, + "addNamedRange": { + "description": "A reply from adding a named range.", + "$ref": "AddNamedRangeResponse" + }, + "deleteDeveloperMetadata": { + "description": "A reply from deleting a developer metadata entry.", + "$ref": "DeleteDeveloperMetadataResponse" + } + }, + "id": "Response" + }, + "EmbeddedChart": { + "description": "A chart embedded in a sheet.", + "type": "object", + "properties": { + "chartId": { + "description": "The ID of the chart.", + "format": "int32", + "type": "integer" + }, + "position": { + "description": "The position of the chart.", + "$ref": "EmbeddedObjectPosition" + }, + "spec": { + "$ref": "ChartSpec", + "description": "The specification of the chart." + } + }, + "id": "EmbeddedChart" + }, + "TextFormatRun": { + "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.", + "type": "object", + "properties": { + "format": { + "description": "The format of this run. Absent values inherit the cell's format.", + "$ref": "TextFormat" + }, + "startIndex": { + "description": "The character index where this run starts.", + "format": "int32", + "type": "integer" + } + }, + "id": "TextFormatRun" + }, + "InsertRangeRequest": { + "description": "Inserts cells into a range, shifting the existing cells over or down.", + "type": "object", + "properties": { + "shiftDimension": { + "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.", + "type": "string", + "enumDescriptions": [ + "The default value, do not use.", + "Operates on the rows of a sheet.", + "Operates on the columns of a sheet." + ], + "enum": [ + "DIMENSION_UNSPECIFIED", + "ROWS", + "COLUMNS" + ] + }, + "range": { + "description": "The range to insert new cells into.", + "$ref": "GridRange" + } + }, + "id": "InsertRangeRequest" + }, + "AddNamedRangeResponse": { + "description": "The result of adding a named range.", + "type": "object", + "properties": { + "namedRange": { + "$ref": "NamedRange", + "description": "The named range to add." + } + }, + "id": "AddNamedRangeResponse" + }, + "BatchUpdateValuesByDataFilterResponse": { + "description": "The response when updating a range of values in a spreadsheet.", + "type": "object", + "properties": { + "totalUpdatedSheets": { + "description": "The total number of sheets where at least one cell in the sheet was\nupdated.", + "format": "int32", + "type": "integer" + }, + "totalUpdatedCells": { + "description": "The total number of cells updated.", + "format": "int32", + "type": "integer" + }, + "totalUpdatedColumns": { + "description": "The total number of columns where at least one cell in the column was\nupdated.", + "format": "int32", + "type": "integer" + }, + "spreadsheetId": { + "description": "The spreadsheet the updates were applied to.", + "type": "string" + }, + "totalUpdatedRows": { + "description": "The total number of rows where at least one cell in the row was updated.", + "format": "int32", + "type": "integer" + }, + "responses": { + "description": "The response for each range updated.", + "type": "array", + "items": { + "$ref": "UpdateValuesByDataFilterResponse" + } + } + }, + "id": "BatchUpdateValuesByDataFilterResponse" + }, + "RowData": { + "description": "Data about each cell in a row.", + "type": "object", + "properties": { + "values": { + "description": "The values in the row, one per column.", + "type": "array", + "items": { + "$ref": "CellData" + } + } + }, + "id": "RowData" + }, + "Border": { + "description": "A border along a cell.", + "type": "object", + "properties": { + "width": { + "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.", + "format": "int32", + "type": "integer" + }, + "style": { + "description": "The style of the border.", + "type": "string", + "enumDescriptions": [ + "The style is not specified. Do not use this.", + "The border is dotted.", + "The border is dashed.", + "The border is a thin solid line.", + "The border is a medium solid line.", + "The border is a thick solid line.", + "No border.\nUsed only when updating a border in order to erase it.", + "The border is two solid lines." + ], + "enum": [ + "STYLE_UNSPECIFIED", + "DOTTED", + "DASHED", + "SOLID", + "SOLID_MEDIUM", + "SOLID_THICK", + "NONE", + "DOUBLE" + ] + }, + "color": { + "$ref": "Color", + "description": "The color of the border." + } + }, + "id": "Border" + }, + "GridData": { + "description": "Data in the grid, as well as metadata about the dimensions.", + "type": "object", + "properties": { + "startColumn": { + "description": "The first column this GridData refers to, zero-based.", + "format": "int32", + "type": "integer" + }, + "rowMetadata": { + "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.", + "type": "array", + "items": { + "$ref": "DimensionProperties" + } + }, + "rowData": { + "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.", + "type": "array", + "items": { + "$ref": "RowData" + } + }, + "startRow": { + "description": "The first row this GridData refers to, zero-based.", + "format": "int32", + "type": "integer" + }, + "columnMetadata": { + "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.", + "type": "array", + "items": { + "$ref": "DimensionProperties" + } + } + }, + "id": "GridData" + }, + "UpdateNamedRangeRequest": { + "properties": { + "fields": { + "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "namedRange": { + "$ref": "NamedRange", + "description": "The named range to update with the new properties." + } + }, + "id": "UpdateNamedRangeRequest", + "description": "Updates properties of the named range with the specified\nnamedRangeId.", + "type": "object" + }, + "FindReplaceRequest": { + "description": "Finds and replaces data in cells over a range, sheet, or all sheets.", + "type": "object", + "properties": { + "includeFormulas": { + "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.", + "type": "boolean" + }, + "matchEntireCell": { + "description": "True if the find value should match the entire cell.", + "type": "boolean" + }, + "find": { + "description": "The value to search.", + "type": "string" + }, + "searchByRegex": { + "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.", + "type": "boolean" + }, + "replacement": { + "description": "The value to use as the replacement.", + "type": "string" + }, + "range": { + "$ref": "GridRange", + "description": "The range to find/replace over." + }, + "sheetId": { + "description": "The sheet to find/replace over.", + "format": "int32", + "type": "integer" + }, + "matchCase": { + "description": "True if the search is case sensitive.", + "type": "boolean" + }, + "allSheets": { + "description": "True to find/replace over all sheets.", + "type": "boolean" + } + }, + "id": "FindReplaceRequest" + }, + "AddSheetRequest": { + "properties": { + "properties": { + "$ref": "SheetProperties", + "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)" + } + }, + "id": "AddSheetRequest", + "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.", + "type": "object" + }, + "UpdateCellsRequest": { + "description": "Updates all cells in a range with new data.", + "type": "object", + "properties": { + "start": { + "$ref": "GridCoordinate", + "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written." + }, + "range": { + "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared.", + "$ref": "GridRange" + }, + "rows": { + "description": "The data to write.", + "type": "array", + "items": { + "$ref": "RowData" + } + }, + "fields": { + "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + } + }, + "id": "UpdateCellsRequest" + }, + "RandomizeRangeRequest": { + "description": "Randomizes the order of the rows in a range.", + "type": "object", + "properties": { + "range": { + "description": "The range to randomize.", + "$ref": "GridRange" + } + }, + "id": "RandomizeRangeRequest" + }, + "DeleteConditionalFormatRuleResponse": { + "description": "The result of deleting a conditional format rule.", + "type": "object", + "properties": { + "rule": { + "description": "The rule that was deleted.", + "$ref": "ConditionalFormatRule" + } + }, + "id": "DeleteConditionalFormatRuleResponse" + }, + "DeleteRangeRequest": { + "properties": { + "shiftDimension": { + "enumDescriptions": [ + "The default value, do not use.", + "Operates on the rows of a sheet.", + "Operates on the columns of a sheet." + ], + "enum": [ + "DIMENSION_UNSPECIFIED", + "ROWS", + "COLUMNS" + ], + "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.", + "type": "string" + }, + "range": { + "$ref": "GridRange", + "description": "The range of cells to delete." + } + }, + "id": "DeleteRangeRequest", + "description": "Deletes a range of cells, shifting other cells into the deleted area.", + "type": "object" + }, + "GridCoordinate": { + "properties": { + "sheetId": { + "description": "The sheet this coordinate is on.", + "format": "int32", + "type": "integer" + }, + "rowIndex": { + "description": "The row index of the coordinate.", + "format": "int32", + "type": "integer" + }, + "columnIndex": { + "description": "The column index of the coordinate.", + "format": "int32", + "type": "integer" + } + }, + "id": "GridCoordinate", + "description": "A coordinate in a sheet.\nAll indexes are zero-based.", + "type": "object" + }, + "UpdateSheetPropertiesRequest": { + "description": "Updates properties of the sheet with the specified\nsheetId.", + "type": "object", + "properties": { + "fields": { + "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "properties": { + "description": "The properties to update.", + "$ref": "SheetProperties" + } + }, + "id": "UpdateSheetPropertiesRequest" + }, + "GridProperties": { + "description": "Properties of a grid.", + "type": "object", + "properties": { + "rowCount": { + "description": "The number of rows in the grid.", + "format": "int32", + "type": "integer" + }, + "frozenRowCount": { + "description": "The number of rows that are frozen in the grid.", + "format": "int32", + "type": "integer" + }, + "hideGridlines": { + "description": "True if the grid isn't showing gridlines in the UI.", + "type": "boolean" + }, + "columnCount": { + "description": "The number of columns in the grid.", + "format": "int32", + "type": "integer" + }, + "frozenColumnCount": { + "description": "The number of columns that are frozen in the grid.", + "format": "int32", + "type": "integer" + } + }, + "id": "GridProperties" + }, + "UnmergeCellsRequest": { + "description": "Unmerges cells in the given range.", + "type": "object", + "properties": { + "range": { + "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.", + "$ref": "GridRange" + } + }, + "id": "UnmergeCellsRequest" + }, + "SortSpec": { + "description": "A sort order associated with a specific column or row.", + "type": "object", + "properties": { + "dimensionIndex": { + "description": "The dimension the sort should be applied to.", + "format": "int32", + "type": "integer" + }, + "sortOrder": { + "enum": [ + "SORT_ORDER_UNSPECIFIED", + "ASCENDING", + "DESCENDING" + ], + "description": "The order data should be sorted.", + "type": "string", + "enumDescriptions": [ + "Default value, do not use this.", + "Sort ascending.", + "Sort descending." + ] + } + }, + "id": "SortSpec" + }, + "Sheet": { + "description": "A sheet in a spreadsheet.", + "type": "object", + "properties": { + "basicFilter": { + "description": "The filter on this sheet, if any.", + "$ref": "BasicFilter" + }, + "merges": { + "description": "The ranges that are merged together.", + "type": "array", + "items": { + "$ref": "GridRange" + } + }, + "data": { + "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).", + "type": "array", + "items": { + "$ref": "GridData" + } + }, + "bandedRanges": { + "description": "The banded (i.e. alternating colors) ranges on this sheet.", + "type": "array", + "items": { + "$ref": "BandedRange" + } + }, + "properties": { + "description": "The properties of the sheet.", + "$ref": "SheetProperties" + }, + "charts": { + "description": "The specifications of every chart on this sheet.", + "type": "array", + "items": { + "$ref": "EmbeddedChart" + } + }, + "filterViews": { + "description": "The filter views in this sheet.", + "type": "array", + "items": { + "$ref": "FilterView" + } + }, + "developerMetadata": { + "description": "The developer metadata associated with a sheet.", + "type": "array", + "items": { + "$ref": "DeveloperMetadata" + } + }, + "protectedRanges": { + "description": "The protected ranges in this sheet.", + "type": "array", + "items": { + "$ref": "ProtectedRange" + } + }, + "conditionalFormats": { + "description": "The conditional format rules in this sheet.", + "type": "array", + "items": { + "$ref": "ConditionalFormatRule" + } + } + }, + "id": "Sheet" + }, + "UpdateEmbeddedObjectPositionResponse": { + "properties": { + "position": { + "description": "The new position of the embedded object.", + "$ref": "EmbeddedObjectPosition" + } + }, + "id": "UpdateEmbeddedObjectPositionResponse", + "description": "The result of updating an embedded object's position.", + "type": "object" + }, + "BooleanRule": { + "description": "A rule that may or may not match, depending on the condition.", + "type": "object", + "properties": { + "format": { + "$ref": "CellFormat", + "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color." + }, + "condition": { + "$ref": "BooleanCondition", + "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied." + } + }, + "id": "BooleanRule" + }, + "FilterCriteria": { + "description": "Criteria for showing/hiding rows in a filter or filter view.", + "type": "object", + "properties": { + "hiddenValues": { + "description": "Values that should be hidden.", + "type": "array", + "items": { + "type": "string" + } + }, + "condition": { + "$ref": "BooleanCondition", + "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)" + } + }, + "id": "FilterCriteria" + }, + "PivotGroupValueMetadata": { + "description": "Metadata about a value in a pivot grouping.", + "type": "object", + "properties": { + "value": { + "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)", + "$ref": "ExtendedValue" + }, + "collapsed": { + "description": "True if the data corresponding to the value is collapsed.", + "type": "boolean" + } + }, + "id": "PivotGroupValueMetadata" + }, + "WaterfallChartSpec": { + "description": "A waterfall chart.", + "type": "object", + "properties": { + "stackedType": { + "description": "The stacked type.", + "type": "string", + "enumDescriptions": [ + "Default value, do not use.", + "Values corresponding to the same domain (horizontal axis) value will be\nstacked vertically.", + "Series will spread out along the horizontal axis." + ], + "enum": [ + "WATERFALL_STACKED_TYPE_UNSPECIFIED", + "STACKED", + "SEQUENTIAL" + ] + }, + "hideConnectorLines": { + "description": "True to hide connector lines between columns.", + "type": "boolean" + }, + "series": { + "description": "The data this waterfall chart is visualizing.", + "type": "array", + "items": { + "$ref": "WaterfallChartSeries" + } + }, + "connectorLineStyle": { + "description": "The line style for the connector lines.", + "$ref": "LineStyle" + }, + "domain": { + "description": "The domain data (horizontal axis) for the waterfall chart.", + "$ref": "WaterfallChartDomain" + }, + "firstValueIsTotal": { + "description": "True to interpret the first value as a total.", + "type": "boolean" + } + }, + "id": "WaterfallChartSpec" + }, + "Editors": { + "properties": { + "users": { + "description": "The email addresses of users with edit access to the protected range.", + "type": "array", + "items": { + "type": "string" + } + }, + "groups": { + "description": "The email addresses of groups with edit access to the protected range.", + "type": "array", + "items": { + "type": "string" + } + }, + "domainUsersCanEdit": { + "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.", + "type": "boolean" + } + }, + "id": "Editors", + "description": "The editors of a protected range.", + "type": "object" + }, + "UpdateConditionalFormatRuleRequest": { + "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.", + "type": "object", + "properties": { + "rule": { + "$ref": "ConditionalFormatRule", + "description": "The rule that should replace the rule at the given index." + }, + "index": { + "description": "The zero-based index of the rule that should be replaced or moved.", + "format": "int32", + "type": "integer" + }, + "sheetId": { + "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.", + "format": "int32", + "type": "integer" + }, + "newIndex": { + "description": "The zero-based new index the rule should end up at.", + "format": "int32", + "type": "integer" + } + }, + "id": "UpdateConditionalFormatRuleRequest" + }, + "BasicChartDomain": { + "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date.", + "type": "object", + "properties": { + "domain": { + "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates.", + "$ref": "ChartData" + }, + "reversed": { + "description": "True to reverse the order of the domain values (horizontal axis).", + "type": "boolean" + } + }, + "id": "BasicChartDomain" + }, + "DataValidationRule": { + "properties": { + "showCustomUi": { + "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.", + "type": "boolean" + }, + "strict": { + "description": "True if invalid data should be rejected.", + "type": "boolean" + }, + "inputMessage": { + "description": "A message to show the user when adding data to the cell.", + "type": "string" + }, + "condition": { + "description": "The condition that data in the cell must match.", + "$ref": "BooleanCondition" + } + }, + "id": "DataValidationRule", + "description": "A data validation rule.", + "type": "object" + }, + "PasteDataRequest": { + "description": "Inserts data into the spreadsheet starting at the specified coordinate.", + "type": "object", + "properties": { + "type": { + "description": "How the data should be pasted.", + "type": "string", + "enumDescriptions": [ + "Paste values, formulas, formats, and merges.", + "Paste the values ONLY without formats, formulas, or merges.", + "Paste the format and data validation only.", + "Like PASTE_NORMAL but without borders.", + "Paste the formulas only.", + "Paste the data validation only.", + "Paste the conditional formatting rules only." + ], + "enum": [ + "PASTE_NORMAL", + "PASTE_VALUES", + "PASTE_FORMAT", + "PASTE_NO_BORDERS", + "PASTE_FORMULA", + "PASTE_DATA_VALIDATION", + "PASTE_CONDITIONAL_FORMATTING" + ] + }, + "html": { + "description": "True if the data is HTML.", + "type": "boolean" + }, + "coordinate": { + "$ref": "GridCoordinate", + "description": "The coordinate at which the data should start being inserted." + }, + "data": { + "description": "The data to insert.", + "type": "string" + }, + "delimiter": { + "description": "The delimiter in the data.", + "type": "string" + } + }, + "id": "PasteDataRequest" + }, + "UpdateDeveloperMetadataResponse": { + "description": "The response from updating developer metadata.", + "type": "object", + "properties": { + "developerMetadata": { + "description": "The updated developer metadata.", + "type": "array", + "items": { + "$ref": "DeveloperMetadata" + } + } + }, + "id": "UpdateDeveloperMetadataResponse" + }, + "AppendDimensionRequest": { + "description": "Appends rows or columns to the end of a sheet.", + "type": "object", + "properties": { + "sheetId": { + "description": "The sheet to append rows or columns to.", + "format": "int32", + "type": "integer" + }, + "dimension": { + "enumDescriptions": [ + "The default value, do not use.", + "Operates on the rows of a sheet.", + "Operates on the columns of a sheet." + ], + "enum": [ + "DIMENSION_UNSPECIFIED", + "ROWS", + "COLUMNS" + ], + "description": "Whether rows or columns should be appended.", + "type": "string" + }, + "length": { + "description": "The number of rows or columns to append.", + "format": "int32", + "type": "integer" + } + }, + "id": "AppendDimensionRequest" + }, + "AddNamedRangeRequest": { + "description": "Adds a named range to the spreadsheet.", + "type": "object", + "properties": { + "namedRange": { + "$ref": "NamedRange", + "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)" + } + }, + "id": "AddNamedRangeRequest" + }, + "CreateDeveloperMetadataResponse": { + "description": "The response from creating developer metadata.", + "type": "object", + "properties": { + "developerMetadata": { + "$ref": "DeveloperMetadata", + "description": "The developer metadata that was created." + } + }, + "id": "CreateDeveloperMetadataResponse" + }, + "UpdateEmbeddedObjectPositionRequest": { + "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image).", + "type": "object", + "properties": { + "fields": { + "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "objectId": { + "description": "The ID of the object to moved.", + "format": "int32", + "type": "integer" + }, + "newPosition": { + "$ref": "EmbeddedObjectPosition", + "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you." + } + }, + "id": "UpdateEmbeddedObjectPositionRequest" + }, + "TextRotation": { + "description": "The rotation applied to text in a cell.", + "type": "object", + "properties": { + "vertical": { + "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |", + "type": "boolean" + }, + "angle": { + "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction", + "format": "int32", + "type": "integer" + } + }, + "id": "TextRotation" + }, + "PieChartSpec": { + "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.", + "type": "object", + "properties": { + "series": { + "description": "The data that covers the one and only series of the pie chart.", + "$ref": "ChartData" + }, + "legendPosition": { + "enum": [ + "PIE_CHART_LEGEND_POSITION_UNSPECIFIED", + "BOTTOM_LEGEND", + "LEFT_LEGEND", + "RIGHT_LEGEND", + "TOP_LEGEND", + "NO_LEGEND", + "LABELED_LEGEND" + ], + "description": "Where the legend of the pie chart should be drawn.", + "type": "string", + "enumDescriptions": [ + "Default value, do not use.", + "The legend is rendered on the bottom of the chart.", + "The legend is rendered on the left of the chart.", + "The legend is rendered on the right of the chart.", + "The legend is rendered on the top of the chart.", + "No legend is rendered.", + "Each pie slice has a label attached to it." + ] + }, + "pieHole": { + "description": "The size of the hole in the pie chart.", + "format": "double", + "type": "number" + }, + "domain": { + "$ref": "ChartData", + "description": "The data that covers the domain of the pie chart." + }, + "threeDimensional": { + "description": "True if the pie is three dimensional.", + "type": "boolean" + } + }, + "id": "PieChartSpec" + }, + "UpdateDeveloperMetadataRequest": { + "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.", + "type": "object", + "properties": { + "dataFilters": { + "description": "The filters matching the developer metadata entries to update.", + "type": "array", + "items": { + "$ref": "DataFilter" + } + }, + "fields": { + "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, + "developerMetadata": { + "$ref": "DeveloperMetadata", + "description": "The value that all metadata matched by the data filters will be updated to." + } + }, + "id": "UpdateDeveloperMetadataRequest" + }, + "WaterfallChartColumnStyle": { + "description": "Styles for a waterfall chart column.", + "type": "object", + "properties": { + "color": { + "description": "The color of the column.", + "$ref": "Color" + }, + "label": { + "description": "The label of the column's legend.", + "type": "string" + } + }, + "id": "WaterfallChartColumnStyle" + }, "UpdateFilterViewRequest": { "description": "Updates properties of the filter view.", "type": "object", "properties": { "filter": { - "$ref": "FilterView", - "description": "The new properties of the filter view." + "description": "The new properties of the filter view.", + "$ref": "FilterView" }, "fields": { "description": "The fields that should be updated. At least one field must be specified.\nThe root `filter` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", @@ -21,21 +1296,6 @@ }, "id": "UpdateFilterViewRequest" }, - "WaterfallChartColumnStyle": { - "description": "Styles for a waterfall chart column.", - "type": "object", - "properties": { - "label": { - "description": "The label of the column's legend.", - "type": "string" - }, - "color": { - "description": "The color of the column.", - "$ref": "Color" - } - }, - "id": "WaterfallChartColumnStyle" - }, "ConditionalFormatRule": { "description": "A rule describing a conditional format.", "type": "object", @@ -52,30 +1312,35 @@ } }, "gradientRule": { - "$ref": "GradientRule", - "description": "The formatting will vary based on the gradients in the rule." + "description": "The formatting will vary based on the gradients in the rule.", + "$ref": "GradientRule" } }, "id": "ConditionalFormatRule" }, "CopyPasteRequest": { - "description": "Copies data from the source to the destination.", - "type": "object", "properties": { + "destination": { + "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range).", + "$ref": "GridRange" + }, + "pasteOrientation": { + "enum": [ + "NORMAL", + "TRANSPOSE" + ], + "description": "How that data should be oriented when pasting.", + "type": "string", + "enumDescriptions": [ + "Paste normally.", + "Paste transposed, where all rows become columns and vice versa." + ] + }, "source": { "$ref": "GridRange", "description": "The source range to copy." }, "pasteType": { - "enum": [ - "PASTE_NORMAL", - "PASTE_VALUES", - "PASTE_FORMAT", - "PASTE_NO_BORDERS", - "PASTE_FORMULA", - "PASTE_DATA_VALIDATION", - "PASTE_CONDITIONAL_FORMATTING" - ], "description": "What kind of data to paste.", "type": "string", "enumDescriptions": [ @@ -86,86 +1351,33 @@ "Paste the formulas only.", "Paste the data validation only.", "Paste the conditional formatting rules only." - ] - }, - "destination": { - "description": "The location to paste to. If the range covers a span that's\na multiple of the source's height or width, then the\ndata will be repeated to fill in the destination range.\nIf the range is smaller than the source range, the entire\nsource data will still be copied (beyond the end of the destination range).", - "$ref": "GridRange" - }, - "pasteOrientation": { - "description": "How that data should be oriented when pasting.", - "type": "string", - "enumDescriptions": [ - "Paste normally.", - "Paste transposed, where all rows become columns and vice versa." ], "enum": [ - "NORMAL", - "TRANSPOSE" + "PASTE_NORMAL", + "PASTE_VALUES", + "PASTE_FORMAT", + "PASTE_NO_BORDERS", + "PASTE_FORMULA", + "PASTE_DATA_VALIDATION", + "PASTE_CONDITIONAL_FORMATTING" ] } }, - "id": "CopyPasteRequest" + "id": "CopyPasteRequest", + "description": "Copies data from the source to the destination.", + "type": "object" }, "Request": { "description": "A single kind of update to apply to a spreadsheet.", "type": "object", "properties": { - "sortRange": { - "description": "Sorts data in a range.", - "$ref": "SortRangeRequest" - }, - "deleteProtectedRange": { - "description": "Deletes a protected range.", - "$ref": "DeleteProtectedRangeRequest" - }, - "duplicateFilterView": { - "$ref": "DuplicateFilterViewRequest", - "description": "Duplicates a filter view." - }, - "addChart": { - "$ref": "AddChartRequest", - "description": "Adds a chart." - }, - "findReplace": { - "description": "Finds and replaces occurrences of some text with other text.", - "$ref": "FindReplaceRequest" - }, - "updateChartSpec": { - "$ref": "UpdateChartSpecRequest", - "description": "Updates a chart's specifications." - }, - "textToColumns": { - "description": "Converts a column of text into many columns of text.", - "$ref": "TextToColumnsRequest" - }, - "updateProtectedRange": { - "$ref": "UpdateProtectedRangeRequest", - "description": "Updates a protected range." - }, - "addSheet": { - "description": "Adds a sheet.", - "$ref": "AddSheetRequest" - }, - "copyPaste": { - "description": "Copies data from one area and pastes it to another.", - "$ref": "CopyPasteRequest" - }, - "deleteFilterView": { - "description": "Deletes a filter view from a sheet.", - "$ref": "DeleteFilterViewRequest" - }, - "insertDimension": { - "$ref": "InsertDimensionRequest", - "description": "Inserts new rows or columns in a sheet." - }, "deleteRange": { "$ref": "DeleteRangeRequest", "description": "Deletes a range of cells from a sheet, shifting the remaining cells." }, "deleteBanding": { - "description": "Removes a banded range", - "$ref": "DeleteBandingRequest" + "$ref": "DeleteBandingRequest", + "description": "Removes a banded range" }, "addFilterView": { "$ref": "AddFilterViewRequest", @@ -176,33 +1388,33 @@ "$ref": "UpdateBordersRequest" }, "setDataValidation": { - "$ref": "SetDataValidationRequest", - "description": "Sets data validation for one or more cells." + "description": "Sets data validation for one or more cells.", + "$ref": "SetDataValidationRequest" }, "deleteConditionalFormatRule": { "description": "Deletes an existing conditional format rule.", "$ref": "DeleteConditionalFormatRuleRequest" }, - "repeatCell": { - "$ref": "RepeatCellRequest", - "description": "Repeats a single cell across a range." - }, "clearBasicFilter": { "$ref": "ClearBasicFilterRequest", "description": "Clears the basic filter on a sheet." }, + "repeatCell": { + "$ref": "RepeatCellRequest", + "description": "Repeats a single cell across a range." + }, "appendDimension": { - "$ref": "AppendDimensionRequest", - "description": "Appends dimensions to the end of a sheet." + "description": "Appends dimensions to the end of a sheet.", + "$ref": "AppendDimensionRequest" + }, + "createDeveloperMetadata": { + "description": "Creates new developer metadata", + "$ref": "CreateDeveloperMetadataRequest" }, "updateConditionalFormatRule": { "description": "Updates an existing conditional format rule.", "$ref": "UpdateConditionalFormatRuleRequest" }, - "createDeveloperMetadata": { - "$ref": "CreateDeveloperMetadataRequest", - "description": "Creates new developer metadata" - }, "insertRange": { "description": "Inserts new cells in a sheet, shifting the existing cells.", "$ref": "InsertRangeRequest" @@ -216,8 +1428,8 @@ "description": "Deletes developer metadata" }, "randomizeRange": { - "$ref": "RandomizeRangeRequest", - "description": "Randomizes the order of the rows in a range." + "description": "Randomizes the order of the rows in a range.", + "$ref": "RandomizeRangeRequest" }, "updateBanding": { "$ref": "UpdateBandingRequest", @@ -232,36 +1444,36 @@ "description": "Deletes a named range." }, "duplicateSheet": { - "description": "Duplicates a sheet.", - "$ref": "DuplicateSheetRequest" + "$ref": "DuplicateSheetRequest", + "description": "Duplicates a sheet." + }, + "deleteSheet": { + "$ref": "DeleteSheetRequest", + "description": "Deletes a sheet." }, "unmergeCells": { "description": "Unmerges merged cells.", "$ref": "UnmergeCellsRequest" }, - "deleteSheet": { - "description": "Deletes a sheet.", - "$ref": "DeleteSheetRequest" - }, "updateEmbeddedObjectPosition": { - "$ref": "UpdateEmbeddedObjectPositionRequest", - "description": "Updates an embedded object's (e.g. chart, image) position." - }, - "updateDeveloperMetadata": { - "$ref": "UpdateDeveloperMetadataRequest", - "description": "Updates an existing developer metadata entry" + "description": "Updates an embedded object's (e.g. chart, image) position.", + "$ref": "UpdateEmbeddedObjectPositionRequest" }, "updateDimensionProperties": { "$ref": "UpdateDimensionPropertiesRequest", "description": "Updates dimensions' properties." }, + "updateDeveloperMetadata": { + "description": "Updates an existing developer metadata entry", + "$ref": "UpdateDeveloperMetadataRequest" + }, "pasteData": { "description": "Pastes data (HTML or delimited) into a sheet.", "$ref": "PasteDataRequest" }, "setBasicFilter": { - "$ref": "SetBasicFilterRequest", - "description": "Sets the basic filter on a sheet." + "description": "Sets the basic filter on a sheet.", + "$ref": "SetBasicFilterRequest" }, "addConditionalFormatRule": { "$ref": "AddConditionalFormatRuleRequest", @@ -272,33 +1484,33 @@ "description": "Updates many cells at once." }, "addNamedRange": { - "description": "Adds a named range.", - "$ref": "AddNamedRangeRequest" + "$ref": "AddNamedRangeRequest", + "description": "Adds a named range." }, "updateSpreadsheetProperties": { - "$ref": "UpdateSpreadsheetPropertiesRequest", - "description": "Updates the spreadsheet's properties." + "description": "Updates the spreadsheet's properties.", + "$ref": "UpdateSpreadsheetPropertiesRequest" }, "deleteEmbeddedObject": { "$ref": "DeleteEmbeddedObjectRequest", "description": "Deletes an embedded object (e.g, chart, image) in a sheet." }, "updateFilterView": { - "$ref": "UpdateFilterViewRequest", - "description": "Updates the properties of a filter view." + "description": "Updates the properties of a filter view.", + "$ref": "UpdateFilterViewRequest" }, "addBanding": { "$ref": "AddBandingRequest", "description": "Adds a new banded range" }, - "appendCells": { - "$ref": "AppendCellsRequest", - "description": "Appends cells after the last row with data in a sheet." - }, "autoResizeDimensions": { "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.", "$ref": "AutoResizeDimensionsRequest" }, + "appendCells": { + "description": "Appends cells after the last row with data in a sheet.", + "$ref": "AppendCellsRequest" + }, "cutPaste": { "$ref": "CutPasteRequest", "description": "Cuts data from one area and pastes it to another." @@ -312,23 +1524,69 @@ "$ref": "UpdateNamedRangeRequest" }, "updateSheetProperties": { - "$ref": "UpdateSheetPropertiesRequest", - "description": "Updates a sheet's properties." - }, - "deleteDimension": { - "$ref": "DeleteDimensionRequest", - "description": "Deletes rows or columns in a sheet." + "description": "Updates a sheet's properties.", + "$ref": "UpdateSheetPropertiesRequest" }, "autoFill": { - "$ref": "AutoFillRequest", - "description": "Automatically fills in more data based on existing data." + "description": "Automatically fills in more data based on existing data.", + "$ref": "AutoFillRequest" + }, + "deleteDimension": { + "description": "Deletes rows or columns in a sheet.", + "$ref": "DeleteDimensionRequest" + }, + "sortRange": { + "$ref": "SortRangeRequest", + "description": "Sorts data in a range." + }, + "deleteProtectedRange": { + "$ref": "DeleteProtectedRangeRequest", + "description": "Deletes a protected range." + }, + "duplicateFilterView": { + "description": "Duplicates a filter view.", + "$ref": "DuplicateFilterViewRequest" + }, + "addChart": { + "$ref": "AddChartRequest", + "description": "Adds a chart." + }, + "findReplace": { + "description": "Finds and replaces occurrences of some text with other text.", + "$ref": "FindReplaceRequest" + }, + "textToColumns": { + "description": "Converts a column of text into many columns of text.", + "$ref": "TextToColumnsRequest" + }, + "updateChartSpec": { + "$ref": "UpdateChartSpecRequest", + "description": "Updates a chart's specifications." + }, + "addSheet": { + "description": "Adds a sheet.", + "$ref": "AddSheetRequest" + }, + "updateProtectedRange": { + "$ref": "UpdateProtectedRangeRequest", + "description": "Updates a protected range." + }, + "deleteFilterView": { + "description": "Deletes a filter view from a sheet.", + "$ref": "DeleteFilterViewRequest" + }, + "copyPaste": { + "$ref": "CopyPasteRequest", + "description": "Copies data from one area and pastes it to another." + }, + "insertDimension": { + "$ref": "InsertDimensionRequest", + "description": "Inserts new rows or columns in a sheet." } }, "id": "Request" }, "BooleanCondition": { - "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.", - "type": "object", "properties": { "type": { "enumDescriptions": [ @@ -404,22 +1662,14 @@ } } }, - "id": "BooleanCondition" + "id": "BooleanCondition", + "description": "A condition that can evaluate to true or false.\nBooleanConditions are used by conditional formatting,\ndata validation, and the criteria in filters.", + "type": "object" }, "GridRange": { "description": "A range on a sheet.\nAll indexes are zero-based.\nIndexes are half open, e.g the start index is inclusive\nand the end index is exclusive -- [start_index, end_index).\nMissing indexes indicate the range is unbounded on that side.\n\nFor example, if `\"Sheet1\"` is sheet ID 0, then:\n\n `Sheet1!A1:A1 == sheet_id: 0,\n start_row_index: 0, end_row_index: 1,\n start_column_index: 0, end_column_index: 1`\n\n `Sheet1!A3:B4 == sheet_id: 0,\n start_row_index: 2, end_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A:B == sheet_id: 0,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1!A5:B == sheet_id: 0,\n start_row_index: 4,\n start_column_index: 0, end_column_index: 2`\n\n `Sheet1 == sheet_id:0`\n\nThe start index must always be less than or equal to the end index.\nIf the start index equals the end index, then the range is empty.\nEmpty ranges are typically not meaningful and are usually rendered in the\nUI as `#REF!`.", "type": "object", "properties": { - "startColumnIndex": { - "description": "The start column (inclusive) of the range, or not set if unbounded.", - "format": "int32", - "type": "integer" - }, - "sheetId": { - "description": "The sheet this range is on.", - "format": "int32", - "type": "integer" - }, "endRowIndex": { "description": "The end row (exclusive) of the range, or not set if unbounded.", "format": "int32", @@ -431,9 +1681,19 @@ "type": "integer" }, "startRowIndex": { - "type": "integer", "description": "The start row (inclusive) of the range, or not set if unbounded.", - "format": "int32" + "format": "int32", + "type": "integer" + }, + "startColumnIndex": { + "description": "The start column (inclusive) of the range, or not set if unbounded.", + "format": "int32", + "type": "integer" + }, + "sheetId": { + "description": "The sheet this range is on.", + "format": "int32", + "type": "integer" } }, "id": "GridRange" @@ -442,26 +1702,46 @@ "description": "The domain of a waterfall chart.", "type": "object", "properties": { - "reversed": { - "description": "True to reverse the order of the domain values (horizontal axis).", - "type": "boolean" - }, "data": { "$ref": "ChartData", "description": "The data of the WaterfallChartDomain." + }, + "reversed": { + "description": "True to reverse the order of the domain values (horizontal axis).", + "type": "boolean" } }, "id": "WaterfallChartDomain" }, "BasicChartSpec": { - "id": "BasicChartSpec", "description": "The specification for a basic chart. See BasicChartType for the list\nof charts this supports.", "type": "object", "properties": { - "threeDimensional": { - "description": "True to make the chart 3D.\nApplies to Bar and Column charts.", + "lineSmoothing": { + "description": "Gets whether all lines should be rendered smooth or straight by default.\nApplies to Line charts.", "type": "boolean" }, + "headerCount": { + "description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)", + "format": "int32", + "type": "integer" + }, + "stackedType": { + "enumDescriptions": [ + "Default value, do not use.", + "Series are not stacked.", + "Series values are stacked, each value is rendered vertically beginning\nfrom the top of the value below it.", + "Vertical stacks are stretched to reach the top of the chart, with\nvalues laid out as percentages of each other." + ], + "enum": [ + "BASIC_CHART_STACKED_TYPE_UNSPECIFIED", + "NOT_STACKED", + "STACKED", + "PERCENT_STACKED" + ], + "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.", + "type": "string" + }, "axis": { "description": "The axis on the chart.", "type": "array", @@ -469,11 +1749,13 @@ "$ref": "BasicChartAxis" } }, - "interpolateNulls": { - "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.", + "threeDimensional": { + "description": "True to make the chart 3D.\nApplies to Bar and Column charts.", "type": "boolean" }, "chartType": { + "description": "The type of the chart.", + "type": "string", "enumDescriptions": [ "Default value, do not use.", "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.", @@ -493,9 +1775,11 @@ "SCATTER", "COMBO", "STEPPED_AREA" - ], - "description": "The type of the chart.", - "type": "string" + ] + }, + "interpolateNulls": { + "description": "If some values in a series are missing, gaps may appear in the chart (e.g,\nsegments of lines in a line chart will be missing). To eliminate these\ngaps set this to true.\nApplies to Line, Area, and Combo charts.", + "type": "boolean" }, "series": { "description": "The data this chart is visualizing.", @@ -544,93 +1828,22 @@ "items": { "$ref": "BasicChartDomain" } - }, - "lineSmoothing": { - "description": "Gets whether all lines should be rendered smooth or straight by default.\nApplies to Line charts.", - "type": "boolean" - }, - "headerCount": { - "description": "The number of rows or columns in the data that are \"headers\".\nIf not set, Google Sheets will guess how many rows are headers based\non the data.\n\n(Note that BasicChartAxis.title may override the axis title\n inferred from the header values.)", - "format": "int32", - "type": "integer" - }, - "stackedType": { - "enumDescriptions": [ - "Default value, do not use.", - "Series are not stacked.", - "Series values are stacked, each value is rendered vertically beginning\nfrom the top of the value below it.", - "Vertical stacks are stretched to reach the top of the chart, with\nvalues laid out as percentages of each other." - ], - "enum": [ - "BASIC_CHART_STACKED_TYPE_UNSPECIFIED", - "NOT_STACKED", - "STACKED", - "PERCENT_STACKED" - ], - "description": "The stacked type for charts that support vertical stacking.\nApplies to Area, Bar, Column, and Stepped Area charts.", - "type": "string" } - } - }, - "SetDataValidationRequest": { - "id": "SetDataValidationRequest", - "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.", - "type": "object", - "properties": { - "rule": { - "$ref": "DataValidationRule", - "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range." - }, - "range": { - "description": "The range the data validation rule should apply to.", - "$ref": "GridRange" - } - } + }, + "id": "BasicChartSpec" }, "BubbleChartSpec": { + "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.", + "type": "object", "properties": { - "domain": { - "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.", - "$ref": "ChartData" - }, - "bubbleOpacity": { - "description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.", - "format": "float", - "type": "number" - }, - "bubbleSizes": { - "$ref": "ChartData", - "description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional." - }, - "bubbleBorderColor": { - "$ref": "Color", - "description": "The bubble border color." - }, - "bubbleTextStyle": { - "$ref": "TextFormat", - "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported." - }, - "groupIds": { - "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional.", - "$ref": "ChartData" - }, - "bubbleLabels": { - "description": "The data containing the bubble labels. These do not need to be unique.", - "$ref": "ChartData" - }, - "bubbleMinRadiusSize": { - "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.", - "format": "int32", - "type": "integer" - }, "bubbleMaxRadiusSize": { "description": "The max radius size of the bubbles, in pixels.\nIf specified, the field must be a positive value.", "format": "int32", "type": "integer" }, "series": { - "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically.", - "$ref": "ChartData" + "$ref": "ChartData", + "description": "The data contianing the bubble y-values. These values locate the bubbles\nin the chart vertically." }, "legendPosition": { "description": "Where the legend of the chart should be drawn.", @@ -653,39 +1866,93 @@ "NO_LEGEND", "INSIDE_LEGEND" ] + }, + "domain": { + "description": "The data containing the bubble x-values. These values locate the bubbles\nin the chart horizontally.", + "$ref": "ChartData" + }, + "bubbleSizes": { + "$ref": "ChartData", + "description": "The data contianing the bubble sizes. Bubble sizes are used to draw\nthe bubbles at different sizes relative to each other.\nIf specified, group_ids must also be specified. This field is\noptional." + }, + "bubbleOpacity": { + "description": "The opacity of the bubbles between 0 and 1.0.\n0 is fully transparent and 1 is fully opaque.", + "format": "float", + "type": "number" + }, + "bubbleBorderColor": { + "description": "The bubble border color.", + "$ref": "Color" + }, + "bubbleTextStyle": { + "description": "The format of the text inside the bubbles.\nUnderline and Strikethrough are not supported.", + "$ref": "TextFormat" + }, + "groupIds": { + "description": "The data containing the bubble group IDs. All bubbles with the same group\nID will be drawn in the same color. If bubble_sizes is specified then\nthis field must also be specified but may contain blank values.\nThis field is optional.", + "$ref": "ChartData" + }, + "bubbleLabels": { + "$ref": "ChartData", + "description": "The data containing the bubble labels. These do not need to be unique." + }, + "bubbleMinRadiusSize": { + "description": "The minimum radius size of the bubbles, in pixels.\nIf specific, the field must be a positive value.", + "format": "int32", + "type": "integer" } }, - "id": "BubbleChartSpec", - "description": "A \u003ca href=\"/chart/interactive/docs/gallery/bubblechart\"\u003ebubble chart\u003c/a\u003e.", - "type": "object" + "id": "BubbleChartSpec" }, - "CellData": { + "SetDataValidationRequest": { + "description": "Sets a data validation rule to every cell in the range.\nTo clear validation in a range, call this with no rule specified.", "type": "object", "properties": { - "userEnteredFormat": { - "$ref": "CellFormat", - "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format." + "rule": { + "description": "The data validation rule to set on each cell in the range,\nor empty to clear the data validation in the range.", + "$ref": "DataValidationRule" }, - "effectiveFormat": { - "$ref": "CellFormat", - "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only." + "range": { + "$ref": "GridRange", + "description": "The range the data validation rule should apply to." + } + }, + "id": "SetDataValidationRequest" + }, + "CellData": { + "properties": { + "pivotTable": { + "$ref": "PivotTable", + "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields." + }, + "userEnteredFormat": { + "description": "The format the user entered for the cell.\n\nWhen writing, the new format will be merged with the existing format.", + "$ref": "CellFormat" }, "note": { "description": "Any note on the cell.", "type": "string" }, - "userEnteredValue": { - "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format.", - "$ref": "ExtendedValue" + "effectiveFormat": { + "$ref": "CellFormat", + "description": "The effective format being used by the cell.\nThis includes the results of applying any conditional formatting and,\nif the cell contains a formula, the computed number format.\nIf the effective format is the default format, effective format will\nnot be written.\nThis field is read-only." }, "dataValidation": { "description": "A data validation rule on the cell, if any.\n\nWhen writing, the new data validation rule will overwrite any prior rule.", "$ref": "DataValidationRule" }, + "userEnteredValue": { + "$ref": "ExtendedValue", + "description": "The value the user entered in the cell. e.g, `1234`, `'Hello'`, or `=NOW()`\nNote: Dates, Times and DateTimes are represented as doubles in\nserial number format." + }, "effectiveValue": { "$ref": "ExtendedValue", "description": "The effective value of the cell. For cells with formulas, this will be\nthe calculated value. For cells with literals, this will be\nthe same as the user_entered_value.\nThis field is read-only." }, + "formattedValue": { + "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.", + "type": "string" + }, "textFormatRuns": { "description": "Runs of rich text applied to subsections of the cell. Runs are only valid\non user entered strings, not formulas, bools, or numbers.\nRuns start at specific indexes in the text and continue until the next\nrun. Properties of a run will continue unless explicitly changed\nin a subsequent run (and properties of the first run will continue\nthe properties of the cell unless explicitly changed).\n\nWhen writing, the new runs will overwrite any prior runs. When writing a\nnew user_entered_value, previous runs will be erased.", "type": "array", @@ -693,86 +1960,22 @@ "$ref": "TextFormatRun" } }, - "formattedValue": { - "description": "The formatted value of the cell.\nThis is the value as it's shown to the user.\nThis field is read-only.", - "type": "string" - }, "hyperlink": { "description": "A hyperlink this cell points to, if any.\nThis field is read-only. (To set it, use a `=HYPERLINK` formula\nin the userEnteredValue.formulaValue\nfield.)", "type": "string" - }, - "pivotTable": { - "description": "A pivot table anchored at this cell. The size of pivot table itself\nis computed dynamically based on its data, grouping, filters, values,\netc. Only the top-left cell of the pivot table contains the pivot table\ndefinition. The other cells will contain the calculated values of the\nresults of the pivot in their effective_value fields.", - "$ref": "PivotTable" } }, "id": "CellData", - "description": "Data about a specific cell." - }, - "BatchUpdateValuesByDataFilterRequest": { - "properties": { - "responseValueRenderOption": { - "enum": [ - "FORMATTED_VALUE", - "UNFORMATTED_VALUE", - "FORMULA" - ], - "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", - "type": "string", - "enumDescriptions": [ - "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", - "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`." - ] - }, - "includeValuesInResponse": { - "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).", - "type": "boolean" - }, - "valueInputOption": { - "enumDescriptions": [ - "Default input value. This value must not be used.", - "The values the user has entered will not be parsed and will be stored\nas-is.", - "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI." - ], - "enum": [ - "INPUT_VALUE_OPTION_UNSPECIFIED", - "RAW", - "USER_ENTERED" - ], - "description": "How the input data should be interpreted.", - "type": "string" - }, - "data": { - "type": "array", - "items": { - "$ref": "DataFilterValueRange" - }, - "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges." - }, - "responseDateTimeRenderOption": { - "enum": [ - "SERIAL_NUMBER", - "FORMATTED_STRING" - ], - "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.", - "type": "string", - "enumDescriptions": [ - "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.", - "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)." - ] - } - }, - "id": "BatchUpdateValuesByDataFilterRequest", - "description": "The request for updating more than one range of values in a spreadsheet.", + "description": "Data about a specific cell.", "type": "object" }, "TextPosition": { - "id": "TextPosition", "description": "Position settings for text.", "type": "object", "properties": { "horizontalAlignment": { + "description": "Horizontal alignment setting for the piece of text.", + "type": "string", "enumDescriptions": [ "The horizontal alignment is not specified. Do not use this.", "The text is explicitly aligned to the left of the cell.", @@ -784,11 +1987,68 @@ "LEFT", "CENTER", "RIGHT" + ] + } + }, + "id": "TextPosition" + }, + "BatchUpdateValuesByDataFilterRequest": { + "description": "The request for updating more than one range of values in a spreadsheet.", + "type": "object", + "properties": { + "responseValueRenderOption": { + "enumDescriptions": [ + "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", + "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.", + "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`." ], - "description": "Horizontal alignment setting for the piece of text.", + "enum": [ + "FORMATTED_VALUE", + "UNFORMATTED_VALUE", + "FORMULA" + ], + "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", + "type": "string" + }, + "includeValuesInResponse": { + "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).", + "type": "boolean" + }, + "valueInputOption": { + "enum": [ + "INPUT_VALUE_OPTION_UNSPECIFIED", + "RAW", + "USER_ENTERED" + ], + "description": "How the input data should be interpreted.", + "type": "string", + "enumDescriptions": [ + "Default input value. This value must not be used.", + "The values the user has entered will not be parsed and will be stored\nas-is.", + "The values will be parsed as if the user typed them into the UI.\nNumbers will stay as numbers, but strings may be converted to numbers,\ndates, etc. following the same rules that are applied when entering\ntext into a cell via the Google Sheets UI." + ] + }, + "data": { + "description": "The new values to apply to the spreadsheet. If more than one range is\nmatched by the specified DataFilter the specified values will be\napplied to all of those ranges.", + "type": "array", + "items": { + "$ref": "DataFilterValueRange" + } + }, + "responseDateTimeRenderOption": { + "enumDescriptions": [ + "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.", + "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)." + ], + "enum": [ + "SERIAL_NUMBER", + "FORMATTED_STRING" + ], + "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.", "type": "string" } - } + }, + "id": "BatchUpdateValuesByDataFilterRequest" }, "BatchUpdateSpreadsheetRequest": { "description": "The request for updating any aspect of a spreadsheet.", @@ -799,22 +2059,22 @@ "type": "boolean" }, "responseRanges": { + "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'.", "type": "array", "items": { "type": "string" - }, - "description": "Limits the ranges included in the response spreadsheet.\nMeaningful only if include_spreadsheet_response is 'true'." + } }, "responseIncludeGridData": { "description": "True if grid data should be returned. Meaningful only if\nif include_spreadsheet_response is 'true'.\nThis parameter is ignored if a field mask was set in the request.", "type": "boolean" }, "requests": { + "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied.", "type": "array", "items": { "$ref": "Request" - }, - "description": "A list of updates to apply to the spreadsheet.\nRequests will be applied in the order they are specified.\nIf any request is not valid, no requests will be applied." + } } }, "id": "BatchUpdateSpreadsheetRequest" @@ -823,16 +2083,6 @@ "description": "The amount of padding around the cell, in pixels.\nWhen updating padding, every field must be specified.", "type": "object", "properties": { - "top": { - "description": "The top padding of the cell.", - "format": "int32", - "type": "integer" - }, - "left": { - "description": "The left padding of the cell.", - "format": "int32", - "type": "integer" - }, "right": { "description": "The right padding of the cell.", "format": "int32", @@ -842,16 +2092,24 @@ "description": "The bottom padding of the cell.", "format": "int32", "type": "integer" + }, + "top": { + "description": "The top padding of the cell.", + "format": "int32", + "type": "integer" + }, + "left": { + "description": "The left padding of the cell.", + "format": "int32", + "type": "integer" } }, "id": "Padding" }, "BasicChartAxis": { + "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.", + "type": "object", "properties": { - "format": { - "$ref": "TextFormat", - "description": "The format of the title.\nOnly valid if the axis is not associated with the domain." - }, "position": { "enumDescriptions": [ "Default value, do not use.", @@ -873,13 +2131,15 @@ "type": "string" }, "titleTextPosition": { - "$ref": "TextPosition", - "description": "The axis title text position." + "description": "The axis title text position.", + "$ref": "TextPosition" + }, + "format": { + "description": "The format of the title.\nOnly valid if the axis is not associated with the domain.", + "$ref": "TextFormat" } }, - "id": "BasicChartAxis", - "description": "An axis of the chart.\nA chart may not have more than one axis per\naxis position.", - "type": "object" + "id": "BasicChartAxis" }, "DeleteDimensionRequest": { "description": "Deletes the dimensions from the sheet.", @@ -944,22 +2204,20 @@ } }, "valueRenderOption": { + "enumDescriptions": [ + "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", + "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.", + "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`." + ], "enum": [ "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA" ], "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", - "type": "string", - "enumDescriptions": [ - "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", - "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`." - ] + "type": "string" }, "dateTimeRenderOption": { - "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].", - "type": "string", "enumDescriptions": [ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.", "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)." @@ -967,21 +2225,23 @@ "enum": [ "SERIAL_NUMBER", "FORMATTED_STRING" - ] + ], + "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].", + "type": "string" }, "majorDimension": { - "enumDescriptions": [ - "The default value, do not use.", - "Operates on the rows of a sheet.", - "Operates on the columns of a sheet." - ], "enum": [ "DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS" ], "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen a request that selects that range and sets `majorDimension=ROWS` will\nreturn `[[1,2],[3,4]]`,\nwhereas a request that sets `majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "The default value, do not use.", + "Operates on the rows of a sheet.", + "Operates on the columns of a sheet." + ] } }, "id": "BatchGetValuesByDataFilterRequest", @@ -989,11 +2249,23 @@ "type": "object" }, "BatchUpdateValuesResponse": { + "description": "The response when updating a range of values in a spreadsheet.", + "type": "object", "properties": { + "totalUpdatedSheets": { + "description": "The total number of sheets where at least one cell in the sheet was\nupdated.", + "format": "int32", + "type": "integer" + }, + "totalUpdatedCells": { + "description": "The total number of cells updated.", + "format": "int32", + "type": "integer" + }, "totalUpdatedColumns": { - "type": "integer", "description": "The total number of columns where at least one cell in the column was\nupdated.", - "format": "int32" + "format": "int32", + "type": "integer" }, "spreadsheetId": { "description": "The spreadsheet the updates were applied to.", @@ -1010,21 +2282,9 @@ "items": { "$ref": "UpdateValuesResponse" } - }, - "totalUpdatedSheets": { - "description": "The total number of sheets where at least one cell in the sheet was\nupdated.", - "format": "int32", - "type": "integer" - }, - "totalUpdatedCells": { - "description": "The total number of cells updated.", - "format": "int32", - "type": "integer" } }, - "id": "BatchUpdateValuesResponse", - "description": "The response when updating a range of values in a spreadsheet.", - "type": "object" + "id": "BatchUpdateValuesResponse" }, "SortRangeRequest": { "description": "Sorts data in rows based on a sort order per column.", @@ -1045,8 +2305,6 @@ "id": "SortRangeRequest" }, "MergeCellsRequest": { - "description": "Merges all cells in the range.", - "type": "object", "properties": { "mergeType": { "description": "How the cells should be merged.", @@ -1067,7 +2325,9 @@ "description": "The range of cells to merge." } }, - "id": "MergeCellsRequest" + "id": "MergeCellsRequest", + "description": "Merges all cells in the range.", + "type": "object" }, "MatchedDeveloperMetadata": { "description": "A developer metadata entry and the data filters specified in the original\nrequest that matched it.", @@ -1081,8 +2341,8 @@ } }, "developerMetadata": { - "description": "The developer metadata matching the specified filters.", - "$ref": "DeveloperMetadata" + "$ref": "DeveloperMetadata", + "description": "The developer metadata matching the specified filters." } }, "id": "MatchedDeveloperMetadata" @@ -1112,26 +2372,10 @@ }, "id": "BatchClearValuesRequest" }, - "DuplicateFilterViewResponse": { - "description": "The result of a filter view being duplicated.", - "type": "object", - "properties": { - "filter": { - "description": "The newly created filter.", - "$ref": "FilterView" - } - }, - "id": "DuplicateFilterViewResponse" - }, "DeveloperMetadata": { - "id": "DeveloperMetadata", "description": "Developer metadata associated with a location or object in a spreadsheet.\nDeveloper metadata may be used to associate arbitrary data with various\nparts of a spreadsheet and will remain associated at those locations as they\nmove around and the spreadsheet is edited. For example, if developer\nmetadata is associated with row 5 and another row is then subsequently\ninserted above row 5, that original metadata will still be associated with\nthe row it was first associated with (what is now row 6). If the associated\nobject is deleted its metadata will be deleted too.", "type": "object", "properties": { - "metadataValue": { - "description": "Data associated with the metadata's key.", - "type": "string" - }, "metadataKey": { "description": "The metadata key. There may be multiple metadata in a spreadsheet with the\nsame key. Developer metadata must always have a key specified.", "type": "string" @@ -1146,6 +2390,7 @@ "$ref": "DeveloperMetadataLocation" }, "visibility": { + "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified.", "type": "string", "enumDescriptions": [ "Default value.", @@ -1156,31 +2401,60 @@ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED", "DOCUMENT", "PROJECT" - ], - "description": "The metadata visibility. Developer metadata must always have a visibility\nspecified." + ] + }, + "metadataValue": { + "description": "Data associated with the metadata's key.", + "type": "string" } - } + }, + "id": "DeveloperMetadata" + }, + "DuplicateFilterViewResponse": { + "description": "The result of a filter view being duplicated.", + "type": "object", + "properties": { + "filter": { + "$ref": "FilterView", + "description": "The newly created filter." + } + }, + "id": "DuplicateFilterViewResponse" }, "DuplicateSheetResponse": { - "description": "The result of duplicating a sheet.", - "type": "object", "properties": { "properties": { "description": "The properties of the duplicate sheet.", "$ref": "SheetProperties" } }, - "id": "DuplicateSheetResponse" + "id": "DuplicateSheetResponse", + "description": "The result of duplicating a sheet.", + "type": "object" + }, + "ClearBasicFilterRequest": { + "description": "Clears the basic filter, if any exists on the sheet.", + "type": "object", + "properties": { + "sheetId": { + "description": "The sheet ID on which the basic filter should be cleared.", + "format": "int32", + "type": "integer" + } + }, + "id": "ClearBasicFilterRequest" }, "TextToColumnsRequest": { "description": "Splits a column of text into multiple columns,\nbased on a delimiter in each cell.", "type": "object", "properties": { "source": { - "$ref": "GridRange", - "description": "The source data range. This must span exactly one column." + "description": "The source data range. This must span exactly one column.", + "$ref": "GridRange" }, "delimiterType": { + "description": "The delimiter type to use.", + "type": "string", "enumDescriptions": [ "Default value. This value must not be used.", "\",\"", @@ -1196,9 +2470,7 @@ "PERIOD", "SPACE", "CUSTOM" - ], - "description": "The delimiter type to use.", - "type": "string" + ] }, "delimiter": { "description": "The delimiter to use. Used only if delimiterType is\nCUSTOM.", @@ -1207,86 +2479,72 @@ }, "id": "TextToColumnsRequest" }, - "ClearBasicFilterRequest": { - "description": "Clears the basic filter, if any exists on the sheet.", + "DeleteBandingRequest": { + "description": "Removes the banded range with the given ID from the spreadsheet.", "type": "object", "properties": { - "sheetId": { - "description": "The sheet ID on which the basic filter should be cleared.", + "bandedRangeId": { + "description": "The ID of the banded range to delete.", "format": "int32", "type": "integer" } }, - "id": "ClearBasicFilterRequest" + "id": "DeleteBandingRequest" }, "BatchUpdateSpreadsheetResponse": { - "description": "The reply for batch updating a spreadsheet.", - "type": "object", "properties": { "replies": { + "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty.", "type": "array", "items": { "$ref": "Response" - }, - "description": "The reply of the updates. This maps 1:1 with the updates, although\nreplies to some requests may be empty." + } }, "updatedSpreadsheet": { "$ref": "Spreadsheet", "description": "The spreadsheet after updates were applied. This is only set if\n[BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response] is `true`." }, "spreadsheetId": { - "type": "string", - "description": "The spreadsheet the updates were applied to." + "description": "The spreadsheet the updates were applied to.", + "type": "string" } }, - "id": "BatchUpdateSpreadsheetResponse" - }, - "DeleteBandingRequest": { - "description": "Removes the banded range with the given ID from the spreadsheet.", - "type": "object", - "properties": { - "bandedRangeId": { - "type": "integer", - "description": "The ID of the banded range to delete.", - "format": "int32" - } - }, - "id": "DeleteBandingRequest" + "id": "BatchUpdateSpreadsheetResponse", + "description": "The reply for batch updating a spreadsheet.", + "type": "object" }, "AppendValuesResponse": { + "description": "The response when updating a range of values in a spreadsheet.", + "type": "object", "properties": { - "tableRange": { - "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.", - "type": "string" - }, "spreadsheetId": { "description": "The spreadsheet the updates were applied to.", "type": "string" }, "updates": { - "$ref": "UpdateValuesResponse", - "description": "Information about the updates that were applied." + "description": "Information about the updates that were applied.", + "$ref": "UpdateValuesResponse" + }, + "tableRange": { + "description": "The range (in A1 notation) of the table that values are being appended to\n(before the values were appended).\nEmpty if no table was found.", + "type": "string" } }, - "id": "AppendValuesResponse", - "description": "The response when updating a range of values in a spreadsheet.", - "type": "object" + "id": "AppendValuesResponse" }, - "MoveDimensionRequest": { - "description": "Moves one or more rows or columns.", + "PivotFilterCriteria": { + "description": "Criteria for showing/hiding rows in a pivot table.", "type": "object", "properties": { - "destinationIndex": { - "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.", - "format": "int32", - "type": "integer" - }, - "source": { - "$ref": "DimensionRange", - "description": "The source dimensions to move." + "visibleValues": { + "description": "Values that should be included. Values not listed here are excluded.", + "type": "array", + "items": { + "type": "string" + } } }, - "id": "MoveDimensionRequest" + "id": "PivotFilterCriteria" }, "AddFilterViewRequest": { "description": "Adds a filter view.", @@ -1299,63 +2557,42 @@ }, "id": "AddFilterViewRequest" }, - "PivotFilterCriteria": { - "id": "PivotFilterCriteria", - "description": "Criteria for showing/hiding rows in a pivot table.", - "type": "object", + "MoveDimensionRequest": { "properties": { - "visibleValues": { - "description": "Values that should be included. Values not listed here are excluded.", - "type": "array", - "items": { - "type": "string" - } + "destinationIndex": { + "description": "The zero-based start index of where to move the source data to,\nbased on the coordinates *before* the source data is removed\nfrom the grid. Existing data will be shifted down or right\n(depending on the dimension) to make room for the moved dimensions.\nThe source dimensions are removed from the grid, so the\nthe data may end up in a different index than specified.\n\nFor example, given `A1..A5` of `0, 1, 2, 3, 4` and wanting to move\n`\"1\"` and `\"2\"` to between `\"3\"` and `\"4\"`, the source would be\n`ROWS [1..3)`,and the destination index would be `\"4\"`\n(the zero-based index of row 5).\nThe end result would be `A1..A5` of `0, 3, 1, 2, 4`.", + "format": "int32", + "type": "integer" + }, + "source": { + "description": "The source dimensions to move.", + "$ref": "DimensionRange" } - } + }, + "id": "MoveDimensionRequest", + "description": "Moves one or more rows or columns.", + "type": "object" }, "AddConditionalFormatRuleRequest": { "description": "Adds a new conditional format rule at the given index.\nAll subsequent rules' indexes are incremented.", "type": "object", "properties": { - "index": { - "type": "integer", - "description": "The zero-based index where the rule should be inserted.", - "format": "int32" - }, "rule": { "description": "The rule to add.", "$ref": "ConditionalFormatRule" + }, + "index": { + "description": "The zero-based index where the rule should be inserted.", + "format": "int32", + "type": "integer" } }, "id": "AddConditionalFormatRuleRequest" }, - "CreateDeveloperMetadataRequest": { - "description": "A request to create developer metadata.", - "type": "object", - "properties": { - "developerMetadata": { - "$ref": "DeveloperMetadata", - "description": "The developer metadata to create." - } - }, - "id": "CreateDeveloperMetadataRequest" - }, "ChartSpec": { "description": "The specifications of a chart.", "type": "object", "properties": { - "bubbleChart": { - "description": "A bubble chart specification.", - "$ref": "BubbleChartSpec" - }, - "waterfallChart": { - "$ref": "WaterfallChartSpec", - "description": "A waterfall chart specification." - }, - "fontName": { - "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.", - "type": "string" - }, "maximized": { "description": "True to make a chart fill the entire space in which it's rendered with\nminimum padding. False to use the default padding.\n(Not applicable to Geo and Org charts.)", "type": "boolean" @@ -1379,8 +2616,8 @@ "type": "string" }, "subtitleTextFormat": { - "$ref": "TextFormat", - "description": "The subtitle text format.\nStrikethrough and underline are not supported." + "description": "The subtitle text format.\nStrikethrough and underline are not supported.", + "$ref": "TextFormat" }, "subtitle": { "description": "The subtitle of the chart.", @@ -1391,106 +2628,128 @@ "description": "The background color of the entire chart.\nNot applicable to Org charts." }, "subtitleTextPosition": { - "$ref": "TextPosition", - "description": "The subtitle text position.\nThis field is optional." + "description": "The subtitle text position.\nThis field is optional.", + "$ref": "TextPosition" }, "basicChart": { "$ref": "BasicChartSpec", "description": "A basic chart specification, can be one of many kinds of charts.\nSee BasicChartType for the list of all\ncharts this supports." }, "orgChart": { - "description": "An org chart specification.", - "$ref": "OrgChartSpec" + "$ref": "OrgChartSpec", + "description": "An org chart specification." }, "pieChart": { - "$ref": "PieChartSpec", - "description": "A pie chart specification." + "description": "A pie chart specification.", + "$ref": "PieChartSpec" }, "titleTextFormat": { "$ref": "TextFormat", "description": "The title text format.\nStrikethrough and underline are not supported." }, "title": { - "type": "string", - "description": "The title of the chart." + "description": "The title of the chart.", + "type": "string" }, "altText": { "description": "The alternative text that describes the chart. This is often used\nfor accessibility.", "type": "string" }, "titleTextPosition": { - "$ref": "TextPosition", - "description": "The title text position.\nThis field is optional." + "description": "The title text position.\nThis field is optional.", + "$ref": "TextPosition" }, "histogramChart": { - "description": "A histogram chart specification.", - "$ref": "HistogramChartSpec" + "$ref": "HistogramChartSpec", + "description": "A histogram chart specification." }, "candlestickChart": { - "$ref": "CandlestickChartSpec", - "description": "A candlestick chart specification." + "description": "A candlestick chart specification.", + "$ref": "CandlestickChartSpec" + }, + "bubbleChart": { + "$ref": "BubbleChartSpec", + "description": "A bubble chart specification." + }, + "waterfallChart": { + "$ref": "WaterfallChartSpec", + "description": "A waterfall chart specification." + }, + "fontName": { + "description": "The name of the font to use by default for all chart text (e.g. title,\naxis labels, legend). If a font is specified for a specific part of the\nchart it will override this font name.", + "type": "string" } }, "id": "ChartSpec" }, + "CreateDeveloperMetadataRequest": { + "description": "A request to create developer metadata.", + "type": "object", + "properties": { + "developerMetadata": { + "description": "The developer metadata to create.", + "$ref": "DeveloperMetadata" + } + }, + "id": "CreateDeveloperMetadataRequest" + }, "BatchGetValuesByDataFilterResponse": { "description": "The response when retrieving more than one range of values in a spreadsheet\nselected by DataFilters.", "type": "object", "properties": { - "spreadsheetId": { - "description": "The ID of the spreadsheet the data was retrieved from.", - "type": "string" - }, "valueRanges": { "description": "The requested values with the list of data filters that matched them.", "type": "array", "items": { "$ref": "MatchedValueRange" } + }, + "spreadsheetId": { + "description": "The ID of the spreadsheet the data was retrieved from.", + "type": "string" } }, "id": "BatchGetValuesByDataFilterResponse" }, - "NumberFormat": { - "description": "The number format of a cell.", + "LineStyle": { + "description": "Properties that describe the style of a line.", "type": "object", "properties": { - "pattern": { - "type": "string", - "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns." + "width": { + "description": "The thickness of the line, in px.", + "format": "int32", + "type": "integer" }, "type": { "enumDescriptions": [ - "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.", - "Text formatting, e.g `1000.12`", - "Number formatting, e.g, `1,000.12`", - "Percent formatting, e.g `10.12%`", - "Currency formatting, e.g `$1,000.12`", - "Date formatting, e.g `9/26/2008`", - "Time formatting, e.g `3:59:00 PM`", - "Date+Time formatting, e.g `9/26/08 15:59:00`", - "Scientific number formatting, e.g `1.01E+03`" + "Default value, do not use.", + "No dash type, which is equivalent to a non-visible line.", + "A custom dash for a line. Modifying the exact custom dash style is\ncurrently unsupported.", + "A solid line.", + "A dotted line.", + "A dashed line where the dashes have \"medium\" length.", + "A line that alternates between a \"medium\" dash and a dot.", + "A dashed line where the dashes have \"long\" length.", + "A line that alternates between a \"long\" dash and a dot." ], "enum": [ - "NUMBER_FORMAT_TYPE_UNSPECIFIED", - "TEXT", - "NUMBER", - "PERCENT", - "CURRENCY", - "DATE", - "TIME", - "DATE_TIME", - "SCIENTIFIC" + "LINE_DASH_TYPE_UNSPECIFIED", + "INVISIBLE", + "CUSTOM", + "SOLID", + "DOTTED", + "MEDIUM_DASHED", + "MEDIUM_DASHED_DOTTED", + "LONG_DASHED", + "LONG_DASHED_DOTTED" ], - "description": "The type of the number format.\nWhen writing, this field must be set.", + "description": "The dash type of the line.", "type": "string" } }, - "id": "NumberFormat" + "id": "LineStyle" }, "DataFilterValueRange": { - "description": "A range of values whose location is specified by a DataFilter.", - "type": "object", "properties": { "dataFilter": { "description": "The data filter describing the location of the values in the spreadsheet.", @@ -1521,49 +2780,48 @@ } } }, - "id": "DataFilterValueRange" + "id": "DataFilterValueRange", + "description": "A range of values whose location is specified by a DataFilter.", + "type": "object" }, - "LineStyle": { - "description": "Properties that describe the style of a line.", - "type": "object", + "NumberFormat": { "properties": { "type": { - "description": "The dash type of the line.", - "type": "string", "enumDescriptions": [ - "Default value, do not use.", - "No dash type, which is equivalent to a non-visible line.", - "A custom dash for a line. Modifying the exact custom dash style is\ncurrently unsupported.", - "A solid line.", - "A dotted line.", - "A dashed line where the dashes have \"medium\" length.", - "A line that alternates between a \"medium\" dash and a dot.", - "A dashed line where the dashes have \"long\" length.", - "A line that alternates between a \"long\" dash and a dot." + "The number format is not specified\nand is based on the contents of the cell.\nDo not explicitly use this.", + "Text formatting, e.g `1000.12`", + "Number formatting, e.g, `1,000.12`", + "Percent formatting, e.g `10.12%`", + "Currency formatting, e.g `$1,000.12`", + "Date formatting, e.g `9/26/2008`", + "Time formatting, e.g `3:59:00 PM`", + "Date+Time formatting, e.g `9/26/08 15:59:00`", + "Scientific number formatting, e.g `1.01E+03`" ], "enum": [ - "LINE_DASH_TYPE_UNSPECIFIED", - "INVISIBLE", - "CUSTOM", - "SOLID", - "DOTTED", - "MEDIUM_DASHED", - "MEDIUM_DASHED_DOTTED", - "LONG_DASHED", - "LONG_DASHED_DOTTED" - ] + "NUMBER_FORMAT_TYPE_UNSPECIFIED", + "TEXT", + "NUMBER", + "PERCENT", + "CURRENCY", + "DATE", + "TIME", + "DATE_TIME", + "SCIENTIFIC" + ], + "description": "The type of the number format.\nWhen writing, this field must be set.", + "type": "string" }, - "width": { - "description": "The thickness of the line, in px.", - "format": "int32", - "type": "integer" + "pattern": { + "description": "Pattern string used for formatting. If not set, a default pattern based on\nthe user's locale will be used if necessary for the given type.\nSee the [Date and Number Formats guide](/sheets/api/guides/formats) for more\ninformation about the supported patterns.", + "type": "string" } }, - "id": "LineStyle" + "id": "NumberFormat", + "description": "The number format of a cell.", + "type": "object" }, "CandlestickDomain": { - "description": "The domain of a CandlestickChart.", - "type": "object", "properties": { "data": { "$ref": "ChartData", @@ -1574,7 +2832,9 @@ "type": "boolean" } }, - "id": "CandlestickDomain" + "id": "CandlestickDomain", + "description": "The domain of a CandlestickChart.", + "type": "object" }, "SheetProperties": { "description": "Properties of a sheet.", @@ -1585,8 +2845,8 @@ "type": "string" }, "tabColor": { - "description": "The color of the tab in the UI.", - "$ref": "Color" + "$ref": "Color", + "description": "The color of the tab in the UI." }, "index": { "description": "The index of the sheet within the spreadsheet.\nWhen adding or updating sheet properties, if this field\nis excluded then the sheet will be added or moved to the end\nof the sheet list. When updating sheet indices or inserting\nsheets, movement is considered in \"before the move\" indexes.\nFor example, if there were 3 sheets (S1, S2, S3) in order to\nmove S1 ahead of S2 the index would have to be set to 2. A sheet\nindex update request will be ignored if the requested index is\nidentical to the sheets current index or if the requested new\nindex is equal to the current sheet index + 1.", @@ -1606,9 +2866,11 @@ "description": "True if the sheet is hidden in the UI, false if it's visible.", "type": "boolean" }, + "gridProperties": { + "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets.", + "$ref": "GridProperties" + }, "sheetType": { - "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.", - "type": "string", "enumDescriptions": [ "Default value, do not use.", "The sheet is a grid.", @@ -1618,20 +2880,22 @@ "SHEET_TYPE_UNSPECIFIED", "GRID", "OBJECT" - ] - }, - "gridProperties": { - "$ref": "GridProperties", - "description": "Additional properties of the sheet if this sheet is a grid.\n(If the sheet is an object sheet, containing a chart or image, then\nthis field will be absent.)\nWhen writing it is an error to set any grid properties on non-grid sheets." + ], + "description": "The type of sheet. Defaults to GRID.\nThis field cannot be changed once set.", + "type": "string" } }, "id": "SheetProperties" }, "UpdateDimensionPropertiesRequest": { - "id": "UpdateDimensionPropertiesRequest", "description": "Updates properties of dimensions within the specified range.", "type": "object", "properties": { + "fields": { + "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", + "format": "google-fieldmask", + "type": "string" + }, "properties": { "description": "Properties to update.", "$ref": "DimensionProperties" @@ -1639,13 +2903,9 @@ "range": { "description": "The rows or columns to update.", "$ref": "DimensionRange" - }, - "fields": { - "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" } - } + }, + "id": "UpdateDimensionPropertiesRequest" }, "SourceAndDestination": { "description": "A combination of a source range and how to extend that source.", @@ -1677,17 +2937,49 @@ }, "id": "SourceAndDestination" }, + "FilterView": { + "description": "A filter view.", + "type": "object", + "properties": { + "range": { + "$ref": "GridRange", + "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set." + }, + "criteria": { + "additionalProperties": { + "$ref": "FilterCriteria" + }, + "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.", + "type": "object" + }, + "title": { + "description": "The name of the filter view.", + "type": "string" + }, + "sortSpecs": { + "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.", + "type": "array", + "items": { + "$ref": "SortSpec" + } + }, + "namedRangeId": { + "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.", + "type": "string" + }, + "filterViewId": { + "description": "The ID of the filter view.", + "format": "int32", + "type": "integer" + } + }, + "id": "FilterView" + }, "OrgChartSpec": { - "id": "OrgChartSpec", "description": "An \u003ca href=\"/chart/interactive/docs/gallery/orgchart\"\u003eorg chart\u003c/a\u003e.\nOrg charts require a unique set of labels in labels and may\noptionally include parent_labels and tooltips.\nparent_labels contain, for each node, the label identifying the parent\nnode. tooltips contain, for each node, an optional tooltip.\n\nFor example, to describe an OrgChart with Alice as the CEO, Bob as the\nPresident (reporting to Alice) and Cathy as VP of Sales (also reporting to\nAlice), have labels contain \"Alice\", \"Bob\", \"Cathy\",\nparent_labels contain \"\", \"Alice\", \"Alice\" and tooltips contain\n\"CEO\", \"President\", \"VP Sales\".", "type": "object", "properties": { - "parentLabels": { - "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional.", - "$ref": "ChartData" - }, "nodeSize": { - "type": "string", "enumDescriptions": [ "Default value, do not use.", "The small org chart node size.", @@ -1700,63 +2992,31 @@ "MEDIUM", "LARGE" ], - "description": "The size of the org chart nodes." + "description": "The size of the org chart nodes.", + "type": "string" }, "labels": { - "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique.", - "$ref": "ChartData" + "$ref": "ChartData", + "description": "The data containing the labels for all the nodes in the chart. Labels\nmust be unique." }, "nodeColor": { - "description": "The color of the org chart nodes.", - "$ref": "Color" + "$ref": "Color", + "description": "The color of the org chart nodes." }, "tooltips": { - "$ref": "ChartData", - "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional." + "description": "The data containing the tooltip for the corresponding node. A blank value\nresults in no tooltip being displayed for the node.\nThis field is optional.", + "$ref": "ChartData" }, "selectedNodeColor": { "description": "The color of the selected org chart nodes.", "$ref": "Color" - } - } - }, - "FilterView": { - "description": "A filter view.", - "type": "object", - "properties": { - "filterViewId": { - "description": "The ID of the filter view.", - "format": "int32", - "type": "integer" }, - "criteria": { - "type": "object", - "additionalProperties": { - "$ref": "FilterCriteria" - }, - "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column." - }, - "title": { - "description": "The name of the filter view.", - "type": "string" - }, - "range": { - "$ref": "GridRange", - "description": "The range this filter view covers.\n\nWhen writing, only one of range or named_range_id\nmay be set." - }, - "sortSpecs": { - "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.", - "type": "array", - "items": { - "$ref": "SortSpec" - } - }, - "namedRangeId": { - "description": "The named range this filter view is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.", - "type": "string" + "parentLabels": { + "description": "The data containing the label of the parent for the corresponding node.\nA blank value indicates that the node has no parent and is a top-level\nnode.\nThis field is optional.", + "$ref": "ChartData" } }, - "id": "FilterView" + "id": "OrgChartSpec" }, "SearchDeveloperMetadataRequest": { "description": "A request to retrieve all developer metadata matching the set of specified\ncriteria.", @@ -1777,34 +3037,34 @@ "type": "object", "properties": { "footerColor": { - "$ref": "Color", - "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn." + "description": "The color of the last row or column. If this field is not set, the last\nrow or column will be filled with either first_band_color or\nsecond_band_color, depending on the color of the previous row or\ncolumn.", + "$ref": "Color" }, "headerColor": { - "$ref": "Color", - "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would." + "description": "The color of the first row or column. If this field is set, the first\nrow or column will be filled with this color and the colors will\nalternate between first_band_color and second_band_color starting\nfrom the second row or column. Otherwise, the first row or column will be\nfilled with first_band_color and the colors will proceed to alternate\nas they normally would.", + "$ref": "Color" }, "firstBandColor": { - "$ref": "Color", - "description": "The first color that is alternating. (Required)" + "description": "The first color that is alternating. (Required)", + "$ref": "Color" }, "secondBandColor": { - "$ref": "Color", - "description": "The second color that is alternating. (Required)" + "description": "The second color that is alternating. (Required)", + "$ref": "Color" } }, "id": "BandingProperties" }, - "CandlestickSeries": { - "description": "The series of a CandlestickData.", + "AddProtectedRangeResponse": { + "description": "The result of adding a new protected range.", "type": "object", "properties": { - "data": { - "$ref": "ChartData", - "description": "The data of the CandlestickSeries." + "protectedRange": { + "$ref": "ProtectedRange", + "description": "The newly added protected range." } }, - "id": "CandlestickSeries" + "id": "AddProtectedRangeResponse" }, "BasicFilter": { "description": "The default filter associated with a sheet.", @@ -1815,11 +3075,11 @@ "description": "The range the filter covers." }, "criteria": { - "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.", - "type": "object", "additionalProperties": { "$ref": "FilterCriteria" - } + }, + "description": "The criteria for showing/hiding values per column.\nThe map's key is the column index, and the value is the criteria for\nthat column.", + "type": "object" }, "sortSpecs": { "description": "The sort order per column. Later specifications are used when values\nare equal in the earlier specifications.", @@ -1831,26 +3091,21 @@ }, "id": "BasicFilter" }, - "AddProtectedRangeResponse": { + "CandlestickSeries": { "properties": { - "protectedRange": { - "$ref": "ProtectedRange", - "description": "The newly added protected range." + "data": { + "$ref": "ChartData", + "description": "The data of the CandlestickSeries." } }, - "id": "AddProtectedRangeResponse", - "description": "The result of adding a new protected range.", + "id": "CandlestickSeries", + "description": "The series of a CandlestickData.", "type": "object" }, "HistogramChartSpec": { "description": "A \u003ca href=\"/chart/interactive/docs/gallery/histogram\"\u003ehistogram chart\u003c/a\u003e.\nA histogram chart groups data items into bins, displaying each bin as a\ncolumn of stacked items. Histograms are used to display the distribution\nof a dataset. Each column of items represents a range into which those\nitems fall. The number of bins can be chosen automatically or specified\nexplicitly.", "type": "object", "properties": { - "bucketSize": { - "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.", - "format": "double", - "type": "number" - }, "outlierPercentile": { "description": "The outlier percentile is used to ensure that outliers do not adversely\naffect the calculation of bucket sizes. For example, setting an outlier\npercentile of 0.05 indicates that the top and bottom 5% of values when\ncalculating buckets. The values are still included in the chart, they will\nbe added to the first or last buckets instead of their own buckets.\nMust be between 0.0 and 0.5.", "format": "double", @@ -1888,15 +3143,24 @@ "NO_LEGEND", "INSIDE_LEGEND" ] + }, + "bucketSize": { + "description": "By default the bucket size (the range of values stacked in a single\ncolumn) is chosen automatically, but it may be overridden here.\nE.g., A bucket size of 1.5 results in buckets from 0 - 1.5, 1.5 - 3.0, etc.\nCannot be negative.\nThis field is optional.", + "format": "double", + "type": "number" } }, "id": "HistogramChartSpec" }, "UpdateValuesResponse": { - "id": "UpdateValuesResponse", "description": "The response when updating a range of values in a spreadsheet.", "type": "object", "properties": { + "updatedColumns": { + "description": "The number of columns where at least one cell in the column was updated.", + "format": "int32", + "type": "integer" + }, "spreadsheetId": { "description": "The spreadsheet the updates were applied to.", "type": "string" @@ -1911,31 +3175,74 @@ "type": "integer" }, "updatedData": { - "$ref": "ValueRange", - "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`." + "description": "The values of the cells after updates were applied.\nThis is only included if the request's `includeValuesInResponse` field\nwas `true`.", + "$ref": "ValueRange" }, "updatedRows": { "description": "The number of rows where at least one cell in the row was updated.", "format": "int32", "type": "integer" - }, - "updatedColumns": { - "description": "The number of columns where at least one cell in the column was updated.", - "format": "int32", - "type": "integer" } - } + }, + "id": "UpdateValuesResponse" + }, + "ErrorValue": { + "properties": { + "message": { + "description": "A message with more information about the error\n(in the spreadsheet's locale).", + "type": "string" + }, + "type": { + "description": "The type of error.", + "type": "string", + "enumDescriptions": [ + "The default error type, do not use this.", + "Corresponds to the `#ERROR!` error.", + "Corresponds to the `#NULL!` error.", + "Corresponds to the `#DIV/0` error.", + "Corresponds to the `#VALUE!` error.", + "Corresponds to the `#REF!` error.", + "Corresponds to the `#NAME?` error.", + "Corresponds to the `#NUM`! error.", + "Corresponds to the `#N/A` error.", + "Corresponds to the `Loading...` state." + ], + "enum": [ + "ERROR_TYPE_UNSPECIFIED", + "ERROR", + "NULL_VALUE", + "DIVIDE_BY_ZERO", + "VALUE", + "REF", + "NAME", + "NUM", + "N_A", + "LOADING" + ] + } + }, + "id": "ErrorValue", + "description": "An error in a cell.", + "type": "object" }, "PivotValue": { "description": "The definition of how a value in a pivot table should be calculated.", "type": "object", "properties": { + "sourceColumnOffset": { + "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "A name to use for the value.", + "type": "string" + }, "formula": { "description": "A custom formula to calculate the value. The formula must start\nwith an `=` character.", "type": "string" }, "summarizeFunction": { - "type": "string", "enumDescriptions": [ "The default, do not use.", "Corresponds to the `SUM` function.", @@ -1970,78 +3277,44 @@ "VARP", "CUSTOM" ], - "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported." - }, - "sourceColumnOffset": { - "description": "The column offset of the source range that this value reads from.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this value refers to column `C`, whereas the offset `1` would\nrefer to column `D`.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "A name to use for the value.", + "description": "A function to summarize the value.\nIf formula is set, the only supported values are\nSUM and\nCUSTOM.\nIf sourceColumnOffset is set, then `CUSTOM`\nis not supported.", "type": "string" } }, "id": "PivotValue" }, - "ErrorValue": { - "type": "object", - "properties": { - "type": { - "enumDescriptions": [ - "The default error type, do not use this.", - "Corresponds to the `#ERROR!` error.", - "Corresponds to the `#NULL!` error.", - "Corresponds to the `#DIV/0` error.", - "Corresponds to the `#VALUE!` error.", - "Corresponds to the `#REF!` error.", - "Corresponds to the `#NAME?` error.", - "Corresponds to the `#NUM`! error.", - "Corresponds to the `#N/A` error.", - "Corresponds to the `Loading...` state." - ], - "enum": [ - "ERROR_TYPE_UNSPECIFIED", - "ERROR", - "NULL_VALUE", - "DIVIDE_BY_ZERO", - "VALUE", - "REF", - "NAME", - "NUM", - "N_A", - "LOADING" - ], - "description": "The type of error.", - "type": "string" - }, - "message": { - "description": "A message with more information about the error\n(in the spreadsheet's locale).", - "type": "string" - } - }, - "id": "ErrorValue", - "description": "An error in a cell." - }, "CopySheetToAnotherSpreadsheetRequest": { - "description": "The request to copy a sheet across spreadsheets.", - "type": "object", "properties": { "destinationSpreadsheetId": { "description": "The ID of the spreadsheet to copy the sheet to.", "type": "string" } }, - "id": "CopySheetToAnotherSpreadsheetRequest" + "id": "CopySheetToAnotherSpreadsheetRequest", + "description": "The request to copy a sheet across spreadsheets.", + "type": "object" }, - "WaterfallChartSeries": { - "description": "A single series of data for a waterfall chart.", + "PivotGroupSortValueBucket": { + "description": "Information about which values in a pivot group should be used for sorting.", "type": "object", "properties": { - "positiveColumnsStyle": { - "$ref": "WaterfallChartColumnStyle", - "description": "Styles for all columns in this series with positive values." + "valuesIndex": { + "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.", + "format": "int32", + "type": "integer" }, + "buckets": { + "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.", + "type": "array", + "items": { + "$ref": "ExtendedValue" + } + } + }, + "id": "PivotGroupSortValueBucket" + }, + "WaterfallChartSeries": { + "properties": { "subtotalColumnsStyle": { "$ref": "WaterfallChartColumnStyle", "description": "Styles for all subtotal columns in this series." @@ -2057,39 +3330,26 @@ "hideTrailingSubtotal": { "description": "True to hide the subtotal column from the end of the series. By default,\na subtotal column will appear at the end of each series. Setting this\nfield to true will hide that subtotal column for this series.", "type": "boolean" - } - }, - "id": "WaterfallChartSeries" - }, - "PivotGroupSortValueBucket": { - "properties": { - "valuesIndex": { - "description": "The offset in the PivotTable.values list which the values in this\ngrouping should be sorted by.", - "format": "int32", - "type": "integer" }, - "buckets": { - "description": "Determines the bucket from which values are chosen to sort.\n\nFor example, in a pivot table with one row group & two column groups,\nthe row group can list up to two values. The first value corresponds\nto a value within the first column group, and the second value\ncorresponds to a value in the second column group. If no values\nare listed, this would indicate that the row should be sorted according\nto the \"Grand Total\" over the column groups. If a single value is listed,\nthis would correspond to using the \"Total\" of that bucket.", - "type": "array", - "items": { - "$ref": "ExtendedValue" - } + "positiveColumnsStyle": { + "$ref": "WaterfallChartColumnStyle", + "description": "Styles for all columns in this series with positive values." } }, - "id": "PivotGroupSortValueBucket", - "description": "Information about which values in a pivot group should be used for sorting.", + "id": "WaterfallChartSeries", + "description": "A single series of data for a waterfall chart.", "type": "object" }, "DeleteDeveloperMetadataRequest": { - "id": "DeleteDeveloperMetadataRequest", "description": "A request to delete developer metadata.", "type": "object", "properties": { "dataFilter": { - "$ref": "DataFilter", - "description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete." + "description": "The data filter describing the criteria used to select which developer\nmetadata entry to delete.", + "$ref": "DataFilter" } - } + }, + "id": "DeleteDeveloperMetadataRequest" }, "CandlestickChartSpec": { "description": "A \u003ca href=\"/chart/interactive/docs/gallery/candlestickchart\"\u003ecandlestick chart\u003c/a\u003e.", @@ -2110,27 +3370,35 @@ "id": "CandlestickChartSpec" }, "BatchClearValuesByDataFilterResponse": { + "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet.", "type": "object", "properties": { - "spreadsheetId": { - "description": "The spreadsheet the updates were applied to.", - "type": "string" - }, "clearedRanges": { "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)", "type": "array", "items": { "type": "string" } + }, + "spreadsheetId": { + "description": "The spreadsheet the updates were applied to.", + "type": "string" } }, - "id": "BatchClearValuesByDataFilterResponse", - "description": "The response when clearing a range of values selected with\nDataFilters in a spreadsheet." + "id": "BatchClearValuesByDataFilterResponse" }, "CandlestickData": { "description": "The Candlestick chart data, each containing the low, open, close, and high\nvalues for a series.", "type": "object", "properties": { + "openSeries": { + "$ref": "CandlestickSeries", + "description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow." + }, + "highSeries": { + "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line.", + "$ref": "CandlestickSeries" + }, "lowSeries": { "$ref": "CandlestickSeries", "description": "The range data (vertical axis) for the low/minimum value for each candle.\nThis is the bottom of the candle's center line." @@ -2138,19 +3406,13 @@ "closeSeries": { "$ref": "CandlestickSeries", "description": "The range data (vertical axis) for the close/final value for each candle.\nThis is the top of the candle body. If greater than the open value the\ncandle will be filled. Otherwise the candle will be hollow." - }, - "openSeries": { - "description": "The range data (vertical axis) for the open/initial value for each\ncandle. This is the bottom of the candle body. If less than the close\nvalue the candle will be filled. Otherwise the candle will be hollow.", - "$ref": "CandlestickSeries" - }, - "highSeries": { - "$ref": "CandlestickSeries", - "description": "The range data (vertical axis) for the high/maximum value for each\ncandle. This is the top of the candle's center line." } }, "id": "CandlestickData" }, "EmbeddedObjectPosition": { + "description": "The position of an embedded object such as a chart.", + "type": "object", "properties": { "newSheet": { "description": "If true, the embedded object will be put on a new sheet whose ID\nis chosen for you. Used only when writing.", @@ -2166,9 +3428,7 @@ "$ref": "OverlayPosition" } }, - "id": "EmbeddedObjectPosition", - "description": "The position of an embedded object such as a chart.", - "type": "object" + "id": "EmbeddedObjectPosition" }, "DeleteProtectedRangeRequest": { "description": "Deletes the protected range with the given ID.", @@ -2187,7 +3447,6 @@ "type": "object", "properties": { "locationType": { - "type": "string", "enumDescriptions": [ "Default value.", "Developer metadata associated on an entire row dimension.", @@ -2202,13 +3461,21 @@ "SHEET", "SPREADSHEET" ], - "description": "Limits the selected developer metadata to those entries which are\nassociated with locations of the specified type. For example, when this\nfield is specified as ROW this lookup\nonly considers developer metadata associated on rows. If the field is left\nunspecified, all location types are considered. This field cannot be\nspecified as SPREADSHEET when\nthe locationMatchingStrategy\nis specified as INTERSECTING or when the\nmetadataLocation is specified as a\nnon-spreadsheet location: spreadsheet metadata cannot intersect any other\ndeveloper metadata location. This field also must be left unspecified when\nthe locationMatchingStrategy\nis specified as EXACT." + "description": "Limits the selected developer metadata to those entries which are\nassociated with locations of the specified type. For example, when this\nfield is specified as ROW this lookup\nonly considers developer metadata associated on rows. If the field is left\nunspecified, all location types are considered. This field cannot be\nspecified as SPREADSHEET when\nthe locationMatchingStrategy\nis specified as INTERSECTING or when the\nmetadataLocation is specified as a\nnon-spreadsheet location: spreadsheet metadata cannot intersect any other\ndeveloper metadata location. This field also must be left unspecified when\nthe locationMatchingStrategy\nis specified as EXACT.", + "type": "string" }, "metadataKey": { "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_key.", "type": "string" }, + "metadataId": { + "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.", + "format": "int32", + "type": "integer" + }, "visibility": { + "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered.", + "type": "string", "enumDescriptions": [ "Default value.", "Document-visible metadata is accessible from any developer project with\naccess to the document.", @@ -2218,19 +3485,16 @@ "DEVELOPER_METADATA_VISIBILITY_UNSPECIFIED", "DOCUMENT", "PROJECT" - ], - "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.visibility. If left unspecified, all developer\nmetadata visibile to the requesting project is considered.", - "type": "string" - }, - "metadataId": { - "type": "integer", - "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_id.", - "format": "int32" + ] }, "metadataValue": { "description": "Limits the selected developer metadata to that which has a matching\nDeveloperMetadata.metadata_value.", "type": "string" }, + "metadataLocation": { + "$ref": "DeveloperMetadataLocation", + "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy." + }, "locationMatchingStrategy": { "enumDescriptions": [ "Default value. This value must not be used.", @@ -2244,10 +3508,6 @@ ], "description": "Determines how this lookup matches the location. If this field is\nspecified as EXACT, only developer metadata associated on the exact\nlocation specified is matched. If this field is specified to INTERSECTING,\ndeveloper metadata associated on intersecting locations is also\nmatched. If left unspecified, this field assumes a default value of\nINTERSECTING.\nIf this field is specified, a metadataLocation\nmust also be specified.", "type": "string" - }, - "metadataLocation": { - "description": "Limits the selected developer metadata to those entries associated with\nthe specified location. This field either matches exact locations or all\nintersecting locations according the specified\nlocationMatchingStrategy.", - "$ref": "DeveloperMetadataLocation" } }, "id": "DeveloperMetadataLookup" @@ -2256,17 +3516,17 @@ "description": "Fills in more data based on existing data.", "type": "object", "properties": { - "sourceAndDestination": { - "$ref": "SourceAndDestination", - "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data." - }, "range": { - "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range.", - "$ref": "GridRange" + "$ref": "GridRange", + "description": "The range to autofill. This will examine the range and detect\nthe location that has data and automatically fill that data\nin to the rest of the range." }, "useAlternateSeries": { "description": "True if we should generate data with the \"alternate\" series.\nThis differs based on the type and amount of source data.", "type": "boolean" + }, + "sourceAndDestination": { + "description": "The source and destination areas to autofill.\nThis explicitly lists the source of the autofill and where to\nextend that data.", + "$ref": "SourceAndDestination" } }, "id": "AutoFillRequest" @@ -2278,24 +3538,18 @@ "$ref": "InterpolationPoint" }, "minpoint": { - "description": "The starting interpolation point.", - "$ref": "InterpolationPoint" + "$ref": "InterpolationPoint", + "description": "The starting interpolation point." }, "maxpoint": { - "$ref": "InterpolationPoint", - "description": "The final interpolation point." + "description": "The final interpolation point.", + "$ref": "InterpolationPoint" } }, "id": "GradientRule", "description": "A rule that applies a gradient color scale format, based on\nthe interpolation points listed. The format of a cell will vary\nbased on its contents as compared to the values of the interpolation\npoints.", "type": "object" }, - "ClearValuesRequest": { - "description": "The request for clearing a range of values in a spreadsheet.", - "type": "object", - "properties": {}, - "id": "ClearValuesRequest" - }, "SetBasicFilterRequest": { "description": "Sets the basic filter associated with a sheet.", "type": "object", @@ -2307,17 +3561,29 @@ }, "id": "SetBasicFilterRequest" }, - "InterpolationPoint": { - "id": "InterpolationPoint", - "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.", + "ClearValuesRequest": { + "description": "The request for clearing a range of values in a spreadsheet.", "type": "object", + "properties": {}, + "id": "ClearValuesRequest" + }, + "BatchClearValuesByDataFilterRequest": { "properties": { - "color": { - "description": "The color this interpolation point should use.", - "$ref": "Color" - }, + "dataFilters": { + "description": "The DataFilters used to determine which ranges to clear.", + "type": "array", + "items": { + "$ref": "DataFilter" + } + } + }, + "id": "BatchClearValuesByDataFilterRequest", + "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.", + "type": "object" + }, + "InterpolationPoint": { + "properties": { "type": { - "type": "string", "enumDescriptions": [ "The default value, do not use.", "The interpolation point will use the minimum value in the\ncells over the range of the conditional format.", @@ -2334,27 +3600,21 @@ "PERCENT", "PERCENTILE" ], - "description": "How the value should be interpreted." + "description": "How the value should be interpreted.", + "type": "string" }, "value": { "description": "The value this interpolation point uses. May be a formula.\nUnused if type is MIN or\nMAX.", "type": "string" - } - } - }, - "BatchClearValuesByDataFilterRequest": { - "description": "The request for clearing more than one range selected by a\nDataFilter in a spreadsheet.", - "type": "object", - "properties": { - "dataFilters": { - "description": "The DataFilters used to determine which ranges to clear.", - "type": "array", - "items": { - "$ref": "DataFilter" - } + }, + "color": { + "description": "The color this interpolation point should use.", + "$ref": "Color" } }, - "id": "BatchClearValuesByDataFilterRequest" + "id": "InterpolationPoint", + "description": "A single interpolation point on a gradient conditional format.\nThese pin the gradient color scale according to the color,\ntype and value chosen.", + "type": "object" }, "GetSpreadsheetByDataFilterRequest": { "description": "The request for retrieving a Spreadsheet.", @@ -2374,26 +3634,12 @@ }, "id": "GetSpreadsheetByDataFilterRequest" }, - "DeleteEmbeddedObjectRequest": { - "description": "Deletes the embedded object with the given ID.", - "type": "object", - "properties": { - "objectId": { - "description": "The ID of the embedded object to delete.", - "format": "int32", - "type": "integer" - } - }, - "id": "DeleteEmbeddedObjectRequest" - }, "FindReplaceResponse": { - "description": "The result of the find/replace.", - "type": "object", "properties": { "sheetsChanged": { - "type": "integer", "description": "The number of sheets changed.", - "format": "int32" + "format": "int32", + "type": "integer" }, "formulasChanged": { "description": "The number of formula cells changed.", @@ -2416,28 +3662,33 @@ "type": "integer" } }, - "id": "FindReplaceResponse" + "id": "FindReplaceResponse", + "description": "The result of the find/replace.", + "type": "object" + }, + "DeleteEmbeddedObjectRequest": { + "description": "Deletes the embedded object with the given ID.", + "type": "object", + "properties": { + "objectId": { + "description": "The ID of the embedded object to delete.", + "format": "int32", + "type": "integer" + } + }, + "id": "DeleteEmbeddedObjectRequest" }, "UpdateValuesByDataFilterResponse": { "properties": { - "updatedCells": { - "type": "integer", - "description": "The number of cells updated.", - "format": "int32" - }, - "dataFilter": { - "description": "The data filter that selected the range that was updated.", - "$ref": "DataFilter" - }, - "updatedData": { - "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`.", - "$ref": "ValueRange" - }, "updatedRows": { "description": "The number of rows where at least one cell in the row was updated.", "format": "int32", "type": "integer" }, + "updatedData": { + "$ref": "ValueRange", + "description": "The values of the cells in the range matched by the dataFilter after all\nupdates were applied. This is only included if the request's\n`includeValuesInResponse` field was `true`." + }, "updatedColumns": { "description": "The number of columns where at least one cell in the column was updated.", "format": "int32", @@ -2446,12 +3697,33 @@ "updatedRange": { "description": "The range (in A1 notation) that updates were applied to.", "type": "string" + }, + "updatedCells": { + "description": "The number of cells updated.", + "format": "int32", + "type": "integer" + }, + "dataFilter": { + "$ref": "DataFilter", + "description": "The data filter that selected the range that was updated." } }, "id": "UpdateValuesByDataFilterResponse", "description": "The response when updating a range of values by a data filter in a\nspreadsheet.", "type": "object" }, + "DuplicateFilterViewRequest": { + "description": "Duplicates a particular filter view.", + "type": "object", + "properties": { + "filterId": { + "description": "The ID of the filter being duplicated.", + "format": "int32", + "type": "integer" + } + }, + "id": "DuplicateFilterViewRequest" + }, "DeleteSheetRequest": { "description": "Deletes the requested sheet.", "type": "object", @@ -2464,17 +3736,43 @@ }, "id": "DeleteSheetRequest" }, - "DuplicateFilterViewRequest": { - "id": "DuplicateFilterViewRequest", - "description": "Duplicates a particular filter view.", + "DeveloperMetadataLocation": { + "description": "A location where metadata may be associated in a spreadsheet.", "type": "object", "properties": { - "filterId": { - "description": "The ID of the filter being duplicated.", + "locationType": { + "enum": [ + "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED", + "ROW", + "COLUMN", + "SHEET", + "SPREADSHEET" + ], + "description": "The type of location this object represents. This field is read-only.", + "type": "string", + "enumDescriptions": [ + "Default value.", + "Developer metadata associated on an entire row dimension.", + "Developer metadata associated on an entire column dimension.", + "Developer metadata associated on an entire sheet.", + "Developer metadata associated on the entire spreadsheet." + ] + }, + "dimensionRange": { + "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns.", + "$ref": "DimensionRange" + }, + "spreadsheet": { + "description": "True when metadata is associated with an entire spreadsheet.", + "type": "boolean" + }, + "sheetId": { + "description": "The ID of the sheet when metadata is associated with an entire sheet.", "format": "int32", "type": "integer" } - } + }, + "id": "DeveloperMetadataLocation" }, "MatchedValueRange": { "properties": { @@ -2494,56 +3792,15 @@ "description": "A value range that was matched by one or more data filers.", "type": "object" }, - "DeveloperMetadataLocation": { - "properties": { - "dimensionRange": { - "description": "Represents the row or column when metadata is associated with\na dimension. The specified DimensionRange must represent a single row\nor column; it cannot be unbounded or span multiple rows or columns.", - "$ref": "DimensionRange" - }, - "spreadsheet": { - "description": "True when metadata is associated with an entire spreadsheet.", - "type": "boolean" - }, - "sheetId": { - "type": "integer", - "description": "The ID of the sheet when metadata is associated with an entire sheet.", - "format": "int32" - }, - "locationType": { - "description": "The type of location this object represents. This field is read-only.", - "type": "string", - "enumDescriptions": [ - "Default value.", - "Developer metadata associated on an entire row dimension.", - "Developer metadata associated on an entire column dimension.", - "Developer metadata associated on an entire sheet.", - "Developer metadata associated on the entire spreadsheet." - ], - "enum": [ - "DEVELOPER_METADATA_LOCATION_TYPE_UNSPECIFIED", - "ROW", - "COLUMN", - "SHEET", - "SPREADSHEET" - ] - } - }, - "id": "DeveloperMetadataLocation", - "description": "A location where metadata may be associated in a spreadsheet.", - "type": "object" - }, "UpdateConditionalFormatRuleResponse": { + "description": "The result of updating a conditional format rule.", + "type": "object", "properties": { - "newIndex": { - "description": "The index of the new rule.", + "oldIndex": { + "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).", "format": "int32", "type": "integer" }, - "oldIndex": { - "type": "integer", - "description": "The old index of the rule. Not set if a rule was replaced\n(because it is the same as new_index).", - "format": "int32" - }, "newRule": { "$ref": "ConditionalFormatRule", "description": "The new rule that replaced the old rule (if replacing),\nor the rule that was moved (if moved)" @@ -2551,25 +3808,46 @@ "oldRule": { "$ref": "ConditionalFormatRule", "description": "The old (deleted) rule. Not set if a rule was moved\n(because it is the same as new_rule)." + }, + "newIndex": { + "description": "The index of the new rule.", + "format": "int32", + "type": "integer" } }, - "id": "UpdateConditionalFormatRuleResponse", - "description": "The result of updating a conditional format rule.", - "type": "object" + "id": "UpdateConditionalFormatRuleResponse" + }, + "DuplicateSheetRequest": { + "description": "Duplicates the contents of a sheet.", + "type": "object", + "properties": { + "newSheetId": { + "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.", + "format": "int32", + "type": "integer" + }, + "insertSheetIndex": { + "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.", + "format": "int32", + "type": "integer" + }, + "newSheetName": { + "description": "The name of the new sheet. If empty, a new name is chosen for you.", + "type": "string" + }, + "sourceSheetId": { + "description": "The sheet to duplicate.", + "format": "int32", + "type": "integer" + } + }, + "id": "DuplicateSheetRequest" }, "ConditionValue": { + "description": "The value of the condition.", "type": "object", "properties": { "relativeDate": { - "enumDescriptions": [ - "Default value, do not use.", - "The value is one year before today.", - "The value is one month before today.", - "The value is one week before today.", - "The value is yesterday.", - "The value is today.", - "The value is tomorrow." - ], "enum": [ "RELATIVE_DATE_UNSPECIFIED", "PAST_YEAR", @@ -2580,41 +3858,23 @@ "TOMORROW" ], "description": "A relative date (based on the current date).\nValid only if the type is\nDATE_BEFORE,\nDATE_AFTER,\nDATE_ON_OR_BEFORE or\nDATE_ON_OR_AFTER.\n\nRelative dates are not supported in data validation.\nThey are supported only in conditional formatting and\nconditional filters.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Default value, do not use.", + "The value is one year before today.", + "The value is one month before today.", + "The value is one week before today.", + "The value is yesterday.", + "The value is today.", + "The value is tomorrow." + ] }, "userEnteredValue": { "description": "A value the condition is based on.\nThe value will be parsed as if the user typed into a cell.\nFormulas are supported (and must begin with an `=`).", "type": "string" } }, - "id": "ConditionValue", - "description": "The value of the condition." - }, - "DuplicateSheetRequest": { - "description": "Duplicates the contents of a sheet.", - "type": "object", - "properties": { - "newSheetName": { - "description": "The name of the new sheet. If empty, a new name is chosen for you.", - "type": "string" - }, - "sourceSheetId": { - "description": "The sheet to duplicate.", - "format": "int32", - "type": "integer" - }, - "newSheetId": { - "description": "If set, the ID of the new sheet. If not set, an ID is chosen.\nIf set, the ID must not conflict with any existing sheet ID.\nIf set, it must be non-negative.", - "format": "int32", - "type": "integer" - }, - "insertSheetIndex": { - "description": "The zero-based index where the new sheet should be inserted.\nThe index of all sheets after this are incremented.", - "format": "int32", - "type": "integer" - } - }, - "id": "DuplicateSheetRequest" + "id": "ConditionValue" }, "ExtendedValue": { "description": "The kinds of value that a cell in a spreadsheet can have.", @@ -2626,8 +3886,8 @@ "type": "number" }, "errorValue": { - "description": "Represents an error.\nThis field is read-only.", - "$ref": "ErrorValue" + "$ref": "ErrorValue", + "description": "Represents an error.\nThis field is read-only." }, "stringValue": { "description": "Represents a string value.\nLeading single quotes are not included. For example, if the user typed\n`'123` into the UI, this would be represented as a `stringValue` of\n`\"123\"`.", @@ -2644,75 +3904,19 @@ }, "id": "ExtendedValue" }, - "BandedRange": { - "description": "A banded (alternating colors) range in a sheet.", + "AddChartRequest": { + "description": "Adds a chart to a sheet in the spreadsheet.", "type": "object", "properties": { - "range": { - "description": "The range over which these properties are applied.", - "$ref": "GridRange" - }, - "bandedRangeId": { - "description": "The id of the banded range.", - "format": "int32", - "type": "integer" - }, - "rowProperties": { - "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified.", - "$ref": "BandingProperties" - }, - "columnProperties": { - "$ref": "BandingProperties", - "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified." + "chart": { + "$ref": "EmbeddedChart", + "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)" } }, - "id": "BandedRange" - }, - "HistogramSeries": { - "properties": { - "barColor": { - "$ref": "Color", - "description": "The color of the column representing this series in each bucket.\nThis field is optional." - }, - "data": { - "description": "The data for this histogram series.", - "$ref": "ChartData" - } - }, - "id": "HistogramSeries", - "description": "A histogram series containing the series color and data.", - "type": "object" - }, - "BatchClearValuesResponse": { - "id": "BatchClearValuesResponse", - "description": "The response when clearing a range of values in a spreadsheet.", - "type": "object", - "properties": { - "spreadsheetId": { - "type": "string", - "description": "The spreadsheet the updates were applied to." - }, - "clearedRanges": { - "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)", - "type": "array", - "items": { - "type": "string" - } - } - } + "id": "AddChartRequest" }, "Spreadsheet": { - "id": "Spreadsheet", - "description": "Resource that represents a spreadsheet.", - "type": "object", "properties": { - "sheets": { - "description": "The sheets that are part of a spreadsheet.", - "type": "array", - "items": { - "$ref": "Sheet" - } - }, "spreadsheetUrl": { "description": "The url of the spreadsheet.\nThis field is read-only.", "type": "string" @@ -2738,26 +3942,81 @@ "items": { "$ref": "DeveloperMetadata" } - } - } - }, - "AddChartRequest": { - "description": "Adds a chart to a sheet in the spreadsheet.", - "type": "object", - "properties": { - "chart": { - "description": "The chart that should be added to the spreadsheet, including the position\nwhere it should be placed. The chartId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a chart that already exists.)", - "$ref": "EmbeddedChart" + }, + "sheets": { + "description": "The sheets that are part of a spreadsheet.", + "type": "array", + "items": { + "$ref": "Sheet" + } } }, - "id": "AddChartRequest" + "id": "Spreadsheet", + "description": "Resource that represents a spreadsheet.", + "type": "object" }, - "UpdateProtectedRangeRequest": { + "BatchClearValuesResponse": { + "properties": { + "clearedRanges": { + "description": "The ranges that were cleared, in A1 notation.\n(If the requests were for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual ranges\n that were cleared, bounded to the sheet's limits.)", + "type": "array", + "items": { + "type": "string" + } + }, + "spreadsheetId": { + "description": "The spreadsheet the updates were applied to.", + "type": "string" + } + }, + "id": "BatchClearValuesResponse", + "description": "The response when clearing a range of values in a spreadsheet.", + "type": "object" + }, + "HistogramSeries": { + "description": "A histogram series containing the series color and data.", "type": "object", "properties": { + "barColor": { + "description": "The color of the column representing this series in each bucket.\nThis field is optional.", + "$ref": "Color" + }, + "data": { + "$ref": "ChartData", + "description": "The data for this histogram series." + } + }, + "id": "HistogramSeries" + }, + "BandedRange": { + "description": "A banded (alternating colors) range in a sheet.", + "type": "object", + "properties": { + "range": { + "description": "The range over which these properties are applied.", + "$ref": "GridRange" + }, + "bandedRangeId": { + "description": "The id of the banded range.", + "format": "int32", + "type": "integer" + }, + "rowProperties": { + "$ref": "BandingProperties", + "description": "Properties for row bands. These properties will be applied on a row-by-row\nbasis throughout all the rows in the range. At least one of\nrow_properties or column_properties must be specified." + }, + "columnProperties": { + "$ref": "BandingProperties", + "description": "Properties for column bands. These properties will be applied on a column-\nby-column basis throughout all the columns in the range. At least one of\nrow_properties or column_properties must be specified." + } + }, + "id": "BandedRange" + }, + "UpdateProtectedRangeRequest": { + "properties": { "protectedRange": { - "$ref": "ProtectedRange", - "description": "The protected range to update with the new properties." + "description": "The protected range to update with the new properties.", + "$ref": "ProtectedRange" }, "fields": { "description": "The fields that should be updated. At least one field must be specified.\nThe root `protectedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", @@ -2766,21 +4025,22 @@ } }, "id": "UpdateProtectedRangeRequest", - "description": "Updates an existing protected range with the specified\nprotectedRangeId." + "description": "Updates an existing protected range with the specified\nprotectedRangeId.", + "type": "object" }, "DataFilter": { "properties": { - "gridRange": { - "description": "Selects data that matches the range described by the GridRange.", - "$ref": "GridRange" - }, "developerMetadataLookup": { - "description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup.", - "$ref": "DeveloperMetadataLookup" + "$ref": "DeveloperMetadataLookup", + "description": "Selects data associated with the developer metadata matching the criteria\ndescribed by this DeveloperMetadataLookup." }, "a1Range": { "description": "Selects data that matches the specified A1 range.", "type": "string" + }, + "gridRange": { + "$ref": "GridRange", + "description": "Selects data that matches the range described by the GridRange." } }, "id": "DataFilter", @@ -2788,17 +4048,12 @@ "type": "object" }, "TextFormat": { - "id": "TextFormat", "description": "The format of a run of text in a cell.\nAbsent values indicate that the field isn't specified.", "type": "object", "properties": { - "underline": { - "description": "True if the text is underlined.", - "type": "boolean" - }, "foregroundColor": { - "description": "The foreground color of the text.", - "$ref": "Color" + "$ref": "Color", + "description": "The foreground color of the text." }, "bold": { "description": "True if the text is bold.", @@ -2809,8 +4064,8 @@ "type": "string" }, "italic": { - "type": "boolean", - "description": "True if the text is italicized." + "description": "True if the text is italicized.", + "type": "boolean" }, "strikethrough": { "description": "True if the text has a strikethrough.", @@ -2820,8 +4075,13 @@ "description": "The size of the font.", "format": "int32", "type": "integer" + }, + "underline": { + "description": "True if the text is underlined.", + "type": "boolean" } - } + }, + "id": "TextFormat" }, "AddSheetResponse": { "description": "The result of adding a sheet.", @@ -2835,6 +4095,7 @@ "id": "AddSheetResponse" }, "AddFilterViewResponse": { + "description": "The result of adding a filter view.", "type": "object", "properties": { "filter": { @@ -2842,30 +4103,39 @@ "description": "The newly added filter view." } }, - "id": "AddFilterViewResponse", - "description": "The result of adding a filter view." + "id": "AddFilterViewResponse" }, "IterativeCalculationSettings": { - "id": "IterativeCalculationSettings", "description": "Settings to control how circular dependencies are resolved with iterative\ncalculation.", "type": "object", "properties": { - "maxIterations": { - "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.", - "format": "int32", - "type": "integer" - }, "convergenceThreshold": { "description": "When iterative calculation is enabled and successive results differ by\nless than this threshold value, the calculation rounds stop.", "format": "double", "type": "number" + }, + "maxIterations": { + "description": "When iterative calculation is enabled, the maximum number of calculation\nrounds to perform.", + "format": "int32", + "type": "integer" } - } + }, + "id": "IterativeCalculationSettings" }, "OverlayPosition": { "description": "The location an object is overlaid on top of a grid.", "type": "object", "properties": { + "widthPixels": { + "description": "The width of the object, in pixels. Defaults to 600.", + "format": "int32", + "type": "integer" + }, + "offsetXPixels": { + "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.", + "format": "int32", + "type": "integer" + }, "anchorCell": { "description": "The cell the object is anchored to.", "$ref": "GridCoordinate" @@ -2879,42 +4149,14 @@ "description": "The height of the object, in pixels. Defaults to 371.", "format": "int32", "type": "integer" - }, - "widthPixels": { - "description": "The width of the object, in pixels. Defaults to 600.", - "format": "int32", - "type": "integer" - }, - "offsetXPixels": { - "description": "The horizontal offset, in pixels, that the object is offset\nfrom the anchor cell.", - "format": "int32", - "type": "integer" } }, "id": "OverlayPosition" }, "SpreadsheetProperties": { + "description": "Properties of a spreadsheet.", + "type": "object", "properties": { - "autoRecalc": { - "enum": [ - "RECALCULATION_INTERVAL_UNSPECIFIED", - "ON_CHANGE", - "MINUTE", - "HOUR" - ], - "description": "The amount of time to wait before volatile functions are recalculated.", - "type": "string", - "enumDescriptions": [ - "Default value. This value must not be used.", - "Volatile functions are updated on every change.", - "Volatile functions are updated on every change and every minute.", - "Volatile functions are updated on every change and hourly." - ] - }, - "defaultFormat": { - "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only.", - "$ref": "CellFormat" - }, "title": { "description": "The title of the spreadsheet.", "type": "string" @@ -2930,31 +4172,49 @@ "iterativeCalculationSettings": { "$ref": "IterativeCalculationSettings", "description": "Determines whether and how circular references are resolved with iterative\ncalculation. Absence of this field means that circular references will\nresult in calculation errors." + }, + "autoRecalc": { + "enumDescriptions": [ + "Default value. This value must not be used.", + "Volatile functions are updated on every change.", + "Volatile functions are updated on every change and every minute.", + "Volatile functions are updated on every change and hourly." + ], + "enum": [ + "RECALCULATION_INTERVAL_UNSPECIFIED", + "ON_CHANGE", + "MINUTE", + "HOUR" + ], + "description": "The amount of time to wait before volatile functions are recalculated.", + "type": "string" + }, + "defaultFormat": { + "$ref": "CellFormat", + "description": "The default format of all cells in the spreadsheet.\nCellData.effectiveFormat will not be set if the\ncell's format is equal to this default format.\nThis field is read-only." } }, - "id": "SpreadsheetProperties", - "description": "Properties of a spreadsheet.", - "type": "object" + "id": "SpreadsheetProperties" }, "RepeatCellRequest": { - "id": "RepeatCellRequest", "description": "Updates all cells in the range to the values in the given Cell object.\nOnly the fields listed in the fields field are updated; others are\nunchanged.\n\nIf writing a cell with a formula, the formula's ranges will automatically\nincrement for each field in the range.\nFor example, if writing a cell with formula `=A1` into range B2:C4,\nB2 would be `=A1`, B3 would be `=A2`, B4 would be `=A3`,\nC2 would be `=B1`, C3 would be `=B2`, C4 would be `=B3`.\n\nTo keep the formula's ranges static, use the `$` indicator.\nFor example, use the formula `=$A$1` to prevent both the row and the\ncolumn from incrementing.", "type": "object", "properties": { - "range": { - "$ref": "GridRange", - "description": "The range to repeat the cell in." - }, "fields": { "description": "The fields that should be updated. At least one field must be specified.\nThe root `cell` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", "format": "google-fieldmask", "type": "string" }, "cell": { - "description": "The data to write.", - "$ref": "CellData" + "$ref": "CellData", + "description": "The data to write." + }, + "range": { + "$ref": "GridRange", + "description": "The range to repeat the cell in." } - } + }, + "id": "RepeatCellRequest" }, "AddChartResponse": { "description": "The result of adding a chart to a spreadsheet.", @@ -2986,38 +4246,20 @@ "description": "Updates properties of a spreadsheet.", "type": "object", "properties": { + "properties": { + "$ref": "SpreadsheetProperties", + "description": "The properties to update." + }, "fields": { "description": "The fields that should be updated. At least one field must be specified.\nThe root 'properties' is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", "format": "google-fieldmask", "type": "string" - }, - "properties": { - "description": "The properties to update.", - "$ref": "SpreadsheetProperties" } }, "id": "UpdateSpreadsheetPropertiesRequest" }, "ProtectedRange": { - "description": "A protected range.", - "type": "object", "properties": { - "requestingUserCanEdit": { - "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.", - "type": "boolean" - }, - "range": { - "$ref": "GridRange", - "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set." - }, - "editors": { - "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection.", - "$ref": "Editors" - }, - "description": { - "description": "The description of this protected range.", - "type": "string" - }, "unprotectedRanges": { "description": "The list of unprotected ranges within a protected sheet.\nUnprotected ranges are only supported on protected sheets.", "type": "array", @@ -3026,8 +4268,8 @@ } }, "namedRangeId": { - "type": "string", - "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set." + "description": "The named range this protected range is backed by, if any.\n\nWhen writing, only one of range or named_range_id\nmay be set.", + "type": "string" }, "protectedRangeId": { "description": "The ID of the protected range.\nThis field is read-only.", @@ -3037,13 +4279,44 @@ "warningOnly": { "description": "True if this protected range will show a warning when editing.\nWarning-based protection means that every user can edit data in the\nprotected range, except editing will prompt a warning asking the user\nto confirm the edit.\n\nWhen writing: if this field is true, then editors is ignored.\nAdditionally, if this field is changed from true to false and the\n`editors` field is not set (nor included in the field mask), then\nthe editors will be set to all the editors in the document.", "type": "boolean" + }, + "requestingUserCanEdit": { + "description": "True if the user who requested this protected range can edit the\nprotected area.\nThis field is read-only.", + "type": "boolean" + }, + "range": { + "description": "The range that is being protected.\nThe range may be fully unbounded, in which case this is considered\na protected sheet.\n\nWhen writing, only one of range or named_range_id\nmay be set.", + "$ref": "GridRange" + }, + "editors": { + "description": "The users and groups with edit access to the protected range.\nThis field is only visible to users with edit access to the protected\nrange and the document.\nEditors are not supported with warning_only protection.", + "$ref": "Editors" + }, + "description": { + "description": "The description of this protected range.", + "type": "string" } }, - "id": "ProtectedRange" + "id": "ProtectedRange", + "description": "A protected range.", + "type": "object" }, "BatchUpdateValuesRequest": { - "type": "object", "properties": { + "responseValueRenderOption": { + "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", + "type": "string", + "enumDescriptions": [ + "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", + "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.", + "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`." + ], + "enum": [ + "FORMATTED_VALUE", + "UNFORMATTED_VALUE", + "FORMULA" + ] + }, "includeValuesInResponse": { "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values. The `updatedData` field within\neach of the BatchUpdateValuesResponse.responses will contain\nthe updated values. If the range to write was larger than than the range\nactually written, the response will include all values in the requested\nrange (excluding trailing empty rows and columns).", "type": "boolean" @@ -3063,46 +4336,38 @@ "type": "string" }, "data": { + "description": "The new values to apply to the spreadsheet.", "type": "array", "items": { "$ref": "ValueRange" - }, - "description": "The new values to apply to the spreadsheet." + } }, "responseDateTimeRenderOption": { + "enum": [ + "SERIAL_NUMBER", + "FORMATTED_STRING" + ], "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is\nDateTimeRenderOption.SERIAL_NUMBER.", "type": "string", "enumDescriptions": [ "Instructs date, time, datetime, and duration fields to be output\nas doubles in \"serial number\" format, as popularized by Lotus 1-2-3.\nThe whole number portion of the value (left of the decimal) counts\nthe days since December 30th 1899. The fractional portion (right of\nthe decimal) counts the time as a fraction of the day. For example,\nJanuary 1st 1900 at noon would be 2.5, 2 because it's 2 days after\nDecember 30st 1899, and .5 because noon is half a day. February 1st\n1900 at 3pm would be 33.625. This correctly treats the year 1900 as\nnot a leap year.", "Instructs date, time, datetime, and duration fields to be output\nas strings in their given number format (which is dependent\non the spreadsheet locale)." - ], - "enum": [ - "SERIAL_NUMBER", - "FORMATTED_STRING" - ] - }, - "responseValueRenderOption": { - "description": "Determines how values in the response should be rendered.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", - "type": "string", - "enumDescriptions": [ - "Values will be calculated & formatted in the reply according to the\ncell's formatting. Formatting is based on the spreadsheet's locale,\nnot the requesting user's locale.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return `\"$1.23\"`.", - "Values will be calculated, but not formatted in the reply.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen `A2` would return the number `1.23`.", - "Values will not be calculated. The reply will include the formulas.\nFor example, if `A1` is `1.23` and `A2` is `=A1` and formatted as currency,\nthen A2 would return `\"=A1\"`." - ], - "enum": [ - "FORMATTED_VALUE", - "UNFORMATTED_VALUE", - "FORMULA" ] } }, "id": "BatchUpdateValuesRequest", - "description": "The request for updating more than one range of values in a spreadsheet." + "description": "The request for updating more than one range of values in a spreadsheet.", + "type": "object" }, "DimensionProperties": { "description": "Properties about a dimension.", "type": "object", "properties": { + "pixelSize": { + "description": "The height (if a row) or width (if a column) of the dimension in pixels.", + "format": "int32", + "type": "integer" + }, "hiddenByFilter": { "description": "True if this dimension is being filtered.\nThis field is read-only.", "type": "boolean" @@ -3117,11 +4382,6 @@ "items": { "$ref": "DeveloperMetadata" } - }, - "pixelSize": { - "type": "integer", - "description": "The height (if a row) or width (if a column) of the dimension in pixels.", - "format": "int32" } }, "id": "DimensionProperties" @@ -3130,9 +4390,12 @@ "description": "A range along a single dimension on a sheet.\nAll indexes are zero-based.\nIndexes are half open: the start index is inclusive\nand the end index is exclusive.\nMissing indexes indicate the range is unbounded on that side.", "type": "object", "properties": { + "sheetId": { + "description": "The sheet this span is on.", + "format": "int32", + "type": "integer" + }, "dimension": { - "description": "The dimension of the span.", - "type": "string", "enumDescriptions": [ "The default value, do not use.", "Operates on the rows of a sheet.", @@ -3142,7 +4405,9 @@ "DIMENSION_UNSPECIFIED", "ROWS", "COLUMNS" - ] + ], + "description": "The dimension of the span.", + "type": "string" }, "startIndex": { "description": "The start (inclusive) of the span, or not set if unbounded.", @@ -3153,18 +4418,11 @@ "description": "The end (exclusive) of the span, or not set if unbounded.", "format": "int32", "type": "integer" - }, - "sheetId": { - "description": "The sheet this span is on.", - "format": "int32", - "type": "integer" } }, "id": "DimensionRange" }, "NamedRange": { - "description": "A named range.", - "type": "object", "properties": { "name": { "description": "The name of the named range.", @@ -3175,15 +4433,15 @@ "type": "string" }, "range": { - "$ref": "GridRange", - "description": "The range this represents." + "description": "The range this represents.", + "$ref": "GridRange" } }, - "id": "NamedRange" + "id": "NamedRange", + "description": "A named range.", + "type": "object" }, "CutPasteRequest": { - "description": "Moves data from the source to the destination.", - "type": "object", "properties": { "destination": { "description": "The top-left coordinate where the data should be pasted.", @@ -3194,8 +4452,6 @@ "description": "The source data to cut." }, "pasteType": { - "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.", - "type": "string", "enumDescriptions": [ "Paste values, formulas, formats, and merges.", "Paste the values ONLY without formats, formulas, or merges.", @@ -3213,25 +4469,36 @@ "PASTE_FORMULA", "PASTE_DATA_VALIDATION", "PASTE_CONDITIONAL_FORMATTING" - ] + ], + "description": "What kind of data to paste. All the source data will be cut, regardless\nof what is pasted.", + "type": "string" } }, - "id": "CutPasteRequest" + "id": "CutPasteRequest", + "description": "Moves data from the source to the destination.", + "type": "object" }, "BasicChartSeries": { - "id": "BasicChartSeries", - "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".", - "type": "object", "properties": { "lineStyle": { "description": "The line style of this series. Valid only if the\nchartType is AREA,\nLINE, or SCATTER.\nCOMBO charts are also supported if the\nseries chart type is\nAREA or LINE.", "$ref": "LineStyle" }, "series": { - "description": "The data being visualized in this chart series.", - "$ref": "ChartData" + "$ref": "ChartData", + "description": "The data being visualized in this chart series." }, "type": { + "enumDescriptions": [ + "Default value, do not use.", + "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.", + "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.", + "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.", + "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.", + "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.", + "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.", + "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area chart\u003c/a\u003e." + ], "enum": [ "BASIC_CHART_TYPE_UNSPECIFIED", "BAR", @@ -3243,17 +4510,7 @@ "STEPPED_AREA" ], "description": "The type of this series. Valid only if the\nchartType is\nCOMBO.\nDifferent types will change the way the series is visualized.\nOnly LINE, AREA,\nand COLUMN are supported.", - "type": "string", - "enumDescriptions": [ - "Default value, do not use.", - "A \u003ca href=\"/chart/interactive/docs/gallery/barchart\"\u003ebar chart\u003c/a\u003e.", - "A \u003ca href=\"/chart/interactive/docs/gallery/linechart\"\u003eline chart\u003c/a\u003e.", - "An \u003ca href=\"/chart/interactive/docs/gallery/areachart\"\u003earea chart\u003c/a\u003e.", - "A \u003ca href=\"/chart/interactive/docs/gallery/columnchart\"\u003ecolumn chart\u003c/a\u003e.", - "A \u003ca href=\"/chart/interactive/docs/gallery/scatterchart\"\u003escatter chart\u003c/a\u003e.", - "A \u003ca href=\"/chart/interactive/docs/gallery/combochart\"\u003ecombo chart\u003c/a\u003e.", - "A \u003ca href=\"/chart/interactive/docs/gallery/steppedareachart\"\u003estepped area chart\u003c/a\u003e." - ] + "type": "string" }, "targetAxis": { "description": "The minor axis that will specify the range of values for this series.\nFor example, if charting stocks over time, the \"Volume\" series\nmay want to be pinned to the right with the prices pinned to the left,\nbecause the scale of trading volume is different than the scale of\nprices.\nIt is an error to specify an axis that isn't a valid minor axis\nfor the chart's type.", @@ -3271,20 +4528,13 @@ "RIGHT_AXIS" ] } - } + }, + "id": "BasicChartSeries", + "description": "A single series of data in a chart.\nFor example, if charting stock prices over time, multiple series may exist,\none for the \"Open Price\", \"High Price\", \"Low Price\" and \"Close Price\".", + "type": "object" }, "Borders": { - "description": "The borders of the cell.", - "type": "object", "properties": { - "top": { - "$ref": "Border", - "description": "The top border of the cell." - }, - "left": { - "$ref": "Border", - "description": "The left border of the cell." - }, "right": { "description": "The right border of the cell.", "$ref": "Border" @@ -3292,42 +4542,54 @@ "bottom": { "$ref": "Border", "description": "The bottom border of the cell." + }, + "top": { + "description": "The top border of the cell.", + "$ref": "Border" + }, + "left": { + "description": "The left border of the cell.", + "$ref": "Border" } }, - "id": "Borders" + "id": "Borders", + "description": "The borders of the cell.", + "type": "object" }, "AutoResizeDimensionsRequest": { - "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.", - "type": "object", "properties": { "dimensions": { "$ref": "DimensionRange", "description": "The dimensions to automatically resize." } }, - "id": "AutoResizeDimensionsRequest" + "id": "AutoResizeDimensionsRequest", + "description": "Automatically resizes one or more dimensions based on the contents\nof the cells in that dimension.", + "type": "object" }, "UpdateBordersRequest": { + "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.", + "type": "object", "properties": { "bottom": { - "description": "The border to put at the bottom of the range.", - "$ref": "Border" + "$ref": "Border", + "description": "The border to put at the bottom of the range." }, "innerVertical": { "$ref": "Border", "description": "The vertical border to put within the range." }, "right": { - "description": "The border to put at the right of the range.", - "$ref": "Border" + "$ref": "Border", + "description": "The border to put at the right of the range." }, "range": { "description": "The range whose borders should be updated.", "$ref": "GridRange" }, "innerHorizontal": { - "$ref": "Border", - "description": "The horizontal border to put within the range." + "description": "The horizontal border to put within the range.", + "$ref": "Border" }, "top": { "description": "The border to put at the top of the range.", @@ -3338,15 +4600,35 @@ "description": "The border to put at the left of the range." } }, - "id": "UpdateBordersRequest", - "description": "Updates the borders of a range.\nIf a field is not set in the request, that means the border remains as-is.\nFor example, with two subsequent UpdateBordersRequest:\n\n 1. range: A1:A5 `{ top: RED, bottom: WHITE }`\n 2. range: A1:A5 `{ left: BLUE }`\n\nThat would result in A1:A5 having a borders of\n`{ top: RED, bottom: WHITE, left: BLUE }`.\nIf you want to clear a border, explicitly set the style to\nNONE.", - "type": "object" + "id": "UpdateBordersRequest" }, "CellFormat": { "properties": { + "wrapStrategy": { + "enumDescriptions": [ + "The default value, do not use.", + "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |", + "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |", + "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |", + "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |" + ], + "enum": [ + "WRAP_STRATEGY_UNSPECIFIED", + "OVERFLOW_CELL", + "LEGACY_WRAP", + "CLIP", + "WRAP" + ], + "description": "The wrap strategy for the value in the cell.", + "type": "string" + }, + "textRotation": { + "$ref": "TextRotation", + "description": "The rotation applied to text in a cell" + }, "numberFormat": { - "description": "A format describing how number values should be represented to the user.", - "$ref": "NumberFormat" + "$ref": "NumberFormat", + "description": "A format describing how number values should be represented to the user." }, "hyperlinkDisplayType": { "enumDescriptions": [ @@ -3391,6 +4673,12 @@ "description": "The padding of the cell." }, "verticalAlignment": { + "enum": [ + "VERTICAL_ALIGN_UNSPECIFIED", + "TOP", + "MIDDLE", + "BOTTOM" + ], "description": "The vertical alignment of the value in the cell.", "type": "string", "enumDescriptions": [ @@ -3398,12 +4686,6 @@ "The text is explicitly aligned to the top of the cell.", "The text is explicitly aligned to the middle of the cell.", "The text is explicitly aligned to the bottom of the cell." - ], - "enum": [ - "VERTICAL_ALIGN_UNSPECIFIED", - "TOP", - "MIDDLE", - "BOTTOM" ] }, "borders": { @@ -3411,6 +4693,8 @@ "$ref": "Borders" }, "textDirection": { + "description": "The direction of the text in the cell.", + "type": "string", "enumDescriptions": [ "The text direction is not specified. Do not use this.", "The text direction of left-to-right was set by the user.", @@ -3420,31 +4704,7 @@ "TEXT_DIRECTION_UNSPECIFIED", "LEFT_TO_RIGHT", "RIGHT_TO_LEFT" - ], - "description": "The direction of the text in the cell.", - "type": "string" - }, - "wrapStrategy": { - "enumDescriptions": [ - "The default value, do not use.", - "Lines that are longer than the cell width will be written in the next\ncell over, so long as that cell is empty. If the next cell over is\nnon-empty, this behaves the same as CLIP. The text will never wrap\nto the next line unless the user manually inserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline that is very long. \u003c- Text continues into next cell\n | Next newline. |", - "This wrap strategy represents the old Google Sheets wrap strategy where\nwords that are longer than a line are clipped rather than broken. This\nstrategy is not supported on all platforms and is being phased out.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is clipped.\n | word. |", - "Lines that are longer than the cell width will be clipped.\nThe text will never wrap to the next line unless the user manually\ninserts a new line.\nExample:\n\n | First sentence. |\n | Manual newline t| \u003c- Text is clipped\n | Next newline. |", - "Words that are longer than a line are wrapped at the character level\nrather than clipped.\nExample:\n\n | Cell has a |\n | loooooooooo| \u003c- Word is broken.\n | ong word. |" - ], - "enum": [ - "WRAP_STRATEGY_UNSPECIFIED", - "OVERFLOW_CELL", - "LEGACY_WRAP", - "CLIP", - "WRAP" - ], - "description": "The wrap strategy for the value in the cell.", - "type": "string" - }, - "textRotation": { - "$ref": "TextRotation", - "description": "The rotation applied to text in a cell" + ] } }, "id": "CellFormat", @@ -3455,21 +4715,18 @@ "description": "The response when clearing a range of values in a spreadsheet.", "type": "object", "properties": { - "clearedRange": { - "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)", - "type": "string" - }, "spreadsheetId": { "description": "The spreadsheet the updates were applied to.", "type": "string" + }, + "clearedRange": { + "description": "The range (in A1 notation) that was cleared.\n(If the request was for an unbounded range or a ranger larger\n than the bounds of the sheet, this will be the actual range\n that was cleared, bounded to the sheet's limits.)", + "type": "string" } }, "id": "ClearValuesResponse" }, "DeleteConditionalFormatRuleRequest": { - "id": "DeleteConditionalFormatRuleRequest", - "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.", - "type": "object", "properties": { "index": { "description": "The zero-based index of the rule to be deleted.", @@ -3481,21 +4738,23 @@ "format": "int32", "type": "integer" } - } - }, - "DeleteNamedRangeRequest": { - "properties": { - "namedRangeId": { - "type": "string", - "description": "The ID of the named range to delete." - } }, - "id": "DeleteNamedRangeRequest", - "description": "Removes the named range with the given ID from the spreadsheet.", + "id": "DeleteConditionalFormatRuleRequest", + "description": "Deletes a conditional format rule at the given index.\nAll subsequent rules' indexes are decremented.", "type": "object" }, + "DeleteNamedRangeRequest": { + "description": "Removes the named range with the given ID from the spreadsheet.", + "type": "object", + "properties": { + "namedRangeId": { + "description": "The ID of the named range to delete.", + "type": "string" + } + }, + "id": "DeleteNamedRangeRequest" + }, "AddBandingResponse": { - "id": "AddBandingResponse", "description": "The result of adding a banded range.", "type": "object", "properties": { @@ -3503,1270 +4762,8 @@ "description": "The banded range that was added.", "$ref": "BandedRange" } - } - }, - "ChartData": { - "description": "The data included in a domain or series.", - "type": "object", - "properties": { - "sourceRange": { - "$ref": "ChartSourceRange", - "description": "The source ranges of the data." - } }, - "id": "ChartData" - }, - "BatchGetValuesResponse": { - "description": "The response when retrieving more than one range of values in a spreadsheet.", - "type": "object", - "properties": { - "spreadsheetId": { - "description": "The ID of the spreadsheet the data was retrieved from.", - "type": "string" - }, - "valueRanges": { - "description": "The requested values. The order of the ValueRanges is the same as the\norder of the requested ranges.", - "type": "array", - "items": { - "$ref": "ValueRange" - } - } - }, - "id": "BatchGetValuesResponse" - }, - "UpdateBandingRequest": { - "id": "UpdateBandingRequest", - "description": "Updates properties of the supplied banded range.", - "type": "object", - "properties": { - "fields": { - "description": "The fields that should be updated. At least one field must be specified.\nThe root `bandedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" - }, - "bandedRange": { - "description": "The banded range to update with the new properties.", - "$ref": "BandedRange" - } - } - }, - "Color": { - "properties": { - "red": { - "description": "The amount of red in the color as a value in the interval [0, 1].", - "format": "float", - "type": "number" - }, - "green": { - "description": "The amount of green in the color as a value in the interval [0, 1].", - "format": "float", - "type": "number" - }, - "blue": { - "description": "The amount of blue in the color as a value in the interval [0, 1].", - "format": "float", - "type": "number" - }, - "alpha": { - "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", - "format": "float", - "type": "number" - } - }, - "id": "Color", - "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", - "type": "object" - }, - "PivotGroup": { - "type": "object", - "properties": { - "valueBucket": { - "$ref": "PivotGroupSortValueBucket", - "description": "The bucket of the opposite pivot group to sort by.\nIf not specified, sorting is alphabetical by this group's values." - }, - "sourceColumnOffset": { - "description": "The column offset of the source range that this grouping is based on.\n\nFor example, if the source was `C10:E15`, a `sourceColumnOffset` of `0`\nmeans this group refers to column `C`, whereas the offset `1` would refer\nto column `D`.", - "format": "int32", - "type": "integer" - }, - "showTotals": { - "description": "True if the pivot table should include the totals for this grouping.", - "type": "boolean" - }, - "valueMetadata": { - "type": "array", - "items": { - "$ref": "PivotGroupValueMetadata" - }, - "description": "Metadata about values in the grouping." - }, - "sortOrder": { - "description": "The order the values in this group should be sorted.", - "type": "string", - "enumDescriptions": [ - "Default value, do not use this.", - "Sort ascending.", - "Sort descending." - ], - "enum": [ - "SORT_ORDER_UNSPECIFIED", - "ASCENDING", - "DESCENDING" - ] - } - }, - "id": "PivotGroup", - "description": "A single grouping (either row or column) in a pivot table." - }, - "PivotTable": { - "description": "A pivot table.", - "type": "object", - "properties": { - "criteria": { - "additionalProperties": { - "$ref": "PivotFilterCriteria" - }, - "description": "An optional mapping of filters per source column offset.\n\nThe filters will be applied before aggregating data into the pivot table.\nThe map's key is the column offset of the source range that you want to\nfilter, and the value is the criteria for that column.\n\nFor example, if the source was `C10:E15`, a key of `0` will have the filter\nfor column `C`, whereas the key `1` is for column `D`.", - "type": "object" - }, - "rows": { - "description": "Each row grouping in the pivot table.", - "type": "array", - "items": { - "$ref": "PivotGroup" - } - }, - "valueLayout": { - "enum": [ - "HORIZONTAL", - "VERTICAL" - ], - "description": "Whether values should be listed horizontally (as columns)\nor vertically (as rows).", - "type": "string", - "enumDescriptions": [ - "Values are laid out horizontally (as columns).", - "Values are laid out vertically (as rows)." - ] - }, - "values": { - "description": "A list of values to include in the pivot table.", - "type": "array", - "items": { - "$ref": "PivotValue" - } - }, - "source": { - "$ref": "GridRange", - "description": "The range the pivot table is reading data from." - }, - "columns": { - "description": "Each column grouping in the pivot table.", - "type": "array", - "items": { - "$ref": "PivotGroup" - } - } - }, - "id": "PivotTable" - }, - "ChartSourceRange": { - "description": "Source ranges for a chart.", - "type": "object", - "properties": { - "sources": { - "type": "array", - "items": { - "$ref": "GridRange" - }, - "description": "The ranges of data for a series or domain.\nExactly one dimension must have a length of 1,\nand all sources in the list must have the same dimension\nwith length 1.\nThe domain (if it exists) & all series must have the same number\nof source ranges. If using more than one source range, then the source\nrange at a given offset must be contiguous across the domain and series.\n\nFor example, these are valid configurations:\n\n domain sources: A1:A5\n series1 sources: B1:B5\n series2 sources: D6:D10\n\n domain sources: A1:A5, C10:C12\n series1 sources: B1:B5, D10:D12\n series2 sources: C1:C5, E10:E12" - } - }, - "id": "ChartSourceRange" - }, - "SearchDeveloperMetadataResponse": { - "properties": { - "matchedDeveloperMetadata": { - "description": "The metadata matching the criteria of the search request.", - "type": "array", - "items": { - "$ref": "MatchedDeveloperMetadata" - } - } - }, - "id": "SearchDeveloperMetadataResponse", - "description": "A reply to a developer metadata search request.", - "type": "object" - }, - "AppendCellsRequest": { - "description": "Adds new cells after the last row with data in a sheet,\ninserting new rows into the sheet if necessary.", - "type": "object", - "properties": { - "sheetId": { - "description": "The sheet ID to append the data to.", - "format": "int32", - "type": "integer" - }, - "rows": { - "description": "The data to append.", - "type": "array", - "items": { - "$ref": "RowData" - } - }, - "fields": { - "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "AppendCellsRequest" - }, - "ValueRange": { - "description": "Data within a range of the spreadsheet.", - "type": "object", - "properties": { - "majorDimension": { - "enumDescriptions": [ - "The default value, do not use.", - "Operates on the rows of a sheet.", - "Operates on the columns of a sheet." - ], - "enum": [ - "DIMENSION_UNSPECIFIED", - "ROWS", - "COLUMNS" - ], - "description": "The major dimension of the values.\n\nFor output, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.\n\nFor input, with `range=A1:B2,majorDimension=ROWS` then `[[1,2],[3,4]]`\nwill set `A1=1,B1=2,A2=3,B2=4`. With `range=A1:B2,majorDimension=COLUMNS`\nthen `[[1,2],[3,4]]` will set `A1=1,B1=3,A2=2,B2=4`.\n\nWhen writing, if this field is not set, it defaults to ROWS.", - "type": "string" - }, - "values": { - "description": "The data that was read or to be written. This is an array of arrays,\nthe outer array representing all the data and each inner array\nrepresenting a major dimension. Each item in the inner array\ncorresponds with one cell.\n\nFor output, empty trailing rows and columns will not be included.\n\nFor input, supported value types are: bool, string, and double.\nNull values will be skipped.\nTo set a cell to an empty value, set the string value to an empty string.", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "any" - } - } - }, - "range": { - "description": "The range the values cover, in A1 notation.\nFor output, this range indicates the entire requested range,\neven though the values will exclude trailing rows and columns.\nWhen appending values, this field represents the range to search for a\ntable, after which values will be appended.", - "type": "string" - } - }, - "id": "ValueRange" - }, - "AddBandingRequest": { - "description": "Adds a new banded range to the spreadsheet.", - "type": "object", - "properties": { - "bandedRange": { - "$ref": "BandedRange", - "description": "The banded range to add. The bandedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)" - } - }, - "id": "AddBandingRequest" - }, - "Response": { - "description": "A single response from an update.", - "type": "object", - "properties": { - "findReplace": { - "$ref": "FindReplaceResponse", - "description": "A reply from doing a find/replace." - }, - "addSheet": { - "$ref": "AddSheetResponse", - "description": "A reply from adding a sheet." - }, - "updateConditionalFormatRule": { - "description": "A reply from updating a conditional format rule.", - "$ref": "UpdateConditionalFormatRuleResponse" - }, - "createDeveloperMetadata": { - "$ref": "CreateDeveloperMetadataResponse", - "description": "A reply from creating a developer metadata entry." - }, - "addNamedRange": { - "$ref": "AddNamedRangeResponse", - "description": "A reply from adding a named range." - }, - "deleteDeveloperMetadata": { - "$ref": "DeleteDeveloperMetadataResponse", - "description": "A reply from deleting a developer metadata entry." - }, - "addFilterView": { - "description": "A reply from adding a filter view.", - "$ref": "AddFilterViewResponse" - }, - "addBanding": { - "$ref": "AddBandingResponse", - "description": "A reply from adding a banded range." - }, - "addProtectedRange": { - "$ref": "AddProtectedRangeResponse", - "description": "A reply from adding a protected range." - }, - "duplicateSheet": { - "description": "A reply from duplicating a sheet.", - "$ref": "DuplicateSheetResponse" - }, - "deleteConditionalFormatRule": { - "$ref": "DeleteConditionalFormatRuleResponse", - "description": "A reply from deleting a conditional format rule." - }, - "updateEmbeddedObjectPosition": { - "description": "A reply from updating an embedded object's position.", - "$ref": "UpdateEmbeddedObjectPositionResponse" - }, - "duplicateFilterView": { - "$ref": "DuplicateFilterViewResponse", - "description": "A reply from duplicating a filter view." - }, - "addChart": { - "$ref": "AddChartResponse", - "description": "A reply from adding a chart." - }, - "updateDeveloperMetadata": { - "description": "A reply from updating a developer metadata entry.", - "$ref": "UpdateDeveloperMetadataResponse" - } - }, - "id": "Response" - }, - "EmbeddedChart": { - "properties": { - "chartId": { - "description": "The ID of the chart.", - "format": "int32", - "type": "integer" - }, - "position": { - "description": "The position of the chart.", - "$ref": "EmbeddedObjectPosition" - }, - "spec": { - "$ref": "ChartSpec", - "description": "The specification of the chart." - } - }, - "id": "EmbeddedChart", - "description": "A chart embedded in a sheet.", - "type": "object" - }, - "TextFormatRun": { - "properties": { - "startIndex": { - "description": "The character index where this run starts.", - "format": "int32", - "type": "integer" - }, - "format": { - "$ref": "TextFormat", - "description": "The format of this run. Absent values inherit the cell's format." - } - }, - "id": "TextFormatRun", - "description": "A run of a text format. The format of this run continues until the start\nindex of the next run.\nWhen updating, all fields must be set.", - "type": "object" - }, - "InsertRangeRequest": { - "description": "Inserts cells into a range, shifting the existing cells over or down.", - "type": "object", - "properties": { - "shiftDimension": { - "enumDescriptions": [ - "The default value, do not use.", - "Operates on the rows of a sheet.", - "Operates on the columns of a sheet." - ], - "enum": [ - "DIMENSION_UNSPECIFIED", - "ROWS", - "COLUMNS" - ], - "description": "The dimension which will be shifted when inserting cells.\nIf ROWS, existing cells will be shifted down.\nIf COLUMNS, existing cells will be shifted right.", - "type": "string" - }, - "range": { - "description": "The range to insert new cells into.", - "$ref": "GridRange" - } - }, - "id": "InsertRangeRequest" - }, - "AddNamedRangeResponse": { - "description": "The result of adding a named range.", - "type": "object", - "properties": { - "namedRange": { - "description": "The named range to add.", - "$ref": "NamedRange" - } - }, - "id": "AddNamedRangeResponse" - }, - "BatchUpdateValuesByDataFilterResponse": { - "description": "The response when updating a range of values in a spreadsheet.", - "type": "object", - "properties": { - "spreadsheetId": { - "description": "The spreadsheet the updates were applied to.", - "type": "string" - }, - "totalUpdatedRows": { - "description": "The total number of rows where at least one cell in the row was updated.", - "format": "int32", - "type": "integer" - }, - "responses": { - "description": "The response for each range updated.", - "type": "array", - "items": { - "$ref": "UpdateValuesByDataFilterResponse" - } - }, - "totalUpdatedSheets": { - "type": "integer", - "description": "The total number of sheets where at least one cell in the sheet was\nupdated.", - "format": "int32" - }, - "totalUpdatedCells": { - "description": "The total number of cells updated.", - "format": "int32", - "type": "integer" - }, - "totalUpdatedColumns": { - "description": "The total number of columns where at least one cell in the column was\nupdated.", - "format": "int32", - "type": "integer" - } - }, - "id": "BatchUpdateValuesByDataFilterResponse" - }, - "RowData": { - "description": "Data about each cell in a row.", - "type": "object", - "properties": { - "values": { - "description": "The values in the row, one per column.", - "type": "array", - "items": { - "$ref": "CellData" - } - } - }, - "id": "RowData" - }, - "GridData": { - "properties": { - "rowData": { - "description": "The data in the grid, one entry per row,\nstarting with the row in startRow.\nThe values in RowData will correspond to columns starting\nat start_column.", - "type": "array", - "items": { - "$ref": "RowData" - } - }, - "startRow": { - "description": "The first row this GridData refers to, zero-based.", - "format": "int32", - "type": "integer" - }, - "columnMetadata": { - "description": "Metadata about the requested columns in the grid, starting with the column\nin start_column.", - "type": "array", - "items": { - "$ref": "DimensionProperties" - } - }, - "startColumn": { - "description": "The first column this GridData refers to, zero-based.", - "format": "int32", - "type": "integer" - }, - "rowMetadata": { - "description": "Metadata about the requested rows in the grid, starting with the row\nin start_row.", - "type": "array", - "items": { - "$ref": "DimensionProperties" - } - } - }, - "id": "GridData", - "description": "Data in the grid, as well as metadata about the dimensions.", - "type": "object" - }, - "Border": { - "description": "A border along a cell.", - "type": "object", - "properties": { - "style": { - "description": "The style of the border.", - "type": "string", - "enumDescriptions": [ - "The style is not specified. Do not use this.", - "The border is dotted.", - "The border is dashed.", - "The border is a thin solid line.", - "The border is a medium solid line.", - "The border is a thick solid line.", - "No border.\nUsed only when updating a border in order to erase it.", - "The border is two solid lines." - ], - "enum": [ - "STYLE_UNSPECIFIED", - "DOTTED", - "DASHED", - "SOLID", - "SOLID_MEDIUM", - "SOLID_THICK", - "NONE", - "DOUBLE" - ] - }, - "color": { - "$ref": "Color", - "description": "The color of the border." - }, - "width": { - "description": "The width of the border, in pixels.\nDeprecated; the width is determined by the \"style\" field.", - "format": "int32", - "type": "integer" - } - }, - "id": "Border" - }, - "FindReplaceRequest": { - "id": "FindReplaceRequest", - "description": "Finds and replaces data in cells over a range, sheet, or all sheets.", - "type": "object", - "properties": { - "range": { - "$ref": "GridRange", - "description": "The range to find/replace over." - }, - "sheetId": { - "description": "The sheet to find/replace over.", - "format": "int32", - "type": "integer" - }, - "matchCase": { - "description": "True if the search is case sensitive.", - "type": "boolean" - }, - "allSheets": { - "description": "True to find/replace over all sheets.", - "type": "boolean" - }, - "includeFormulas": { - "description": "True if the search should include cells with formulas.\nFalse to skip cells with formulas.", - "type": "boolean" - }, - "matchEntireCell": { - "description": "True if the find value should match the entire cell.", - "type": "boolean" - }, - "find": { - "description": "The value to search.", - "type": "string" - }, - "searchByRegex": { - "description": "True if the find value is a regex.\nThe regular expression and replacement should follow Java regex rules\nat https://docs.oracle.com/javase/8/docs/api/java/util/regex/Pattern.html.\nThe replacement string is allowed to refer to capturing groups.\nFor example, if one cell has the contents `\"Google Sheets\"` and another\nhas `\"Google Docs\"`, then searching for `\"o.* (.*)\"` with a replacement of\n`\"$1 Rocks\"` would change the contents of the cells to\n`\"GSheets Rocks\"` and `\"GDocs Rocks\"` respectively.", - "type": "boolean" - }, - "replacement": { - "description": "The value to use as the replacement.", - "type": "string" - } - } - }, - "UpdateNamedRangeRequest": { - "description": "Updates properties of the named range with the specified\nnamedRangeId.", - "type": "object", - "properties": { - "namedRange": { - "$ref": "NamedRange", - "description": "The named range to update with the new properties." - }, - "fields": { - "description": "The fields that should be updated. At least one field must be specified.\nThe root `namedRange` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "UpdateNamedRangeRequest" - }, - "AddSheetRequest": { - "description": "Adds a new sheet.\nWhen a sheet is added at a given index,\nall subsequent sheets' indexes are incremented.\nTo add an object sheet, use AddChartRequest instead and specify\nEmbeddedObjectPosition.sheetId or\nEmbeddedObjectPosition.newSheet.", - "type": "object", - "properties": { - "properties": { - "$ref": "SheetProperties", - "description": "The properties the new sheet should have.\nAll properties are optional.\nThe sheetId field is optional; if one is not\nset, an id will be randomly generated. (It is an error to specify the ID\nof a sheet that already exists.)" - } - }, - "id": "AddSheetRequest" - }, - "UpdateCellsRequest": { - "description": "Updates all cells in a range with new data.", - "type": "object", - "properties": { - "range": { - "description": "The range to write data to.\n\nIf the data in rows does not cover the entire requested range,\nthe fields matching those set in fields will be cleared.", - "$ref": "GridRange" - }, - "rows": { - "type": "array", - "items": { - "$ref": "RowData" - }, - "description": "The data to write." - }, - "fields": { - "description": "The fields of CellData that should be updated.\nAt least one field must be specified.\nThe root is the CellData; 'row.values.' should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" - }, - "start": { - "description": "The coordinate to start writing data at.\nAny number of rows and columns (including a different number of\ncolumns per row) may be written.", - "$ref": "GridCoordinate" - } - }, - "id": "UpdateCellsRequest" - }, - "DeleteConditionalFormatRuleResponse": { - "properties": { - "rule": { - "$ref": "ConditionalFormatRule", - "description": "The rule that was deleted." - } - }, - "id": "DeleteConditionalFormatRuleResponse", - "description": "The result of deleting a conditional format rule.", - "type": "object" - }, - "RandomizeRangeRequest": { - "description": "Randomizes the order of the rows in a range.", - "type": "object", - "properties": { - "range": { - "description": "The range to randomize.", - "$ref": "GridRange" - } - }, - "id": "RandomizeRangeRequest" - }, - "DeleteRangeRequest": { - "description": "Deletes a range of cells, shifting other cells into the deleted area.", - "type": "object", - "properties": { - "shiftDimension": { - "enum": [ - "DIMENSION_UNSPECIFIED", - "ROWS", - "COLUMNS" - ], - "description": "The dimension from which deleted cells will be replaced with.\nIf ROWS, existing cells will be shifted upward to\nreplace the deleted cells. If COLUMNS, existing cells\nwill be shifted left to replace the deleted cells.", - "type": "string", - "enumDescriptions": [ - "The default value, do not use.", - "Operates on the rows of a sheet.", - "Operates on the columns of a sheet." - ] - }, - "range": { - "$ref": "GridRange", - "description": "The range of cells to delete." - } - }, - "id": "DeleteRangeRequest" - }, - "GridCoordinate": { - "type": "object", - "properties": { - "rowIndex": { - "description": "The row index of the coordinate.", - "format": "int32", - "type": "integer" - }, - "columnIndex": { - "description": "The column index of the coordinate.", - "format": "int32", - "type": "integer" - }, - "sheetId": { - "description": "The sheet this coordinate is on.", - "format": "int32", - "type": "integer" - } - }, - "id": "GridCoordinate", - "description": "A coordinate in a sheet.\nAll indexes are zero-based." - }, - "UpdateSheetPropertiesRequest": { - "type": "object", - "properties": { - "fields": { - "type": "string", - "description": "The fields that should be updated. At least one field must be specified.\nThe root `properties` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask" - }, - "properties": { - "$ref": "SheetProperties", - "description": "The properties to update." - } - }, - "id": "UpdateSheetPropertiesRequest", - "description": "Updates properties of the sheet with the specified\nsheetId." - }, - "GridProperties": { - "properties": { - "rowCount": { - "description": "The number of rows in the grid.", - "format": "int32", - "type": "integer" - }, - "frozenRowCount": { - "description": "The number of rows that are frozen in the grid.", - "format": "int32", - "type": "integer" - }, - "hideGridlines": { - "description": "True if the grid isn't showing gridlines in the UI.", - "type": "boolean" - }, - "columnCount": { - "description": "The number of columns in the grid.", - "format": "int32", - "type": "integer" - }, - "frozenColumnCount": { - "type": "integer", - "description": "The number of columns that are frozen in the grid.", - "format": "int32" - } - }, - "id": "GridProperties", - "description": "Properties of a grid.", - "type": "object" - }, - "UnmergeCellsRequest": { - "description": "Unmerges cells in the given range.", - "type": "object", - "properties": { - "range": { - "description": "The range within which all cells should be unmerged.\nIf the range spans multiple merges, all will be unmerged.\nThe range must not partially span any merge.", - "$ref": "GridRange" - } - }, - "id": "UnmergeCellsRequest" - }, - "SortSpec": { - "properties": { - "dimensionIndex": { - "description": "The dimension the sort should be applied to.", - "format": "int32", - "type": "integer" - }, - "sortOrder": { - "description": "The order data should be sorted.", - "type": "string", - "enumDescriptions": [ - "Default value, do not use this.", - "Sort ascending.", - "Sort descending." - ], - "enum": [ - "SORT_ORDER_UNSPECIFIED", - "ASCENDING", - "DESCENDING" - ] - } - }, - "id": "SortSpec", - "description": "A sort order associated with a specific column or row.", - "type": "object" - }, - "Sheet": { - "type": "object", - "properties": { - "filterViews": { - "type": "array", - "items": { - "$ref": "FilterView" - }, - "description": "The filter views in this sheet." - }, - "conditionalFormats": { - "description": "The conditional format rules in this sheet.", - "type": "array", - "items": { - "$ref": "ConditionalFormatRule" - } - }, - "developerMetadata": { - "description": "The developer metadata associated with a sheet.", - "type": "array", - "items": { - "$ref": "DeveloperMetadata" - } - }, - "protectedRanges": { - "description": "The protected ranges in this sheet.", - "type": "array", - "items": { - "$ref": "ProtectedRange" - } - }, - "basicFilter": { - "$ref": "BasicFilter", - "description": "The filter on this sheet, if any." - }, - "merges": { - "description": "The ranges that are merged together.", - "type": "array", - "items": { - "$ref": "GridRange" - } - }, - "data": { - "description": "Data in the grid, if this is a grid sheet.\nThe number of GridData objects returned is dependent on the number of\nranges requested on this sheet. For example, if this is representing\n`Sheet1`, and the spreadsheet was requested with ranges\n`Sheet1!A1:C10` and `Sheet1!D15:E20`, then the first GridData will have a\nstartRow/startColumn of `0`,\nwhile the second one will have `startRow 14` (zero-based row 15),\nand `startColumn 3` (zero-based column D).", - "type": "array", - "items": { - "$ref": "GridData" - } - }, - "bandedRanges": { - "description": "The banded (i.e. alternating colors) ranges on this sheet.", - "type": "array", - "items": { - "$ref": "BandedRange" - } - }, - "charts": { - "description": "The specifications of every chart on this sheet.", - "type": "array", - "items": { - "$ref": "EmbeddedChart" - } - }, - "properties": { - "$ref": "SheetProperties", - "description": "The properties of the sheet." - } - }, - "id": "Sheet", - "description": "A sheet in a spreadsheet." - }, - "UpdateEmbeddedObjectPositionResponse": { - "description": "The result of updating an embedded object's position.", - "type": "object", - "properties": { - "position": { - "$ref": "EmbeddedObjectPosition", - "description": "The new position of the embedded object." - } - }, - "id": "UpdateEmbeddedObjectPositionResponse" - }, - "BooleanRule": { - "description": "A rule that may or may not match, depending on the condition.", - "type": "object", - "properties": { - "condition": { - "$ref": "BooleanCondition", - "description": "The condition of the rule. If the condition evaluates to true,\nthe format will be applied." - }, - "format": { - "$ref": "CellFormat", - "description": "The format to apply.\nConditional formatting can only apply a subset of formatting:\nbold, italic,\nstrikethrough,\nforeground color &\nbackground color." - } - }, - "id": "BooleanRule" - }, - "FilterCriteria": { - "description": "Criteria for showing/hiding rows in a filter or filter view.", - "type": "object", - "properties": { - "hiddenValues": { - "description": "Values that should be hidden.", - "type": "array", - "items": { - "type": "string" - } - }, - "condition": { - "$ref": "BooleanCondition", - "description": "A condition that must be true for values to be shown.\n(This does not override hiddenValues -- if a value is listed there,\n it will still be hidden.)" - } - }, - "id": "FilterCriteria" - }, - "PivotGroupValueMetadata": { - "description": "Metadata about a value in a pivot grouping.", - "type": "object", - "properties": { - "value": { - "description": "The calculated value the metadata corresponds to.\n(Note that formulaValue is not valid,\n because the values will be calculated.)", - "$ref": "ExtendedValue" - }, - "collapsed": { - "description": "True if the data corresponding to the value is collapsed.", - "type": "boolean" - } - }, - "id": "PivotGroupValueMetadata" - }, - "WaterfallChartSpec": { - "type": "object", - "properties": { - "connectorLineStyle": { - "$ref": "LineStyle", - "description": "The line style for the connector lines." - }, - "domain": { - "description": "The domain data (horizontal axis) for the waterfall chart.", - "$ref": "WaterfallChartDomain" - }, - "firstValueIsTotal": { - "description": "True to interpret the first value as a total.", - "type": "boolean" - }, - "stackedType": { - "enum": [ - "WATERFALL_STACKED_TYPE_UNSPECIFIED", - "STACKED", - "SEQUENTIAL" - ], - "description": "The stacked type.", - "type": "string", - "enumDescriptions": [ - "Default value, do not use.", - "Values corresponding to the same domain (horizontal axis) value will be\nstacked vertically.", - "Series will spread out along the horizontal axis." - ] - }, - "hideConnectorLines": { - "description": "True to hide connector lines between columns.", - "type": "boolean" - }, - "series": { - "description": "The data this waterfall chart is visualizing.", - "type": "array", - "items": { - "$ref": "WaterfallChartSeries" - } - } - }, - "id": "WaterfallChartSpec", - "description": "A waterfall chart." - }, - "Editors": { - "description": "The editors of a protected range.", - "type": "object", - "properties": { - "users": { - "description": "The email addresses of users with edit access to the protected range.", - "type": "array", - "items": { - "type": "string" - } - }, - "groups": { - "type": "array", - "items": { - "type": "string" - }, - "description": "The email addresses of groups with edit access to the protected range." - }, - "domainUsersCanEdit": { - "description": "True if anyone in the document's domain has edit access to the protected\nrange. Domain protection is only supported on documents within a domain.", - "type": "boolean" - } - }, - "id": "Editors" - }, - "UpdateConditionalFormatRuleRequest": { - "properties": { - "index": { - "description": "The zero-based index of the rule that should be replaced or moved.", - "format": "int32", - "type": "integer" - }, - "sheetId": { - "description": "The sheet of the rule to move. Required if new_index is set,\nunused otherwise.", - "format": "int32", - "type": "integer" - }, - "newIndex": { - "description": "The zero-based new index the rule should end up at.", - "format": "int32", - "type": "integer" - }, - "rule": { - "description": "The rule that should replace the rule at the given index.", - "$ref": "ConditionalFormatRule" - } - }, - "id": "UpdateConditionalFormatRuleRequest", - "description": "Updates a conditional format rule at the given index,\nor moves a conditional format rule to another index.", - "type": "object" - }, - "BasicChartDomain": { - "type": "object", - "properties": { - "reversed": { - "description": "True to reverse the order of the domain values (horizontal axis).", - "type": "boolean" - }, - "domain": { - "$ref": "ChartData", - "description": "The data of the domain. For example, if charting stock prices over time,\nthis is the data representing the dates." - } - }, - "id": "BasicChartDomain", - "description": "The domain of a chart.\nFor example, if charting stock prices over time, this would be the date." - }, - "DataValidationRule": { - "description": "A data validation rule.", - "type": "object", - "properties": { - "showCustomUi": { - "description": "True if the UI should be customized based on the kind of condition.\nIf true, \"List\" conditions will show a dropdown.", - "type": "boolean" - }, - "strict": { - "description": "True if invalid data should be rejected.", - "type": "boolean" - }, - "inputMessage": { - "description": "A message to show the user when adding data to the cell.", - "type": "string" - }, - "condition": { - "description": "The condition that data in the cell must match.", - "$ref": "BooleanCondition" - } - }, - "id": "DataValidationRule" - }, - "PasteDataRequest": { - "description": "Inserts data into the spreadsheet starting at the specified coordinate.", - "type": "object", - "properties": { - "coordinate": { - "$ref": "GridCoordinate", - "description": "The coordinate at which the data should start being inserted." - }, - "data": { - "description": "The data to insert.", - "type": "string" - }, - "delimiter": { - "description": "The delimiter in the data.", - "type": "string" - }, - "type": { - "type": "string", - "enumDescriptions": [ - "Paste values, formulas, formats, and merges.", - "Paste the values ONLY without formats, formulas, or merges.", - "Paste the format and data validation only.", - "Like PASTE_NORMAL but without borders.", - "Paste the formulas only.", - "Paste the data validation only.", - "Paste the conditional formatting rules only." - ], - "enum": [ - "PASTE_NORMAL", - "PASTE_VALUES", - "PASTE_FORMAT", - "PASTE_NO_BORDERS", - "PASTE_FORMULA", - "PASTE_DATA_VALIDATION", - "PASTE_CONDITIONAL_FORMATTING" - ], - "description": "How the data should be pasted." - }, - "html": { - "description": "True if the data is HTML.", - "type": "boolean" - } - }, - "id": "PasteDataRequest" - }, - "UpdateDeveloperMetadataResponse": { - "description": "The response from updating developer metadata.", - "type": "object", - "properties": { - "developerMetadata": { - "description": "The updated developer metadata.", - "type": "array", - "items": { - "$ref": "DeveloperMetadata" - } - } - }, - "id": "UpdateDeveloperMetadataResponse" - }, - "AppendDimensionRequest": { - "description": "Appends rows or columns to the end of a sheet.", - "type": "object", - "properties": { - "sheetId": { - "description": "The sheet to append rows or columns to.", - "format": "int32", - "type": "integer" - }, - "dimension": { - "enum": [ - "DIMENSION_UNSPECIFIED", - "ROWS", - "COLUMNS" - ], - "description": "Whether rows or columns should be appended.", - "type": "string", - "enumDescriptions": [ - "The default value, do not use.", - "Operates on the rows of a sheet.", - "Operates on the columns of a sheet." - ] - }, - "length": { - "description": "The number of rows or columns to append.", - "format": "int32", - "type": "integer" - } - }, - "id": "AppendDimensionRequest" - }, - "AddNamedRangeRequest": { - "description": "Adds a named range to the spreadsheet.", - "type": "object", - "properties": { - "namedRange": { - "$ref": "NamedRange", - "description": "The named range to add. The namedRangeId\nfield is optional; if one is not set, an id will be randomly generated. (It\nis an error to specify the ID of a range that already exists.)" - } - }, - "id": "AddNamedRangeRequest" - }, - "CreateDeveloperMetadataResponse": { - "description": "The response from creating developer metadata.", - "type": "object", - "properties": { - "developerMetadata": { - "description": "The developer metadata that was created.", - "$ref": "DeveloperMetadata" - } - }, - "id": "CreateDeveloperMetadataResponse" - }, - "UpdateEmbeddedObjectPositionRequest": { - "type": "object", - "properties": { - "newPosition": { - "$ref": "EmbeddedObjectPosition", - "description": "An explicit position to move the embedded object to.\nIf newPosition.sheetId is set,\na new sheet with that ID will be created.\nIf newPosition.newSheet is set to true,\na new sheet will be created with an ID that will be chosen for you." - }, - "fields": { - "description": "The fields of OverlayPosition\nthat should be updated when setting a new position. Used only if\nnewPosition.overlayPosition\nis set, in which case at least one field must\nbe specified. The root `newPosition.overlayPosition` is implied and\nshould not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" - }, - "objectId": { - "description": "The ID of the object to moved.", - "format": "int32", - "type": "integer" - } - }, - "id": "UpdateEmbeddedObjectPositionRequest", - "description": "Update an embedded object's position (such as a moving or resizing a\nchart or image)." - }, - "TextRotation": { - "description": "The rotation applied to text in a cell.", - "type": "object", - "properties": { - "angle": { - "description": "The angle between the standard orientation and the desired orientation.\nMeasured in degrees. Valid values are between -90 and 90. Positive\nangles are angled upwards, negative are angled downwards.\n\nNote: For LTR text direction positive angles are in the counterclockwise\ndirection, whereas for RTL they are in the clockwise direction", - "format": "int32", - "type": "integer" - }, - "vertical": { - "description": "If true, text reads top to bottom, but the orientation of individual\ncharacters is unchanged.\nFor example:\n\n | V |\n | e |\n | r |\n | t |\n | i |\n | c |\n | a |\n | l |", - "type": "boolean" - } - }, - "id": "TextRotation" - }, - "PieChartSpec": { - "description": "A \u003ca href=\"/chart/interactive/docs/gallery/piechart\"\u003epie chart\u003c/a\u003e.", - "type": "object", - "properties": { - "series": { - "$ref": "ChartData", - "description": "The data that covers the one and only series of the pie chart." - }, - "legendPosition": { - "enum": [ - "PIE_CHART_LEGEND_POSITION_UNSPECIFIED", - "BOTTOM_LEGEND", - "LEFT_LEGEND", - "RIGHT_LEGEND", - "TOP_LEGEND", - "NO_LEGEND", - "LABELED_LEGEND" - ], - "description": "Where the legend of the pie chart should be drawn.", - "type": "string", - "enumDescriptions": [ - "Default value, do not use.", - "The legend is rendered on the bottom of the chart.", - "The legend is rendered on the left of the chart.", - "The legend is rendered on the right of the chart.", - "The legend is rendered on the top of the chart.", - "No legend is rendered.", - "Each pie slice has a label attached to it." - ] - }, - "pieHole": { - "description": "The size of the hole in the pie chart.", - "format": "double", - "type": "number" - }, - "domain": { - "description": "The data that covers the domain of the pie chart.", - "$ref": "ChartData" - }, - "threeDimensional": { - "type": "boolean", - "description": "True if the pie is three dimensional." - } - }, - "id": "PieChartSpec" - }, - "UpdateDeveloperMetadataRequest": { - "description": "A request to update properties of developer metadata.\nUpdates the properties of the developer metadata selected by the filters to\nthe values provided in the DeveloperMetadata resource. Callers must\nspecify the properties they wish to update in the fields parameter, as well\nas specify at least one DataFilter matching the metadata they wish to\nupdate.", - "type": "object", - "properties": { - "dataFilters": { - "description": "The filters matching the developer metadata entries to update.", - "type": "array", - "items": { - "$ref": "DataFilter" - } - }, - "fields": { - "description": "The fields that should be updated. At least one field must be specified.\nThe root `developerMetadata` is implied and should not be specified.\nA single `\"*\"` can be used as short-hand for listing every field.", - "format": "google-fieldmask", - "type": "string" - }, - "developerMetadata": { - "$ref": "DeveloperMetadata", - "description": "The value that all metadata matched by the data filters will be updated to." - } - }, - "id": "UpdateDeveloperMetadataRequest" + "id": "AddBandingResponse" } }, "icons": { @@ -4805,74 +4802,6 @@ "resources": { "spreadsheets": { "methods": { - "get": { - "flatPath": "v4/spreadsheets/{spreadsheetId}", - "id": "sheets.spreadsheets.get", - "path": "v4/spreadsheets/{spreadsheetId}", - "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation.", - "httpMethod": "GET", - "response": { - "$ref": "Spreadsheet" - }, - "parameterOrder": [ - "spreadsheetId" - ], - "parameters": { - "ranges": { - "description": "The ranges to retrieve from the spreadsheet.", - "type": "string", - "repeated": true, - "location": "query" - }, - "includeGridData": { - "location": "query", - "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.", - "type": "boolean" - }, - "spreadsheetId": { - "location": "path", - "description": "The spreadsheet to request.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/spreadsheets", - "https://www.googleapis.com/auth/spreadsheets.readonly" - ] - }, - "getByDataFilter": { - "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.", - "request": { - "$ref": "GetSpreadsheetByDataFilterRequest" - }, - "response": { - "$ref": "Spreadsheet" - }, - "parameterOrder": [ - "spreadsheetId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/spreadsheets" - ], - "parameters": { - "spreadsheetId": { - "location": "path", - "description": "The spreadsheet to request.", - "required": true, - "type": "string" - } - }, - "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter", - "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter", - "id": "sheets.spreadsheets.getByDataFilter" - }, "create": { "response": { "$ref": "Spreadsheet" @@ -4894,12 +4823,13 @@ } }, "batchUpdate": { + "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate", "path": "v4/spreadsheets/{spreadsheetId}:batchUpdate", "id": "sheets.spreadsheets.batchUpdate", - "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.", "request": { "$ref": "BatchUpdateSpreadsheetRequest" }, + "description": "Applies one or more updates to the spreadsheet.\n\nEach request is validated before\nbeing applied. If any request is not valid then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how\nthey are applied. The replies will mirror the requests. For example,\nif you applied 4 updates and the 3rd one had a reply, then the\nresponse will have 2 empty replies, the actual reply, and another empty\nreply, in that order.\n\nDue to the collaborative nature of spreadsheets, it is not guaranteed that\nthe spreadsheet will reflect exactly your changes after this completes,\nhowever it is guaranteed that the updates in the request will be\napplied together atomically. Your changes may be altered with respect to\ncollaborator changes. If there are no collaborators, the spreadsheet\nshould reflect your changes.", "response": { "$ref": "BatchUpdateSpreadsheetResponse" }, @@ -4907,6 +4837,73 @@ "spreadsheetId" ], "httpMethod": "POST", + "parameters": { + "spreadsheetId": { + "location": "path", + "description": "The spreadsheet to apply the updates to.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets" + ] + }, + "get": { + "response": { + "$ref": "Spreadsheet" + }, + "parameterOrder": [ + "spreadsheetId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly" + ], + "parameters": { + "spreadsheetId": { + "location": "path", + "description": "The spreadsheet to request.", + "required": true, + "type": "string" + }, + "ranges": { + "location": "query", + "description": "The ranges to retrieve from the spreadsheet.", + "type": "string", + "repeated": true + }, + "includeGridData": { + "location": "query", + "description": "True if grid data should be returned.\nThis parameter is ignored if a field mask was set in the request.", + "type": "boolean" + } + }, + "flatPath": "v4/spreadsheets/{spreadsheetId}", + "path": "v4/spreadsheets/{spreadsheetId}", + "id": "sheets.spreadsheets.get", + "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nURL parameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.\n\nTo retrieve only subsets of the spreadsheet, use the\nranges URL parameter.\nMultiple ranges can be specified. Limiting the range will\nreturn only the portions of the spreadsheet that intersect the requested\nranges. Ranges are specified using A1 notation." + }, + "getByDataFilter": { + "path": "v4/spreadsheets/{spreadsheetId}:getByDataFilter", + "id": "sheets.spreadsheets.getByDataFilter", + "description": "Returns the spreadsheet at the given ID.\nThe caller must specify the spreadsheet ID.\n\nThis method differs from GetSpreadsheet in that it allows selecting\nwhich subsets of spreadsheet data to return by specifying a\ndataFilters parameter.\nMultiple DataFilters can be specified. Specifying one or\nmore data filters will return the portions of the spreadsheet that\nintersect ranges matched by any of the filters.\n\nBy default, data within grids will not be returned.\nYou can include grid data one of two ways:\n\n* Specify a field mask listing your desired fields using the `fields` URL\nparameter in HTTP\n\n* Set the includeGridData\nparameter to true. If a field mask is set, the `includeGridData`\nparameter is ignored\n\nFor large spreadsheets, it is recommended to retrieve only the specific\nfields of the spreadsheet that you want.", + "request": { + "$ref": "GetSpreadsheetByDataFilterRequest" + }, + "response": { + "$ref": "Spreadsheet" + }, + "parameterOrder": [ + "spreadsheetId" + ], + "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", @@ -4914,88 +4911,126 @@ ], "parameters": { "spreadsheetId": { + "description": "The spreadsheet to request.", "required": true, "type": "string", - "location": "path", - "description": "The spreadsheet to apply the updates to." + "location": "path" } }, - "flatPath": "v4/spreadsheets/{spreadsheetId}:batchUpdate" + "flatPath": "v4/spreadsheets/{spreadsheetId}:getByDataFilter" } }, "resources": { - "values": { + "developerMetadata": { "methods": { - "get": { - "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.", - "httpMethod": "GET", - "response": { - "$ref": "ValueRange" + "search": { + "request": { + "$ref": "SearchDeveloperMetadataRequest" }, + "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.", + "httpMethod": "POST", "parameterOrder": [ - "spreadsheetId", - "range" + "spreadsheetId" ], + "response": { + "$ref": "SearchDeveloperMetadataResponse" + }, "parameters": { - "valueRenderOption": { - "enum": [ - "FORMATTED_VALUE", - "UNFORMATTED_VALUE", - "FORMULA" - ], - "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", - "type": "string", - "location": "query" - }, - "dateTimeRenderOption": { - "type": "string", - "location": "query", - "enum": [ - "SERIAL_NUMBER", - "FORMATTED_STRING" - ], - "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]." - }, - "majorDimension": { - "enum": [ - "DIMENSION_UNSPECIFIED", - "ROWS", - "COLUMNS" - ], - "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.", - "type": "string", - "location": "query" - }, "spreadsheetId": { - "location": "path", - "description": "The ID of the spreadsheet to retrieve data from.", + "description": "The ID of the spreadsheet to retrieve metadata from.", "required": true, - "type": "string" - }, - "range": { - "location": "path", - "description": "The A1 notation of the values to retrieve.", - "required": true, - "type": "string" + "type": "string", + "location": "path" } }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/spreadsheets", - "https://www.googleapis.com/auth/spreadsheets.readonly" + "https://www.googleapis.com/auth/spreadsheets" ], - "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}", - "id": "sheets.spreadsheets.values.get", - "path": "v4/spreadsheets/{spreadsheetId}/values/{range}" + "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search", + "id": "sheets.spreadsheets.developerMetadata.search", + "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search" }, - "batchUpdateByDataFilter": { + "get": { + "response": { + "$ref": "DeveloperMetadata" + }, + "parameterOrder": [ + "spreadsheetId", + "metadataId" + ], + "httpMethod": "GET", + "parameters": { + "metadataId": { + "location": "path", + "description": "The ID of the developer metadata to retrieve.", + "format": "int32", + "required": true, + "type": "integer" + }, + "spreadsheetId": { + "description": "The ID of the spreadsheet to retrieve metadata from.", + "required": true, + "type": "string", + "location": "path" + } + }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/spreadsheets" ], + "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}", + "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}", + "id": "sheets.spreadsheets.developerMetadata.get", + "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId." + } + } + }, + "values": { + "methods": { + "batchGetByDataFilter": { + "request": { + "$ref": "BatchGetValuesByDataFilterRequest" + }, + "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.", + "response": { + "$ref": "BatchGetValuesByDataFilterResponse" + }, + "parameterOrder": [ + "spreadsheetId" + ], + "httpMethod": "POST", + "parameters": { + "spreadsheetId": { + "description": "The ID of the spreadsheet to retrieve data from.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets" + ], + "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter", + "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter", + "id": "sheets.spreadsheets.values.batchGetByDataFilter" + }, + "batchClear": { + "request": { + "$ref": "BatchClearValuesRequest" + }, + "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.", + "response": { + "$ref": "BatchClearValuesResponse" + }, + "parameterOrder": [ + "spreadsheetId" + ], + "httpMethod": "POST", "parameters": { "spreadsheetId": { "location": "path", @@ -5004,20 +5039,78 @@ "type": "string" } }, - "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter", - "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter", - "id": "sheets.spreadsheets.values.batchUpdateByDataFilter", - "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges.", - "request": { - "$ref": "BatchUpdateValuesByDataFilterRequest" - }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets" + ], + "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear", + "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear", + "id": "sheets.spreadsheets.values.batchClear" + }, + "get": { + "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}", + "path": "v4/spreadsheets/{spreadsheetId}/values/{range}", + "id": "sheets.spreadsheets.values.get", + "description": "Returns a range of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and a range.", "response": { - "$ref": "BatchUpdateValuesByDataFilterResponse" + "$ref": "ValueRange" }, "parameterOrder": [ - "spreadsheetId" + "spreadsheetId", + "range" ], - "httpMethod": "POST" + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly" + ], + "parameters": { + "range": { + "description": "The A1 notation of the values to retrieve.", + "required": true, + "type": "string", + "location": "path" + }, + "valueRenderOption": { + "location": "query", + "enum": [ + "FORMATTED_VALUE", + "UNFORMATTED_VALUE", + "FORMULA" + ], + "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", + "type": "string" + }, + "dateTimeRenderOption": { + "location": "query", + "enum": [ + "SERIAL_NUMBER", + "FORMATTED_STRING" + ], + "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].", + "type": "string" + }, + "majorDimension": { + "location": "query", + "enum": [ + "DIMENSION_UNSPECIFIED", + "ROWS", + "COLUMNS" + ], + "description": "The major dimension that results should use.\n\nFor example, if the spreadsheet data is: `A1=1,B1=2,A2=3,B2=4`,\nthen requesting `range=A1:B2,majorDimension=ROWS` will return\n`[[1,2],[3,4]]`,\nwhereas requesting `range=A1:B2,majorDimension=COLUMNS` will return\n`[[1,3],[2,4]]`.", + "type": "string" + }, + "spreadsheetId": { + "location": "path", + "description": "The ID of the spreadsheet to retrieve data from.", + "required": true, + "type": "string" + } + } }, "update": { "request": { @@ -5033,32 +5126,6 @@ ], "httpMethod": "PUT", "parameters": { - "responseDateTimeRenderOption": { - "type": "string", - "location": "query", - "enum": [ - "SERIAL_NUMBER", - "FORMATTED_STRING" - ], - "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER]." - }, - "includeValuesInResponse": { - "location": "query", - "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).", - "type": "boolean" - }, - "range": { - "description": "The A1 notation of the values to update.", - "required": true, - "type": "string", - "location": "path" - }, - "spreadsheetId": { - "required": true, - "type": "string", - "location": "path", - "description": "The ID of the spreadsheet to update." - }, "responseValueRenderOption": { "location": "query", "enum": [ @@ -5070,14 +5137,40 @@ "type": "string" }, "valueInputOption": { - "type": "string", - "location": "query", "enum": [ "INPUT_VALUE_OPTION_UNSPECIFIED", "RAW", "USER_ENTERED" ], - "description": "How the input data should be interpreted." + "description": "How the input data should be interpreted.", + "type": "string", + "location": "query" + }, + "responseDateTimeRenderOption": { + "enum": [ + "SERIAL_NUMBER", + "FORMATTED_STRING" + ], + "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].", + "type": "string", + "location": "query" + }, + "range": { + "description": "The A1 notation of the values to update.", + "required": true, + "type": "string", + "location": "path" + }, + "includeValuesInResponse": { + "location": "query", + "description": "Determines if the update response should include the values\nof the cells that were updated. By default, responses\ndo not include the updated values.\nIf the range to write was larger than than the range actually written,\nthe response will include all values in the requested range (excluding\ntrailing empty rows and columns).", + "type": "boolean" + }, + "spreadsheetId": { + "description": "The ID of the spreadsheet to update.", + "required": true, + "type": "string", + "location": "path" } }, "scopes": [ @@ -5089,6 +5182,35 @@ "path": "v4/spreadsheets/{spreadsheetId}/values/{range}", "id": "sheets.spreadsheets.values.update" }, + "batchUpdateByDataFilter": { + "request": { + "$ref": "BatchUpdateValuesByDataFilterRequest" + }, + "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nDataFilterValueRanges.", + "httpMethod": "POST", + "parameterOrder": [ + "spreadsheetId" + ], + "response": { + "$ref": "BatchUpdateValuesByDataFilterResponse" + }, + "parameters": { + "spreadsheetId": { + "location": "path", + "description": "The ID of the spreadsheet to update.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/spreadsheets" + ], + "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter", + "id": "sheets.spreadsheets.values.batchUpdateByDataFilter", + "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdateByDataFilter" + }, "batchUpdate": { "response": { "$ref": "BatchUpdateValuesResponse" @@ -5097,67 +5219,99 @@ "spreadsheetId" ], "httpMethod": "POST", + "parameters": { + "spreadsheetId": { + "location": "path", + "description": "The ID of the spreadsheet to update.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/spreadsheets" ], + "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate", + "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate", + "id": "sheets.spreadsheets.values.batchUpdate", + "request": { + "$ref": "BatchUpdateValuesRequest" + }, + "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges." + }, + "clear": { + "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear", + "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear", + "id": "sheets.spreadsheets.values.clear", + "request": { + "$ref": "ClearValuesRequest" + }, + "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.", + "response": { + "$ref": "ClearValuesResponse" + }, + "parameterOrder": [ + "spreadsheetId", + "range" + ], + "httpMethod": "POST", "parameters": { "spreadsheetId": { + "location": "path", "description": "The ID of the spreadsheet to update.", "required": true, + "type": "string" + }, + "range": { + "description": "The A1 notation of the values to clear.", + "required": true, "type": "string", "location": "path" } }, - "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate", - "path": "v4/spreadsheets/{spreadsheetId}/values:batchUpdate", - "id": "sheets.spreadsheets.values.batchUpdate", - "description": "Sets values in one or more ranges of a spreadsheet.\nThe caller must specify the spreadsheet ID,\na valueInputOption, and one or more\nValueRanges.", - "request": { - "$ref": "BatchUpdateValuesRequest" - } - }, - "batchGet": { - "response": { - "$ref": "BatchGetValuesResponse" - }, - "parameterOrder": [ - "spreadsheetId" - ], - "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/spreadsheets", - "https://www.googleapis.com/auth/spreadsheets.readonly" + "https://www.googleapis.com/auth/spreadsheets" + ] + }, + "batchGet": { + "id": "sheets.spreadsheets.values.batchGet", + "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet", + "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.", + "httpMethod": "GET", + "parameterOrder": [ + "spreadsheetId" ], + "response": { + "$ref": "BatchGetValuesResponse" + }, "parameters": { "valueRenderOption": { - "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", - "type": "string", - "location": "query", "enum": [ "FORMATTED_VALUE", "UNFORMATTED_VALUE", "FORMULA" - ] + ], + "description": "How values should be represented in the output.\nThe default render option is ValueRenderOption.FORMATTED_VALUE.", + "type": "string", + "location": "query" }, "dateTimeRenderOption": { + "location": "query", "enum": [ "SERIAL_NUMBER", "FORMATTED_STRING" ], "description": "How dates, times, and durations should be represented in the output.\nThis is ignored if value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].", - "type": "string", - "location": "query" + "type": "string" }, "ranges": { + "location": "query", "description": "The A1 notation of the values to retrieve.", "type": "string", - "repeated": true, - "location": "query" + "repeated": true }, "majorDimension": { "location": "query", @@ -5170,60 +5324,26 @@ "type": "string" }, "spreadsheetId": { - "location": "path", "description": "The ID of the spreadsheet to retrieve data from.", "required": true, - "type": "string" + "type": "string", + "location": "path" } }, - "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet", - "path": "v4/spreadsheets/{spreadsheetId}/values:batchGet", - "id": "sheets.spreadsheets.values.batchGet", - "description": "Returns one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges." - }, - "clear": { - "response": { - "$ref": "ClearValuesResponse" - }, - "parameterOrder": [ - "spreadsheetId", - "range" - ], - "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/spreadsheets" + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly" ], - "parameters": { - "range": { - "description": "The A1 notation of the values to clear.", - "required": true, - "type": "string", - "location": "path" - }, - "spreadsheetId": { - "description": "The ID of the spreadsheet to update.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear", - "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:clear", - "id": "sheets.spreadsheets.values.clear", - "description": "Clears values from a spreadsheet.\nThe caller must specify the spreadsheet ID and range.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.", - "request": { - "$ref": "ClearValuesRequest" - } + "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGet" }, "batchClearByDataFilter": { - "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter", - "id": "sheets.spreadsheets.values.batchClearByDataFilter", - "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.", "request": { "$ref": "BatchClearValuesByDataFilterRequest" }, + "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges matching any of the specified data\nfilters will be cleared. Only values are cleared -- all other properties\nof the cell (such as formatting, data validation, etc..) are kept.", "response": { "$ref": "BatchClearValuesByDataFilterResponse" }, @@ -5231,29 +5351,24 @@ "spreadsheetId" ], "httpMethod": "POST", + "parameters": { + "spreadsheetId": { + "location": "path", + "description": "The ID of the spreadsheet to update.", + "required": true, + "type": "string" + } + }, "scopes": [ "https://www.googleapis.com/auth/drive", "https://www.googleapis.com/auth/drive.file", "https://www.googleapis.com/auth/spreadsheets" ], - "parameters": { - "spreadsheetId": { - "required": true, - "type": "string", - "location": "path", - "description": "The ID of the spreadsheet to update." - } - }, - "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter" + "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter", + "path": "v4/spreadsheets/{spreadsheetId}/values:batchClearByDataFilter", + "id": "sheets.spreadsheets.values.batchClearByDataFilter" }, "append": { - "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append", - "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append", - "id": "sheets.spreadsheets.values.append", - "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.", - "request": { - "$ref": "ValueRange" - }, "response": { "$ref": "AppendValuesResponse" }, @@ -5268,22 +5383,11 @@ "https://www.googleapis.com/auth/spreadsheets" ], "parameters": { - "includeValuesInResponse": { - "location": "query", - "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.", - "type": "boolean" - }, - "range": { - "location": "path", - "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.", - "required": true, - "type": "string" - }, "spreadsheetId": { - "location": "path", "description": "The ID of the spreadsheet to update.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "responseValueRenderOption": { "location": "query", @@ -5305,14 +5409,14 @@ ] }, "valueInputOption": { + "description": "How the input data should be interpreted.", + "type": "string", "location": "query", "enum": [ "INPUT_VALUE_OPTION_UNSPECIFIED", "RAW", "USER_ENTERED" - ], - "description": "How the input data should be interpreted.", - "type": "string" + ] }, "responseDateTimeRenderOption": { "location": "query", @@ -5322,65 +5426,25 @@ ], "description": "Determines how dates, times, and durations in the response should be\nrendered. This is ignored if response_value_render_option is\nFORMATTED_VALUE.\nThe default dateTime render option is [DateTimeRenderOption.SERIAL_NUMBER].", "type": "string" - } - } - }, - "batchGetByDataFilter": { - "response": { - "$ref": "BatchGetValuesByDataFilterResponse" - }, - "parameterOrder": [ - "spreadsheetId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/spreadsheets" - ], - "parameters": { - "spreadsheetId": { - "location": "path", - "description": "The ID of the spreadsheet to retrieve data from.", - "required": true, - "type": "string" - } - }, - "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter", - "path": "v4/spreadsheets/{spreadsheetId}/values:batchGetByDataFilter", - "id": "sheets.spreadsheets.values.batchGetByDataFilter", - "description": "Returns one or more ranges of values that match the specified data filters.\nThe caller must specify the spreadsheet ID and one or more\nDataFilters. Ranges that match any of the data filters in\nthe request will be returned.", - "request": { - "$ref": "BatchGetValuesByDataFilterRequest" - } - }, - "batchClear": { - "flatPath": "v4/spreadsheets/{spreadsheetId}/values:batchClear", - "path": "v4/spreadsheets/{spreadsheetId}/values:batchClear", - "id": "sheets.spreadsheets.values.batchClear", - "description": "Clears one or more ranges of values from a spreadsheet.\nThe caller must specify the spreadsheet ID and one or more ranges.\nOnly values are cleared -- all other properties of the cell (such as\nformatting, data validation, etc..) are kept.", - "request": { - "$ref": "BatchClearValuesRequest" - }, - "response": { - "$ref": "BatchClearValuesResponse" - }, - "parameterOrder": [ - "spreadsheetId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/spreadsheets" - ], - "parameters": { - "spreadsheetId": { - "description": "The ID of the spreadsheet to update.", + }, + "includeValuesInResponse": { + "location": "query", + "description": "Determines if the update response should include the values\nof the cells that were appended. By default, responses\ndo not include the updated values.", + "type": "boolean" + }, + "range": { + "description": "The A1 notation of a range to search for a logical table of data.\nValues will be appended after the last row of the table.", "required": true, "type": "string", "location": "path" } + }, + "flatPath": "v4/spreadsheets/{spreadsheetId}/values/{range}:append", + "path": "v4/spreadsheets/{spreadsheetId}/values/{range}:append", + "id": "sheets.spreadsheets.values.append", + "description": "Appends values to a spreadsheet. The input range is used to search for\nexisting data and find a \"table\" within that range. Values will be\nappended to the next row of the table, starting with the first column of\nthe table. See the\n[guide](/sheets/api/guides/values#appending_values)\nand\n[sample code](/sheets/api/samples/writing#append_values)\nfor specific details of how tables are detected and data is appended.\n\nThe caller must specify the spreadsheet ID, range, and\na valueInputOption. The `valueInputOption` only\ncontrols how the input data will be added to the sheet (column-wise or\nrow-wise), it does not influence what cell the data starts being written\nto.", + "request": { + "$ref": "ValueRange" } } } @@ -5388,27 +5452,27 @@ "sheets": { "methods": { "copyTo": { - "httpMethod": "POST", + "response": { + "$ref": "SheetProperties" + }, "parameterOrder": [ "spreadsheetId", "sheetId" ], - "response": { - "$ref": "SheetProperties" - }, + "httpMethod": "POST", "parameters": { - "spreadsheetId": { - "description": "The ID of the spreadsheet containing the sheet to copy.", - "required": true, - "type": "string", - "location": "path" - }, "sheetId": { "location": "path", "description": "The ID of the sheet to copy.", "format": "int32", "required": true, "type": "integer" + }, + "spreadsheetId": { + "location": "path", + "description": "The ID of the spreadsheet containing the sheet to copy.", + "required": true, + "type": "string" } }, "scopes": [ @@ -5417,108 +5481,64 @@ "https://www.googleapis.com/auth/spreadsheets" ], "flatPath": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo", - "id": "sheets.spreadsheets.sheets.copyTo", "path": "v4/spreadsheets/{spreadsheetId}/sheets/{sheetId}:copyTo", + "id": "sheets.spreadsheets.sheets.copyTo", "request": { "$ref": "CopySheetToAnotherSpreadsheetRequest" }, "description": "Copies a single sheet from a spreadsheet to another spreadsheet.\nReturns the properties of the newly created sheet." } } - }, - "developerMetadata": { - "methods": { - "search": { - "id": "sheets.spreadsheets.developerMetadata.search", - "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search", - "request": { - "$ref": "SearchDeveloperMetadataRequest" - }, - "description": "Returns all developer metadata matching the specified DataFilter.\nIf the provided DataFilter represents a DeveloperMetadataLookup object,\nthis will return all DeveloperMetadata entries selected by it. If the\nDataFilter represents a location in a spreadsheet, this will return all\ndeveloper metadata associated with locations intersecting that region.", - "httpMethod": "POST", - "parameterOrder": [ - "spreadsheetId" - ], - "response": { - "$ref": "SearchDeveloperMetadataResponse" - }, - "parameters": { - "spreadsheetId": { - "required": true, - "type": "string", - "location": "path", - "description": "The ID of the spreadsheet to retrieve metadata from." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/spreadsheets" - ], - "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata:search" - }, - "get": { - "path": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}", - "id": "sheets.spreadsheets.developerMetadata.get", - "description": "Returns the developer metadata with the specified ID.\nThe caller must specify the spreadsheet ID and the developer metadata's\nunique metadataId.", - "response": { - "$ref": "DeveloperMetadata" - }, - "parameterOrder": [ - "spreadsheetId", - "metadataId" - ], - "httpMethod": "GET", - "parameters": { - "spreadsheetId": { - "required": true, - "type": "string", - "location": "path", - "description": "The ID of the spreadsheet to retrieve metadata from." - }, - "metadataId": { - "description": "The ID of the developer metadata to retrieve.", - "format": "int32", - "required": true, - "type": "integer", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/spreadsheets" - ], - "flatPath": "v4/spreadsheets/{spreadsheetId}/developerMetadata/{metadataId}" - } - } } } } }, "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "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.", + "type": "string", + "location": "query" }, - "prettyPrint": { + "pp": { + "description": "Pretty-print response.", "type": "boolean", "default": "true", + "location": "query" + }, + "oauth_token": { "location": "query", - "description": "Returns response with indentations and line breaks." + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, "$.xgafv": { + "description": "V1 error format.", + "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -5527,9 +5547,7 @@ "enum": [ "1", "2" - ], - "description": "V1 error format.", - "type": "string" + ] }, "callback": { "description": "JSONP", @@ -5537,6 +5555,12 @@ "location": "query" }, "alt": { + "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -5544,44 +5568,17 @@ "media", "proto" ], - "type": "string", - "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": { + "location": "query", + "description": "OAuth access token.", + "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.", "type": "string", "location": "query" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" } }, "version": "v4", @@ -5589,5 +5586,8 @@ "servicePath": "", "description": "Reads and writes Google Sheets.", "kind": "discovery#restDescription", - "basePath": "" + "basePath": "", + "revision": "20171220", + "documentationLink": "https://developers.google.com/sheets/", + "id": "sheets:v4" }
diff --git a/slides/v1/slides-api.json b/slides/v1/slides-api.json index 197d565..9463cc1 100644 --- a/slides/v1/slides-api.json +++ b/slides/v1/slides-api.json
@@ -1,293 +1,288 @@ { + "name": "slides", + "batchPath": "batch", + "title": "Google Slides API", + "ownerName": "Google", + "resources": { + "presentations": { + "methods": { + "get": { + "id": "slides.presentations.get", + "path": "v1/presentations/{+presentationId}", + "description": "Gets the latest version of the specified presentation.", + "httpMethod": "GET", + "response": { + "$ref": "Presentation" + }, + "parameterOrder": [ + "presentationId" + ], + "parameters": { + "presentationId": { + "description": "The ID of the presentation to retrieve.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/presentations", + "https://www.googleapis.com/auth/presentations.readonly" + ], + "flatPath": "v1/presentations/{presentationsId}" + }, + "create": { + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/presentations" + ], + "flatPath": "v1/presentations", + "id": "slides.presentations.create", + "path": "v1/presentations", + "request": { + "$ref": "Presentation" + }, + "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.", + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "Presentation" + } + }, + "batchUpdate": { + "parameters": { + "presentationId": { + "description": "The presentation to apply the updates to.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/presentations", + "https://www.googleapis.com/auth/spreadsheets", + "https://www.googleapis.com/auth/spreadsheets.readonly" + ], + "flatPath": "v1/presentations/{presentationId}:batchUpdate", + "id": "slides.presentations.batchUpdate", + "path": "v1/presentations/{presentationId}:batchUpdate", + "request": { + "$ref": "BatchUpdatePresentationRequest" + }, + "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically.", + "httpMethod": "POST", + "parameterOrder": [ + "presentationId" + ], + "response": { + "$ref": "BatchUpdatePresentationResponse" + } + } + }, + "resources": { + "pages": { + "methods": { + "get": { + "parameters": { + "pageObjectId": { + "location": "path", + "description": "The object ID of the page to retrieve.", + "required": true, + "type": "string" + }, + "presentationId": { + "description": "The ID of the presentation to retrieve.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/presentations", + "https://www.googleapis.com/auth/presentations.readonly" + ], + "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}", + "id": "slides.presentations.pages.get", + "path": "v1/presentations/{presentationId}/pages/{pageObjectId}", + "description": "Gets the latest version of the specified page in the presentation.", + "httpMethod": "GET", + "response": { + "$ref": "Page" + }, + "parameterOrder": [ + "presentationId", + "pageObjectId" + ] + }, + "getThumbnail": { + "scopes": [ + "https://www.googleapis.com/auth/drive", + "https://www.googleapis.com/auth/drive.file", + "https://www.googleapis.com/auth/drive.readonly", + "https://www.googleapis.com/auth/presentations", + "https://www.googleapis.com/auth/presentations.readonly" + ], + "parameters": { + "thumbnailProperties.mimeType": { + "description": "The optional mime type of the thumbnail image.\n\nIf you don't specify the mime type, the default mime type will be PNG.", + "type": "string", + "location": "query", + "enum": [ + "PNG" + ] + }, + "thumbnailProperties.thumbnailSize": { + "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage.", + "type": "string", + "location": "query", + "enum": [ + "THUMBNAIL_SIZE_UNSPECIFIED", + "LARGE" + ] + }, + "presentationId": { + "description": "The ID of the presentation to retrieve.", + "required": true, + "type": "string", + "location": "path" + }, + "pageObjectId": { + "location": "path", + "description": "The object ID of the page whose thumbnail to retrieve.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail", + "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail", + "id": "slides.presentations.pages.getThumbnail", + "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image.", + "response": { + "$ref": "Thumbnail" + }, + "parameterOrder": [ + "presentationId", + "pageObjectId" + ], + "httpMethod": "GET" + } + } + } + } + } + }, + "parameters": { + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "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.", + "type": "string", + "location": "query" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://slides.googleapis.com/", + "kind": "discovery#restDescription", + "description": "An API for creating and editing Google Slides presentations.", + "servicePath": "", + "basePath": "", + "id": "slides:v1", + "documentationLink": "https://developers.google.com/slides/", + "revision": "20180108", + "discoveryVersion": "v1", + "version_module": true, "schemas": { - "ReplaceAllShapesWithImageRequest": { - "description": "Replaces all shapes that match the given criteria with the provided image.", - "type": "object", - "properties": { - "containsText": { - "description": "If set, this request will replace all of the shapes that contain the\ngiven text.", - "$ref": "SubstringMatchCriteria" - }, - "pageObjectIds": { - "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.", - "type": "array", - "items": { - "type": "string" - } - }, - "imageUrl": { - "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.", - "type": "string" - }, - "replaceMethod": { - "description": "The replace method.", - "type": "string", - "enumDescriptions": [ - "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.", - "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape." - ], - "enum": [ - "CENTER_INSIDE", - "CENTER_CROP" - ] - } - }, - "id": "ReplaceAllShapesWithImageRequest" - }, - "MergeTableCellsRequest": { - "description": "Merges cells in a Table.", - "type": "object", - "properties": { - "objectId": { - "description": "The object ID of the table.", - "type": "string" - }, - "tableRange": { - "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned.", - "$ref": "TableRange" - } - }, - "id": "MergeTableCellsRequest" - }, - "UngroupObjectsRequest": { - "description": "Ungroups objects, such as groups.", - "type": "object", - "properties": { - "objectIds": { - "description": "The object IDs of the objects to ungroup.\n\nOnly groups that are not inside other\ngroups can be ungrouped. All the groups\nshould be on the same page. The group itself is deleted. The visual sizes\nand positions of all the children are preserved.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "UngroupObjectsRequest" - }, - "Shadow": { - "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.", - "type": "object", - "properties": { - "type": { - "enumDescriptions": [ - "Unspecified shadow type.", - "Outer shadow." - ], - "enum": [ - "SHADOW_TYPE_UNSPECIFIED", - "OUTER" - ], - "description": "The type of the shadow.", - "type": "string" - }, - "transform": { - "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position.", - "$ref": "AffineTransform" - }, - "alignment": { - "enumDescriptions": [ - "Unspecified.", - "Top left.", - "Top center.", - "Top right.", - "Left center.", - "Center.", - "Right center.", - "Bottom left.", - "Bottom center.", - "Bottom right." - ], - "enum": [ - "RECTANGLE_POSITION_UNSPECIFIED", - "TOP_LEFT", - "TOP_CENTER", - "TOP_RIGHT", - "LEFT_CENTER", - "CENTER", - "RIGHT_CENTER", - "BOTTOM_LEFT", - "BOTTOM_CENTER", - "BOTTOM_RIGHT" - ], - "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.", - "type": "string" - }, - "alpha": { - "description": "The alpha of the shadow's color, from 0.0 to 1.0.", - "format": "float", - "type": "number" - }, - "color": { - "description": "The shadow color value.", - "$ref": "OpaqueColor" - }, - "rotateWithShape": { - "description": "Whether the shadow should rotate with the shape.", - "type": "boolean" - }, - "propertyState": { - "enumDescriptions": [ - "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.", - "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.", - "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state." - ], - "enum": [ - "RENDERED", - "NOT_RENDERED", - "INHERIT" - ], - "description": "The shadow property state.\n\nUpdating the shadow on a page element will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To have\nno shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored.", - "type": "string" - }, - "blurRadius": { - "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes.", - "$ref": "Dimension" - } - }, - "id": "Shadow" - }, - "DeleteTableRowRequest": { - "description": "Deletes a row from a table.", - "type": "object", - "properties": { - "cellLocation": { - "$ref": "TableCellLocation", - "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted." - }, - "tableObjectId": { - "description": "The table to delete rows from.", - "type": "string" - } - }, - "id": "DeleteTableRowRequest" - }, - "Bullet": { - "description": "Describes the bullet of a paragraph.", - "type": "object", - "properties": { - "glyph": { - "description": "The rendered bullet glyph for this paragraph.", - "type": "string" - }, - "nestingLevel": { - "description": "The nesting level of this paragraph in the list.", - "format": "int32", - "type": "integer" - }, - "bulletStyle": { - "$ref": "TextStyle", - "description": "The paragraph specific text style applied to this bullet." - }, - "listId": { - "description": "The ID of the list this paragraph belongs to.", - "type": "string" - } - }, - "id": "Bullet" - }, - "OutlineFill": { - "description": "The fill of the outline.", - "type": "object", - "properties": { - "solidFill": { - "$ref": "SolidFill", - "description": "Solid color fill." - } - }, - "id": "OutlineFill" - }, - "CreateLineResponse": { - "description": "The result of creating a line.", - "type": "object", - "properties": { - "objectId": { - "description": "The object ID of the created line.", - "type": "string" - } - }, - "id": "CreateLineResponse" - }, - "TableCellLocation": { - "description": "A location of a single table cell within a table.", - "type": "object", - "properties": { - "rowIndex": { - "description": "The 0-based row index.", - "format": "int32", - "type": "integer" - }, - "columnIndex": { - "description": "The 0-based column index.", - "format": "int32", - "type": "integer" - } - }, - "id": "TableCellLocation" - }, - "ReplaceAllTextResponse": { - "description": "The result of replacing text.", - "type": "object", - "properties": { - "occurrencesChanged": { - "description": "The number of occurrences changed by replacing all text.", - "format": "int32", - "type": "integer" - } - }, - "id": "ReplaceAllTextResponse" - }, - "TableBorderFill": { - "description": "The fill of the border.", - "type": "object", - "properties": { - "solidFill": { - "description": "Solid fill.", - "$ref": "SolidFill" - } - }, - "id": "TableBorderFill" - }, - "UpdateParagraphStyleRequest": { - "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range.", - "type": "object", - "properties": { - "objectId": { - "description": "The object ID of the shape or table with the text to be styled.", - "type": "string" - }, - "textRange": { - "$ref": "Range", - "description": "The range of text containing the paragraph(s) to style." - }, - "cellLocation": { - "$ref": "TableCellLocation", - "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not." - }, - "style": { - "description": "The paragraph's style.", - "$ref": "ParagraphStyle" - }, - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", - "format": "google-fieldmask", - "type": "string" - } - }, - "id": "UpdateParagraphStyleRequest" - }, - "ColorScheme": { - "description": "The palette of predefined colors for a page.", - "type": "object", - "properties": { - "colors": { - "description": "The ThemeColorType and corresponding concrete color pairs.", - "type": "array", - "items": { - "$ref": "ThemeColorPair" - } - } - }, - "id": "ColorScheme" - }, "Shape": { "description": "A PageElement kind representing a\ngeneric shape that does not have a more specific classification.", "type": "object", @@ -595,8 +590,8 @@ "$ref": "Placeholder" }, "shapeProperties": { - "$ref": "ShapeProperties", - "description": "The properties of the shape." + "description": "The properties of the shape.", + "$ref": "ShapeProperties" } }, "id": "Shape" @@ -631,8 +626,6 @@ "type": "number" }, "unit": { - "description": "The units for translate elements.", - "type": "string", "enumDescriptions": [ "The units are unknown.", "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.", @@ -642,7 +635,9 @@ "UNIT_UNSPECIFIED", "EMU", "PT" - ] + ], + "description": "The units for translate elements.", + "type": "string" }, "scaleX": { "description": "The X coordinate scaling element.", @@ -668,9 +663,14 @@ "id": "AffineTransform" }, "InsertTextRequest": { + "id": "InsertTextRequest", "description": "Inserts text into a shape or a table cell.", "type": "object", "properties": { + "cellLocation": { + "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table.", + "$ref": "TableCellLocation" + }, "objectId": { "description": "The object ID of the shape or table where the text will be inserted.", "type": "string" @@ -683,23 +683,17 @@ "description": "The index where the text will be inserted, in Unicode code units, based\non TextElement indexes.\n\nThe index is zero-based and is computed from the start of the string.\nThe index may be adjusted to prevent insertions inside Unicode grapheme\nclusters. In these cases, the text will be inserted immediately after the\ngrapheme cluster.", "format": "int32", "type": "integer" - }, - "cellLocation": { - "$ref": "TableCellLocation", - "description": "The optional table cell location if the text is to be inserted into a table\ncell. If present, the object_id must refer to a table." } - }, - "id": "InsertTextRequest" + } }, "AutoText": { + "id": "AutoText", "description": "A TextElement kind that represents auto text.", "type": "object", "properties": { - "style": { - "$ref": "TextStyle", - "description": "The styling applied to this auto text." - }, "type": { + "description": "The type of this auto text.", + "type": "string", "enumDescriptions": [ "An unspecified autotext type.", "Type for autotext that represents the current slide number." @@ -707,16 +701,17 @@ "enum": [ "TYPE_UNSPECIFIED", "SLIDE_NUMBER" - ], - "description": "The type of this auto text.", - "type": "string" + ] }, "content": { "description": "The rendered content of this auto text, if available.", "type": "string" + }, + "style": { + "description": "The styling applied to this auto text.", + "$ref": "TextStyle" } - }, - "id": "AutoText" + } }, "CreateVideoResponse": { "description": "The result of creating a video.", @@ -738,8 +733,8 @@ "type": "string" }, "transform": { - "description": "The input transform matrix used to update the page element.", - "$ref": "AffineTransform" + "$ref": "AffineTransform", + "description": "The input transform matrix used to update the page element." }, "applyMode": { "enumDescriptions": [ @@ -771,13 +766,14 @@ "description": "The range of text to delete, based on TextElement indexes.\n\nThere is always an implicit newline character at the end of a shape's or\ntable cell's text that cannot be deleted. `Range.Type.ALL` will use the\ncorrect bounds, but care must be taken when specifying explicit bounds for\nrange types `FROM_START_INDEX` and `FIXED_RANGE`. For example, if the text\nis \"ABC\", followed by an implicit newline, then the maximum value is 2 for\n`text_range.start_index` and 3 for `text_range.end_index`.\n\nDeleting text that crosses a paragraph boundary may result in changes\nto paragraph styles and lists as the two paragraphs are merged.\n\nRanges that include only one code unit of a surrogate pair are expanded to\ninclude both code units." }, "cellLocation": { - "$ref": "TableCellLocation", - "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table." + "description": "The optional table cell location if the text is to be deleted from a table\ncell. If present, the object_id must refer to a table.", + "$ref": "TableCellLocation" } }, "id": "DeleteTextRequest" }, "DeleteObjectRequest": { + "id": "DeleteObjectRequest", "description": "Deletes an object, either pages or\npage elements, from the\npresentation.", "type": "object", "properties": { @@ -785,16 +781,24 @@ "description": "The object ID of the page or page element to delete.\n\nIf after a delete operation a group contains\nonly 1 or no page elements, the group is also deleted.\n\nIf a placeholder is deleted on a layout, any empty inheriting shapes are\nalso deleted.", "type": "string" } - }, - "id": "DeleteObjectRequest" + } }, "TextElement": { + "id": "TextElement", "description": "A TextElement describes the content of a range of indices in the text content\nof a Shape or TableCell.", "type": "object", "properties": { + "textRun": { + "$ref": "TextRun", + "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs." + }, + "autoText": { + "$ref": "AutoText", + "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time." + }, "paragraphMarker": { - "$ref": "ParagraphMarker", - "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap." + "description": "A marker representing the beginning of a new paragraph.\n\nThe `start_index` and `end_index` of this TextElement represent the\nrange of the paragraph. Other TextElements with an index range contained\ninside this paragraph's range are considered to be part of this\nparagraph. The range of indices of two separate paragraphs will never\noverlap.", + "$ref": "ParagraphMarker" }, "startIndex": { "description": "The zero-based start index of this text element, in Unicode code units.", @@ -805,19 +809,11 @@ "description": "The zero-based end index of this text element, exclusive, in Unicode code\nunits.", "format": "int32", "type": "integer" - }, - "textRun": { - "description": "A TextElement representing a run of text where all of the characters\nin the run have the same TextStyle.\n\nThe `start_index` and `end_index` of TextRuns will always be fully\ncontained in the index range of a single `paragraph_marker` TextElement.\nIn other words, a TextRun will never span multiple paragraphs.", - "$ref": "TextRun" - }, - "autoText": { - "$ref": "AutoText", - "description": "A TextElement representing a spot in the text that is dynamically\nreplaced with content that can change over time." } - }, - "id": "TextElement" + } }, "Dimension": { + "id": "Dimension", "description": "A magnitude in a single direction in the specified units.", "type": "object", "properties": { @@ -827,6 +823,8 @@ "type": "number" }, "unit": { + "description": "The units for magnitude.", + "type": "string", "enumDescriptions": [ "The units are unknown.", "An English Metric Unit (EMU) is defined as 1/360,000 of a centimeter\nand thus there are 914,400 EMUs per inch, and 12,700 EMUs per point.", @@ -836,12 +834,9 @@ "UNIT_UNSPECIFIED", "EMU", "PT" - ], - "description": "The units for magnitude.", - "type": "string" + ] } - }, - "id": "Dimension" + } }, "LineFill": { "description": "The fill of the line.", @@ -855,6 +850,7 @@ "id": "LineFill" }, "VideoProperties": { + "id": "VideoProperties", "description": "The properties of the Video.", "type": "object", "properties": { @@ -862,41 +858,36 @@ "$ref": "Outline", "description": "The outline of the video. The default outline matches the defaults for new\nvideos created in the Slides editor." } - }, - "id": "VideoProperties" + } }, "InsertTableRowsRequest": { + "id": "InsertTableRowsRequest", "description": "Inserts rows into a table.", "type": "object", "properties": { + "insertBelow": { + "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.", + "type": "boolean" + }, "number": { "description": "The number of rows to be inserted. Maximum 20 per request.", "format": "int32", "type": "integer" }, "cellLocation": { - "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell.", - "$ref": "TableCellLocation" + "$ref": "TableCellLocation", + "description": "The reference table cell location from which rows will be inserted.\n\nA new row will be inserted above (or below) the row where the reference\ncell is. If the reference cell is a merged cell, a new row will be\ninserted above (or below) the merged cell." }, "tableObjectId": { "description": "The table to insert rows into.", "type": "string" - }, - "insertBelow": { - "description": "Whether to insert new rows below the reference cell location.\n\n- `True`: insert below the cell.\n- `False`: insert above the cell.", - "type": "boolean" } - }, - "id": "InsertTableRowsRequest" + } }, "LayoutProperties": { "description": "The properties of Page are only\nrelevant for pages with page_type LAYOUT.", "type": "object", "properties": { - "masterObjectId": { - "description": "The object ID of the master that this layout is based on.", - "type": "string" - }, "name": { "description": "The name of the layout.", "type": "string" @@ -904,89 +895,20 @@ "displayName": { "description": "The human-readable name of the layout.", "type": "string" + }, + "masterObjectId": { + "description": "The object ID of the master that this layout is based on.", + "type": "string" } }, "id": "LayoutProperties" }, "LineProperties": { + "id": "LineProperties", "description": "The properties of the Line.\n\nWhen unset, these fields default to values that match the appearance of\nnew lines created in the Slides editor.", "type": "object", "properties": { - "startArrow": { - "enumDescriptions": [ - "An unspecified arrow style.", - "No arrow.", - "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.", - "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.", - "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.", - "Filled square.", - "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.", - "Hollow arrow.", - "Hollow circle.", - "Hollow square.", - "Hollow diamond." - ], - "enum": [ - "ARROW_STYLE_UNSPECIFIED", - "NONE", - "STEALTH_ARROW", - "FILL_ARROW", - "FILL_CIRCLE", - "FILL_SQUARE", - "FILL_DIAMOND", - "OPEN_ARROW", - "OPEN_CIRCLE", - "OPEN_SQUARE", - "OPEN_DIAMOND" - ], - "description": "The style of the arrow at the beginning of the line.", - "type": "string" - }, - "endArrow": { - "description": "The style of the arrow at the end of the line.", - "type": "string", - "enumDescriptions": [ - "An unspecified arrow style.", - "No arrow.", - "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.", - "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.", - "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.", - "Filled square.", - "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.", - "Hollow arrow.", - "Hollow circle.", - "Hollow square.", - "Hollow diamond." - ], - "enum": [ - "ARROW_STYLE_UNSPECIFIED", - "NONE", - "STEALTH_ARROW", - "FILL_ARROW", - "FILL_CIRCLE", - "FILL_SQUARE", - "FILL_DIAMOND", - "OPEN_ARROW", - "OPEN_CIRCLE", - "OPEN_SQUARE", - "OPEN_DIAMOND" - ] - }, - "weight": { - "$ref": "Dimension", - "description": "The thickness of the line." - }, - "lineFill": { - "$ref": "LineFill", - "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor." - }, - "link": { - "$ref": "Link", - "description": "The hyperlink destination of the line. If unset, there is no link." - }, "dashStyle": { - "description": "The dash style of the line.", - "type": "string", "enumDescriptions": [ "Unspecified dash style.", "Solid line. Corresponds to ECMA-376 ST_PresetLineDashVal value 'solid'.\nThis is the default dash style.", @@ -1004,33 +926,92 @@ "DASH_DOT", "LONG_DASH", "LONG_DASH_DOT" + ], + "description": "The dash style of the line.", + "type": "string" + }, + "link": { + "description": "The hyperlink destination of the line. If unset, there is no link.", + "$ref": "Link" + }, + "startArrow": { + "description": "The style of the arrow at the beginning of the line.", + "type": "string", + "enumDescriptions": [ + "An unspecified arrow style.", + "No arrow.", + "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.", + "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.", + "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.", + "Filled square.", + "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.", + "Hollow arrow.", + "Hollow circle.", + "Hollow square.", + "Hollow diamond." + ], + "enum": [ + "ARROW_STYLE_UNSPECIFIED", + "NONE", + "STEALTH_ARROW", + "FILL_ARROW", + "FILL_CIRCLE", + "FILL_SQUARE", + "FILL_DIAMOND", + "OPEN_ARROW", + "OPEN_CIRCLE", + "OPEN_SQUARE", + "OPEN_DIAMOND" ] + }, + "endArrow": { + "enumDescriptions": [ + "An unspecified arrow style.", + "No arrow.", + "Arrow with notched back. Corresponds to ECMA-376 ST_LineEndType value\n'stealth'.", + "Filled arrow. Corresponds to ECMA-376 ST_LineEndType value 'triangle'.", + "Filled circle. Corresponds to ECMA-376 ST_LineEndType value 'oval'.", + "Filled square.", + "Filled diamond. Corresponds to ECMA-376 ST_LineEndType value 'diamond'.", + "Hollow arrow.", + "Hollow circle.", + "Hollow square.", + "Hollow diamond." + ], + "enum": [ + "ARROW_STYLE_UNSPECIFIED", + "NONE", + "STEALTH_ARROW", + "FILL_ARROW", + "FILL_CIRCLE", + "FILL_SQUARE", + "FILL_DIAMOND", + "OPEN_ARROW", + "OPEN_CIRCLE", + "OPEN_SQUARE", + "OPEN_DIAMOND" + ], + "description": "The style of the arrow at the end of the line.", + "type": "string" + }, + "weight": { + "$ref": "Dimension", + "description": "The thickness of the line." + }, + "lineFill": { + "description": "The fill of the line. The default line fill matches the defaults for new\nlines created in the Slides editor.", + "$ref": "LineFill" } - }, - "id": "LineProperties" + } }, "Presentation": { + "id": "Presentation", "description": "A Google Slides presentation.", "type": "object", "properties": { - "presentationId": { - "description": "The ID of the presentation.", - "type": "string" - }, - "slides": { - "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.", - "type": "array", - "items": { - "$ref": "Page" - } - }, - "revisionId": { - "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.", - "type": "string" - }, "notesMaster": { - "$ref": "Page", - "description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only." + "description": "The notes master in the presentation. It serves three purposes:\n\n- Placeholder shapes on a notes master contain the default text styles and\n shape properties of all placeholder shapes on notes pages. Specifically,\n a `SLIDE_IMAGE` placeholder shape contains the slide thumbnail, and a\n `BODY` placeholder shape contains the speaker notes.\n- The notes master page properties define the common page properties\n inherited by all notes pages.\n- Any other shapes on the notes master will appear on all notes pages.\n\nThe notes master is read-only.", + "$ref": "Page" }, "title": { "description": "The title of the presentation.", @@ -1057,11 +1038,26 @@ "pageSize": { "$ref": "Size", "description": "The size of pages in the presentation." + }, + "presentationId": { + "description": "The ID of the presentation.", + "type": "string" + }, + "slides": { + "description": "The slides in the presentation.\nA slide inherits properties from a slide layout.", + "type": "array", + "items": { + "$ref": "Page" + } + }, + "revisionId": { + "description": "The revision ID of the presentation. Can be used in update requests\nto assert that the presentation revision hasn't changed since the last\nread operation. Only populated if the user has edit access to the\npresentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.", + "type": "string" } - }, - "id": "Presentation" + } }, "OpaqueColor": { + "id": "OpaqueColor", "description": "A themeable solid color value.", "type": "object", "properties": { @@ -1070,6 +1066,8 @@ "$ref": "RgbColor" }, "themeColor": { + "description": "An opaque theme color.", + "type": "string", "enumDescriptions": [ "Unspecified theme color. This value should not be used.", "Represents the first dark color.", @@ -1107,28 +1105,18 @@ "BACKGROUND1", "TEXT2", "BACKGROUND2" - ], - "description": "An opaque theme color.", - "type": "string" + ] } - }, - "id": "OpaqueColor" + } }, "ImageProperties": { + "id": "ImageProperties", "description": "The properties of the Image.", "type": "object", "properties": { - "cropProperties": { - "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only.", - "$ref": "CropProperties" - }, - "recolor": { - "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only.", - "$ref": "Recolor" - }, "outline": { - "$ref": "Outline", - "description": "The outline of the image. If not set, the image has no outline." + "description": "The outline of the image. If not set, the image has no outline.", + "$ref": "Outline" }, "brightness": { "description": "The brightness effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.", @@ -1152,9 +1140,16 @@ "description": "The contrast effect of the image. The value should be in the interval\n[-1.0, 1.0], where 0 means no effect. This property is read-only.", "format": "float", "type": "number" + }, + "cropProperties": { + "$ref": "CropProperties", + "description": "The crop properties of the image. If not set, the image is not cropped.\nThis property is read-only." + }, + "recolor": { + "$ref": "Recolor", + "description": "The recolor effect of the image. If not set, the image is not recolored.\nThis property is read-only." } - }, - "id": "ImageProperties" + } }, "ReplaceAllShapesWithImageResponse": { "description": "The result of replacing shapes with an image.", @@ -1169,13 +1164,10 @@ "id": "ReplaceAllShapesWithImageResponse" }, "Line": { + "id": "Line", "description": "A PageElement kind representing a\nline, curved connector, or bent connector.", "type": "object", "properties": { - "lineProperties": { - "description": "The properties of the line.", - "$ref": "LineProperties" - }, "lineType": { "description": "The type of the line.", "type": "string", @@ -1203,11 +1195,15 @@ "CURVED_CONNECTOR_4", "CURVED_CONNECTOR_5" ] + }, + "lineProperties": { + "$ref": "LineProperties", + "description": "The properties of the line." } - }, - "id": "Line" + } }, "BatchUpdatePresentationResponse": { + "id": "BatchUpdatePresentationResponse", "description": "Response message from a batch update.", "type": "object", "properties": { @@ -1222,18 +1218,12 @@ "$ref": "Response" } } - }, - "id": "BatchUpdatePresentationResponse" + } }, "CreateSheetsChartRequest": { "description": "Creates an embedded Google Sheets chart.\n\nNOTE: Chart creation requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.", "type": "object", "properties": { - "chartId": { - "description": "The ID of the specific chart in the Google Sheets spreadsheet.", - "format": "int32", - "type": "integer" - }, "objectId": { "description": "A user-supplied object ID.\n\nIf specified, the ID must be unique among all pages and page elements in\nthe presentation. The ID should start with a word character [a-zA-Z0-9_]\nand then followed by any number of the following characters [a-zA-Z0-9_-:].\nThe length of the ID should not be less than 5 or greater than 50.\nIf empty, a unique identifier will be generated.", "type": "string" @@ -1247,6 +1237,8 @@ "type": "string" }, "linkingMode": { + "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.", + "type": "string", "enumDescriptions": [ "The chart is not associated with the source spreadsheet and cannot be\nupdated. A chart that is not linked will be inserted as an image.", "Linking the chart allows it to be updated, and other collaborators will\nsee a link to the spreadsheet." @@ -1254,9 +1246,12 @@ "enum": [ "NOT_LINKED_IMAGE", "LINKED" - ], - "description": "The mode with which the chart is linked to the source spreadsheet. When\nnot specified, the chart will be an image that is not linked.", - "type": "string" + ] + }, + "chartId": { + "description": "The ID of the specific chart in the Google Sheets spreadsheet.", + "format": "int32", + "type": "integer" } }, "id": "CreateSheetsChartRequest" @@ -1291,61 +1286,6 @@ }, "id": "SlideProperties" }, - "Response": { - "description": "A single response from an update.", - "type": "object", - "properties": { - "duplicateObject": { - "$ref": "DuplicateObjectResponse", - "description": "The result of duplicating an object." - }, - "createLine": { - "$ref": "CreateLineResponse", - "description": "The result of creating a line." - }, - "createImage": { - "$ref": "CreateImageResponse", - "description": "The result of creating an image." - }, - "createVideo": { - "description": "The result of creating a video.", - "$ref": "CreateVideoResponse" - }, - "createSheetsChart": { - "description": "The result of creating a Google Sheets chart.", - "$ref": "CreateSheetsChartResponse" - }, - "replaceAllShapesWithSheetsChart": { - "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart.", - "$ref": "ReplaceAllShapesWithSheetsChartResponse" - }, - "groupObjects": { - "$ref": "GroupObjectsResponse", - "description": "The result of grouping objects." - }, - "createShape": { - "$ref": "CreateShapeResponse", - "description": "The result of creating a shape." - }, - "replaceAllShapesWithImage": { - "description": "The result of replacing all shapes matching some criteria with an\nimage.", - "$ref": "ReplaceAllShapesWithImageResponse" - }, - "createTable": { - "description": "The result of creating a table.", - "$ref": "CreateTableResponse" - }, - "replaceAllText": { - "$ref": "ReplaceAllTextResponse", - "description": "The result of replacing text." - }, - "createSlide": { - "$ref": "CreateSlideResponse", - "description": "The result of creating a slide." - } - }, - "id": "Response" - }, "MasterProperties": { "description": "The properties of Page that are only\nrelevant for pages with page_type MASTER.", "type": "object", @@ -1357,6 +1297,61 @@ }, "id": "MasterProperties" }, + "Response": { + "description": "A single response from an update.", + "type": "object", + "properties": { + "replaceAllShapesWithImage": { + "$ref": "ReplaceAllShapesWithImageResponse", + "description": "The result of replacing all shapes matching some criteria with an\nimage." + }, + "createTable": { + "description": "The result of creating a table.", + "$ref": "CreateTableResponse" + }, + "replaceAllText": { + "description": "The result of replacing text.", + "$ref": "ReplaceAllTextResponse" + }, + "createSlide": { + "description": "The result of creating a slide.", + "$ref": "CreateSlideResponse" + }, + "duplicateObject": { + "$ref": "DuplicateObjectResponse", + "description": "The result of duplicating an object." + }, + "createLine": { + "$ref": "CreateLineResponse", + "description": "The result of creating a line." + }, + "createImage": { + "description": "The result of creating an image.", + "$ref": "CreateImageResponse" + }, + "createVideo": { + "$ref": "CreateVideoResponse", + "description": "The result of creating a video." + }, + "createSheetsChart": { + "description": "The result of creating a Google Sheets chart.", + "$ref": "CreateSheetsChartResponse" + }, + "replaceAllShapesWithSheetsChart": { + "$ref": "ReplaceAllShapesWithSheetsChartResponse", + "description": "The result of replacing all shapes matching some criteria with a Google\nSheets chart." + }, + "groupObjects": { + "$ref": "GroupObjectsResponse", + "description": "The result of grouping objects." + }, + "createShape": { + "description": "The result of creating a shape.", + "$ref": "CreateShapeResponse" + } + }, + "id": "Response" + }, "SubstringMatchCriteria": { "description": "A criteria that matches a specific string of text in a shape or table.", "type": "object", @@ -1373,12 +1368,15 @@ "id": "SubstringMatchCriteria" }, "LayoutReference": { + "id": "LayoutReference", "description": "Slide layout reference. This may reference either:\n\n- A predefined layout\n- One of the layouts in the presentation.", "type": "object", "properties": { + "layoutId": { + "description": "Layout ID: the object ID of one of the layouts in the presentation.", + "type": "string" + }, "predefinedLayout": { - "description": "Predefined layout.", - "type": "string", "enumDescriptions": [ "Unspecified layout.", "Blank layout, with no placeholders.", @@ -1406,26 +1404,23 @@ "ONE_COLUMN_TEXT", "MAIN_POINT", "BIG_NUMBER" - ] - }, - "layoutId": { - "description": "Layout ID: the object ID of one of the layouts in the presentation.", + ], + "description": "Predefined layout.", "type": "string" } - }, - "id": "LayoutReference" + } }, "TextRun": { "description": "A TextElement kind that represents a run of text that all has the same\nstyling.", "type": "object", "properties": { + "style": { + "description": "The styling applied to this run.", + "$ref": "TextStyle" + }, "content": { "description": "The text of this run.", "type": "string" - }, - "style": { - "$ref": "TextStyle", - "description": "The styling applied to this run." } }, "id": "TextRun" @@ -1452,14 +1447,10 @@ "id": "TableRange" }, "CreateTableRequest": { + "id": "CreateTableRequest", "description": "Creates a new table.", "type": "object", "properties": { - "rows": { - "description": "Number of rows in the table.", - "format": "int32", - "type": "integer" - }, "objectId": { "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.", "type": "string" @@ -1472,9 +1463,13 @@ "elementProperties": { "description": "The element properties for the table.\n\nThe table will be created at the provided size, subject to a minimum size.\nIf no size is provided, the table will be automatically sized.\n\nTable transforms must have a scale of 1 and no shear components. If no\ntransform is provided, the table will be centered on the page.", "$ref": "PageElementProperties" + }, + "rows": { + "description": "Number of rows in the table.", + "format": "int32", + "type": "integer" } - }, - "id": "CreateTableRequest" + } }, "CreateTableResponse": { "description": "The result of creating a table.", @@ -1491,18 +1486,6 @@ "description": "A PageElement kind representing a\ntable.", "type": "object", "properties": { - "columns": { - "description": "Number of columns in the table.", - "format": "int32", - "type": "integer" - }, - "tableRows": { - "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1.", - "type": "array", - "items": { - "$ref": "TableRow" - } - }, "horizontalBorderRows": { "description": "Properties of horizontal cell borders.\n\nA table's horizontal cell borders are represented as a grid. The grid has\none more row than the number of rows in the table and the same number of\ncolumns as the table. For example, if the table is 3 x 3, its horizontal\nborders will be represented as a grid with 4 rows and 3 columns.", "type": "array", @@ -1528,6 +1511,18 @@ "items": { "$ref": "TableColumnProperties" } + }, + "columns": { + "description": "Number of columns in the table.", + "format": "int32", + "type": "integer" + }, + "tableRows": { + "description": "Properties and contents of each row.\n\nCells that span multiple rows are contained in only one of these rows and\nhave a row_span greater\nthan 1.", + "type": "array", + "items": { + "$ref": "TableRow" + } } }, "id": "Table" @@ -1565,10 +1560,17 @@ "id": "TableBorderRow" }, "PageBackgroundFill": { + "id": "PageBackgroundFill", "description": "The page background fill.", "type": "object", "properties": { + "solidFill": { + "description": "Solid color fill.", + "$ref": "SolidFill" + }, "propertyState": { + "description": "The background fill property state.\n\nUpdating the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.", + "type": "string", "enumDescriptions": [ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.", "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.", @@ -1578,33 +1580,18 @@ "RENDERED", "NOT_RENDERED", "INHERIT" - ], - "description": "The background fill property state.\n\nUpdating the fill on a page will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a page, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.", - "type": "string" + ] }, "stretchedPictureFill": { - "description": "Stretched picture fill.", - "$ref": "StretchedPictureFill" - }, - "solidFill": { - "$ref": "SolidFill", - "description": "Solid color fill." + "$ref": "StretchedPictureFill", + "description": "Stretched picture fill." } - }, - "id": "PageBackgroundFill" + } }, "SheetsChart": { "description": "A PageElement kind representing\na linked chart embedded from Google Sheets.", "type": "object", "properties": { - "sheetsChartProperties": { - "description": "The properties of the Sheets chart.", - "$ref": "SheetsChartProperties" - }, - "contentUrl": { - "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.", - "type": "string" - }, "spreadsheetId": { "description": "The ID of the Google Sheets spreadsheet that contains the source chart.", "type": "string" @@ -1613,6 +1600,14 @@ "description": "The ID of the specific chart in the Google Sheets spreadsheet that is\nembedded.", "format": "int32", "type": "integer" + }, + "sheetsChartProperties": { + "description": "The properties of the Sheets chart.", + "$ref": "SheetsChartProperties" + }, + "contentUrl": { + "description": "The URL of an image of the embedded chart, with a default lifetime of 30\nminutes. This URL is tagged with the account of the requester. Anyone with\nthe URL effectively accesses the image as the original requester. Access to\nthe image may be lost if the presentation's sharing settings change.", + "type": "string" } }, "id": "SheetsChart" @@ -1627,23 +1622,22 @@ "type": "number" }, "color": { - "description": "The color value of the solid fill.", - "$ref": "OpaqueColor" + "$ref": "OpaqueColor", + "description": "The color value of the solid fill." } }, "id": "SolidFill" }, "ThemeColorPair": { + "id": "ThemeColorPair", "description": "A pair mapping a theme color type to the concrete color it represents.", "type": "object", "properties": { "color": { - "$ref": "RgbColor", - "description": "The concrete color corresponding to the theme color type above." + "description": "The concrete color corresponding to the theme color type above.", + "$ref": "RgbColor" }, "type": { - "description": "The type of the theme color.", - "type": "string", "enumDescriptions": [ "Unspecified theme color. This value should not be used.", "Represents the first dark color.", @@ -1681,10 +1675,11 @@ "BACKGROUND1", "TEXT2", "BACKGROUND2" - ] + ], + "description": "The type of the theme color.", + "type": "string" } - }, - "id": "ThemeColorPair" + } }, "OptionalColor": { "description": "A color that can either be fully opaque or fully transparent.", @@ -1698,6 +1693,7 @@ "id": "OptionalColor" }, "PageElementProperties": { + "id": "PageElementProperties", "description": "Common properties for a page element.\n\nNote: When you initially create a\nPageElement, the API may modify\nthe values of both `size` and `transform`, but the\nvisual size will be unchanged.", "type": "object", "properties": { @@ -1713,16 +1709,15 @@ "description": "The object ID of the page where the element is located.", "type": "string" } - }, - "id": "PageElementProperties" + } }, "SheetsChartProperties": { "description": "The properties of the SheetsChart.", "type": "object", "properties": { "chartImageProperties": { - "description": "The properties of the embedded chart image.", - "$ref": "ImageProperties" + "$ref": "ImageProperties", + "description": "The properties of the embedded chart image." } }, "id": "SheetsChartProperties" @@ -1758,32 +1753,32 @@ "id": "DeleteTableColumnRequest" }, "UpdateTextStyleRequest": { + "id": "UpdateTextStyleRequest", "description": "Update the styling of text in a Shape or\nTable.", "type": "object", "properties": { - "objectId": { - "description": "The object ID of the shape or table with the text to be styled.", - "type": "string" - }, - "textRange": { - "$ref": "Range", - "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style." - }, "cellLocation": { - "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not.", - "$ref": "TableCellLocation" + "$ref": "TableCellLocation", + "description": "The location of the cell in the table containing the text to style. If\n`object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not." }, "style": { - "$ref": "TextStyle", - "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information." + "description": "The style(s) to set on the text.\n\nIf the value for a particular style matches that of the parent, that style\nwill be set to inherit.\n\nCertain text style changes may cause other changes meant to mirror the\nbehavior of the Slides editor. See the documentation of\nTextStyle for more information.", + "$ref": "TextStyle" }, "fields": { "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the text style to bold, set `fields` to `\"bold\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", "format": "google-fieldmask", "type": "string" + }, + "objectId": { + "description": "The object ID of the shape or table with the text to be styled.", + "type": "string" + }, + "textRange": { + "description": "The range of text to style.\n\nThe range may be extended to include adjacent newlines.\n\nIf the range fully contains a paragraph belonging to a list, the\nparagraph's bullet is also updated with the matching text style.", + "$ref": "Range" } - }, - "id": "UpdateTextStyleRequest" + } }, "List": { "description": "A List describes the look and feel of bullets belonging to paragraphs\nassociated with a list. A paragraph that is part of a list has an implicit\nreference to that list's ID.", @@ -1804,6 +1799,7 @@ "id": "List" }, "WeightedFontFamily": { + "id": "WeightedFontFamily", "description": "Represents a font family and weight used to style a TextRun.", "type": "object", "properties": { @@ -1816,20 +1812,39 @@ "format": "int32", "type": "integer" } - }, - "id": "WeightedFontFamily" + } }, "PageElement": { "description": "A visual element rendered on a page.", "type": "object", "properties": { + "size": { + "description": "The size of the page element.", + "$ref": "Size" + }, + "title": { + "description": "The title of the page element. Combined with description to display alt\ntext.", + "type": "string" + }, + "sheetsChart": { + "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images.", + "$ref": "SheetsChart" + }, + "video": { + "description": "A video page element.", + "$ref": "Video" + }, + "wordArt": { + "description": "A word art page element.", + "$ref": "WordArt" + }, "table": { - "description": "A table page element.", - "$ref": "Table" + "$ref": "Table", + "description": "A table page element." }, "transform": { - "description": "The transform of the page element.\n\nThe visual appearance of the page element is determined by its absolute\ntransform. To compute the absolute transform, preconcatenate a page\nelement's transform with the transforms of all of its parent groups. If the\npage element is not in a group, its absolute transform is the same as the\nvalue in this field.\n\nThe initial transform for the newly created Group is always the identity transform.", - "$ref": "AffineTransform" + "$ref": "AffineTransform", + "description": "The transform of the page element.\n\nThe visual appearance of the page element is determined by its absolute\ntransform. To compute the absolute transform, preconcatenate a page\nelement's transform with the transforms of all of its parent groups. If the\npage element is not in a group, its absolute transform is the same as the\nvalue in this field.\n\nThe initial transform for the newly created Group is always the identity transform." }, "objectId": { "description": "The object ID for this page element. Object IDs used by\ngoogle.apps.slides.v1.Page and\ngoogle.apps.slides.v1.PageElement share the same namespace.", @@ -1848,32 +1863,12 @@ "type": "string" }, "elementGroup": { - "description": "A collection of page elements joined as a single unit.", - "$ref": "Group" + "$ref": "Group", + "description": "A collection of page elements joined as a single unit." }, "image": { "$ref": "Image", "description": "An image page element." - }, - "size": { - "$ref": "Size", - "description": "The size of the page element." - }, - "title": { - "description": "The title of the page element. Combined with description to display alt\ntext.", - "type": "string" - }, - "sheetsChart": { - "$ref": "SheetsChart", - "description": "A linked chart embedded from Google Sheets. Unlinked charts are\nrepresented as images." - }, - "video": { - "$ref": "Video", - "description": "A video page element." - }, - "wordArt": { - "description": "A word art page element.", - "$ref": "WordArt" } }, "id": "PageElement" @@ -1882,6 +1877,10 @@ "description": "Creates an image.", "type": "object", "properties": { + "url": { + "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.", + "type": "string" + }, "objectId": { "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.", "type": "string" @@ -1889,26 +1888,15 @@ "elementProperties": { "$ref": "PageElementProperties", "description": "The element properties for the image.\n\nWhen the aspect ratio of the provided size does not match the image aspect\nratio, the image is scaled and centered with respect to the size in order\nto maintain aspect ratio. The provided transform is applied after this\noperation.\n\nThe PageElementProperties.size property is\noptional. If you don't specify the size, the default size of the image is\nused.\n\nThe PageElementProperties.transform property is\noptional. If you don't specify a transform, the image will be placed at the\ntop left corner of the page." - }, - "url": { - "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.", - "type": "string" } }, "id": "CreateImageRequest" }, "CreateParagraphBulletsRequest": { + "id": "CreateParagraphBulletsRequest", "description": "Creates bullets for all of the paragraphs that overlap with the given\ntext index range.\n\nThe nesting level of each paragraph will be determined by counting leading\ntabs in front of each paragraph. To avoid excess space between the bullet and\nthe corresponding paragraph, these leading tabs are removed by this request.\nThis may change the indices of parts of the text.\n\nIf the paragraph immediately before paragraphs being updated is in a list\nwith a matching preset, the paragraphs being updated are added to that\npreceding list.", "type": "object", "properties": { - "objectId": { - "description": "The object ID of the shape or table containing the text to add bullets to.", - "type": "string" - }, - "textRange": { - "description": "The range of text to apply the bullet presets to, based on TextElement indexes.", - "$ref": "Range" - }, "bulletPreset": { "description": "The kinds of bullet glyphs to be used. Defaults to the\n`BULLET_DISC_CIRCLE_SQUARE` preset.", "type": "string", @@ -1948,31 +1936,62 @@ ] }, "cellLocation": { - "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table.", - "$ref": "TableCellLocation" + "$ref": "TableCellLocation", + "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table." + }, + "objectId": { + "description": "The object ID of the shape or table containing the text to add bullets to.", + "type": "string" + }, + "textRange": { + "$ref": "Range", + "description": "The range of text to apply the bullet presets to, based on TextElement indexes." } - }, - "id": "CreateParagraphBulletsRequest" + } }, "TextStyle": { "description": "Represents the styling that can be applied to a TextRun.\n\nIf this text is contained in a shape with a parent placeholder, then these text styles may be\ninherited from the parent. Which text styles are inherited depend on the\nnesting level of lists:\n\n* A text run in a paragraph that is not in a list will inherit its text style\n from the the newline character in the paragraph at the 0 nesting level of\n the list inside the parent placeholder.\n* A text run in a paragraph that is in a list will inherit its text style\n from the newline character in the paragraph at its corresponding nesting\n level of the list inside the parent placeholder.\n\nInherited text styles are represented as unset fields in this message. If\ntext is contained in a shape without a parent placeholder, unsetting these\nfields will revert the style to a value matching the defaults in the Slides\neditor.", "type": "object", "properties": { + "smallCaps": { + "description": "Whether or not the text is in small capital letters.", + "type": "boolean" + }, + "backgroundColor": { + "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.", + "$ref": "OptionalColor" + }, + "underline": { + "description": "Whether or not the text is underlined.", + "type": "boolean" + }, + "link": { + "$ref": "Link", + "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request." + }, + "bold": { + "description": "Whether or not the text is rendered as bold.", + "type": "boolean" + }, + "foregroundColor": { + "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.", + "$ref": "OptionalColor" + }, "fontFamily": { "description": "The font family of the text.\n\nThe font family can be any font from the Font menu in Slides or from\n[Google Fonts] (https://fonts.google.com/). If the font name is\nunrecognized, the text is rendered in `Arial`.\n\nSome fonts can affect the weight of the text. If an update request\nspecifies values for both `font_family` and `bold`, the explicitly-set\n`bold` value is used.", "type": "string" }, - "strikethrough": { - "description": "Whether or not the text is struck through.", - "type": "boolean" - }, "italic": { "description": "Whether or not the text is italicized.", "type": "boolean" }, + "strikethrough": { + "description": "Whether or not the text is struck through.", + "type": "boolean" + }, "fontSize": { - "$ref": "Dimension", - "description": "The size of the text's font. When read, the `font_size` will specified in\npoints." + "description": "The size of the text's font. When read, the `font_size` will specified in\npoints.", + "$ref": "Dimension" }, "baselineOffset": { "description": "The text's vertical offset from its normal position.\n\nText with `SUPERSCRIPT` or `SUBSCRIPT` baseline offsets is automatically\nrendered in a smaller font size, computed based on the `font_size` field.\nThe `font_size` itself is not affected by changes in this field.", @@ -1993,120 +2012,64 @@ "weightedFontFamily": { "description": "The font family and rendered weight of the text.\n\nThis field is an extension of `font_family` meant to support explicit font\nweights without breaking backwards compatibility. As such, when reading the\nstyle of a range of text, the value of `weighted_font_family#font_family`\nwill always be equal to that of `font_family`. However, when writing, if\nboth fields are included in the field mask (either explicitly or through\nthe wildcard `\"*\"`), their values are reconciled as follows:\n\n* If `font_family` is set and `weighted_font_family` is not, the value of\n `font_family` is applied with weight `400` (\"normal\").\n* If both fields are set, the value of `font_family` must match that of\n `weighted_font_family#font_family`. If so, the font family and weight of\n `weighted_font_family` is applied. Otherwise, a 400 bad request error is\n returned.\n* If `weighted_font_family` is set and `font_family` is not, the font\n family and weight of `weighted_font_family` is applied.\n* If neither field is set, the font family and weight of the text inherit\n from the parent. Note that these properties cannot inherit separately\n from each other.\n\nIf an update request specifies values for both `weighted_font_family` and\n`bold`, the `weighted_font_family` is applied first, then `bold`.\n\nIf `weighted_font_family#weight` is not set, it defaults to `400`.\n\nIf `weighted_font_family` is set, then `weighted_font_family#font_family`\nmust also be set with a non-empty value. Otherwise, a 400 bad request error\nis returned.", "$ref": "WeightedFontFamily" - }, - "smallCaps": { - "description": "Whether or not the text is in small capital letters.", - "type": "boolean" - }, - "backgroundColor": { - "description": "The background color of the text. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.", - "$ref": "OptionalColor" - }, - "link": { - "description": "The hyperlink destination of the text. If unset, there is no link. Links\nare not inherited from parent text.\n\nChanging the link in an update request causes some other changes to the\ntext style of the range:\n\n* When setting a link, the text foreground color will be set to\n ThemeColorType.HYPERLINK and the text will\n be underlined. If these fields are modified in the same\n request, those values will be used instead of the link defaults.\n* Setting a link on a text range that overlaps with an existing link will\n also update the existing link to point to the new URL.\n* Links are not settable on newline characters. As a result, setting a link\n on a text range that crosses a paragraph boundary, such as `\"ABC\\n123\"`,\n will separate the newline character(s) into their own text runs. The\n link will be applied separately to the runs before and after the newline.\n* Removing a link will update the text style of the range to match the\n style of the preceding text (or the default text styles if the preceding\n text is another link) unless different styles are being set in the same\n request.", - "$ref": "Link" - }, - "underline": { - "description": "Whether or not the text is underlined.", - "type": "boolean" - }, - "foregroundColor": { - "description": "The color of the text itself. If set, the color is either opaque or\ntransparent, depending on if the `opaque_color` field in it is set.", - "$ref": "OptionalColor" - }, - "bold": { - "description": "Whether or not the text is rendered as bold.", - "type": "boolean" } }, "id": "TextStyle" }, "Size": { + "id": "Size", "description": "A width and height.", "type": "object", "properties": { - "width": { - "description": "The width of the object.", - "$ref": "Dimension" - }, "height": { "$ref": "Dimension", "description": "The height of the object." + }, + "width": { + "$ref": "Dimension", + "description": "The width of the object." } - }, - "id": "Size" + } }, "UpdateVideoPropertiesRequest": { + "id": "UpdateVideoPropertiesRequest", "description": "Update the properties of a Video.", "type": "object", "properties": { + "objectId": { + "description": "The object ID of the video the updates are applied to.", + "type": "string" + }, "videoProperties": { - "description": "The video properties to update.", - "$ref": "VideoProperties" + "$ref": "VideoProperties", + "description": "The video properties to update." }, "fields": { "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `videoProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the video outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", "format": "google-fieldmask", "type": "string" - }, - "objectId": { - "description": "The object ID of the video the updates are applied to.", - "type": "string" } - }, - "id": "UpdateVideoPropertiesRequest" + } }, "Request": { "description": "A single kind of update to apply to a presentation.", "type": "object", "properties": { - "replaceAllText": { - "description": "Replaces all instances of specified text.", - "$ref": "ReplaceAllTextRequest" - }, - "updateImageProperties": { - "$ref": "UpdateImagePropertiesRequest", - "description": "Updates the properties of an Image." - }, - "insertTableRows": { - "description": "Inserts rows into a table.", - "$ref": "InsertTableRowsRequest" - }, - "createSlide": { - "description": "Creates a new slide.", - "$ref": "CreateSlideRequest" - }, - "updateLineProperties": { - "$ref": "UpdateLinePropertiesRequest", - "description": "Updates the properties of a Line." - }, - "updateSlidesPosition": { - "description": "Updates the position of a set of slides in the presentation.", - "$ref": "UpdateSlidesPositionRequest" - }, - "deleteTableRow": { - "description": "Deletes a row from a table.", - "$ref": "DeleteTableRowRequest" - }, - "updateShapeProperties": { - "$ref": "UpdateShapePropertiesRequest", - "description": "Updates the properties of a Shape." + "groupObjects": { + "description": "Groups objects, such as page elements.", + "$ref": "GroupObjectsRequest" }, "ungroupObjects": { "$ref": "UngroupObjectsRequest", "description": "Ungroups objects, such as groups." }, - "groupObjects": { - "$ref": "GroupObjectsRequest", - "description": "Groups objects, such as page elements." - }, "insertText": { "$ref": "InsertTextRequest", "description": "Inserts text into a shape or table cell." }, "updateTableColumnProperties": { - "description": "Updates the properties of a Table\ncolumn.", - "$ref": "UpdateTableColumnPropertiesRequest" + "$ref": "UpdateTableColumnPropertiesRequest", + "description": "Updates the properties of a Table\ncolumn." }, "deleteText": { "$ref": "DeleteTextRequest", @@ -2116,62 +2079,66 @@ "$ref": "UpdatePagePropertiesRequest", "description": "Updates the properties of a Page." }, + "createShape": { + "description": "Creates a new shape.", + "$ref": "CreateShapeRequest" + }, "deleteParagraphBullets": { "description": "Deletes bullets from paragraphs.", "$ref": "DeleteParagraphBulletsRequest" }, - "createShape": { - "$ref": "CreateShapeRequest", - "description": "Creates a new shape." - }, "updateTableBorderProperties": { - "description": "Updates the properties of the table borders in a Table.", - "$ref": "UpdateTableBorderPropertiesRequest" + "$ref": "UpdateTableBorderPropertiesRequest", + "description": "Updates the properties of the table borders in a Table." + }, + "updatePageElementAltText": { + "$ref": "UpdatePageElementAltTextRequest", + "description": "Updates the alt text title and/or description of a\npage element." }, "insertTableColumns": { - "$ref": "InsertTableColumnsRequest", - "description": "Inserts columns into a table." + "description": "Inserts columns into a table.", + "$ref": "InsertTableColumnsRequest" }, "mergeTableCells": { "description": "Merges cells in a Table.", "$ref": "MergeTableCellsRequest" }, "refreshSheetsChart": { - "$ref": "RefreshSheetsChartRequest", - "description": "Refreshes a Google Sheets chart." + "description": "Refreshes a Google Sheets chart.", + "$ref": "RefreshSheetsChartRequest" }, "updateTableCellProperties": { - "description": "Updates the properties of a TableCell.", - "$ref": "UpdateTableCellPropertiesRequest" + "$ref": "UpdateTableCellPropertiesRequest", + "description": "Updates the properties of a TableCell." }, "createTable": { - "$ref": "CreateTableRequest", - "description": "Creates a new table." + "description": "Creates a new table.", + "$ref": "CreateTableRequest" }, "deleteObject": { - "description": "Deletes a page or page element from the presentation.", - "$ref": "DeleteObjectRequest" + "$ref": "DeleteObjectRequest", + "description": "Deletes a page or page element from the presentation." }, "updateParagraphStyle": { - "$ref": "UpdateParagraphStyleRequest", - "description": "Updates the styling of paragraphs within a Shape or Table." - }, - "deleteTableColumn": { - "description": "Deletes a column from a table.", - "$ref": "DeleteTableColumnRequest" + "description": "Updates the styling of paragraphs within a Shape or Table.", + "$ref": "UpdateParagraphStyleRequest" }, "duplicateObject": { "description": "Duplicates a slide or page element.", "$ref": "DuplicateObjectRequest" }, - "updateVideoProperties": { - "$ref": "UpdateVideoPropertiesRequest", - "description": "Updates the properties of a Video." + "deleteTableColumn": { + "description": "Deletes a column from a table.", + "$ref": "DeleteTableColumnRequest" }, "createLine": { "$ref": "CreateLineRequest", "description": "Creates a line." }, + "updateVideoProperties": { + "$ref": "UpdateVideoPropertiesRequest", + "description": "Updates the properties of a Video." + }, "createImage": { "$ref": "CreateImageRequest", "description": "Creates an image." @@ -2181,12 +2148,12 @@ "$ref": "CreateParagraphBulletsRequest" }, "createVideo": { - "$ref": "CreateVideoRequest", - "description": "Creates a video." + "description": "Creates a video.", + "$ref": "CreateVideoRequest" }, "createSheetsChart": { - "$ref": "CreateSheetsChartRequest", - "description": "Creates an embedded Google Sheets chart." + "description": "Creates an embedded Google Sheets chart.", + "$ref": "CreateSheetsChartRequest" }, "replaceAllShapesWithSheetsChart": { "$ref": "ReplaceAllShapesWithSheetsChartRequest", @@ -2209,16 +2176,54 @@ "$ref": "UpdateTableRowPropertiesRequest" }, "replaceAllShapesWithImage": { - "$ref": "ReplaceAllShapesWithImageRequest", - "description": "Replaces all shapes matching some criteria with an image." + "description": "Replaces all shapes matching some criteria with an image.", + "$ref": "ReplaceAllShapesWithImageRequest" + }, + "replaceAllText": { + "description": "Replaces all instances of specified text.", + "$ref": "ReplaceAllTextRequest" + }, + "updateImageProperties": { + "description": "Updates the properties of an Image.", + "$ref": "UpdateImagePropertiesRequest" + }, + "createSlide": { + "$ref": "CreateSlideRequest", + "description": "Creates a new slide." + }, + "insertTableRows": { + "description": "Inserts rows into a table.", + "$ref": "InsertTableRowsRequest" + }, + "updateLineProperties": { + "description": "Updates the properties of a Line.", + "$ref": "UpdateLinePropertiesRequest" + }, + "updateSlidesPosition": { + "$ref": "UpdateSlidesPositionRequest", + "description": "Updates the position of a set of slides in the presentation." + }, + "deleteTableRow": { + "$ref": "DeleteTableRowRequest", + "description": "Deletes a row from a table." + }, + "updateShapeProperties": { + "description": "Updates the properties of a Shape.", + "$ref": "UpdateShapePropertiesRequest" } }, "id": "Request" }, "UpdateImagePropertiesRequest": { + "id": "UpdateImagePropertiesRequest", "description": "Update the properties of an Image.", "type": "object", "properties": { + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", + "format": "google-fieldmask", + "type": "string" + }, "imageProperties": { "description": "The image properties to update.", "$ref": "ImageProperties" @@ -2226,31 +2231,19 @@ "objectId": { "description": "The object ID of the image the updates are applied to.", "type": "string" - }, - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `imageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the image outline color, set `fields` to\n`\"outline.outlineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", - "format": "google-fieldmask", - "type": "string" } - }, - "id": "UpdateImagePropertiesRequest" + } }, "ParagraphStyle": { + "id": "ParagraphStyle", "description": "Styles that apply to a whole paragraph.\n\nIf this text is contained in a shape with a parent placeholder, then these paragraph styles may be\ninherited from the parent. Which paragraph styles are inherited depend on the\nnesting level of lists:\n\n* A paragraph not in a list will inherit its paragraph style from the\n paragraph at the 0 nesting level of the list inside the parent placeholder.\n* A paragraph in a list will inherit its paragraph style from the paragraph\n at its corresponding nesting level of the list inside the parent\n placeholder.\n\nInherited paragraph styles are represented as unset fields in this message.", "type": "object", "properties": { - "indentFirstLine": { - "$ref": "Dimension", - "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent." - }, - "lineSpacing": { - "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.", - "format": "float", - "type": "number" + "spaceAbove": { + "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.", + "$ref": "Dimension" }, "alignment": { - "description": "The text alignment for this paragraph.", - "type": "string", "enumDescriptions": [ "The paragraph alignment is inherited from the parent.", "The paragraph is aligned to the start of the line. Left-aligned for\nLTR text, right-aligned otherwise.", @@ -2264,11 +2257,22 @@ "CENTER", "END", "JUSTIFIED" - ] + ], + "description": "The text alignment for this paragraph.", + "type": "string" + }, + "lineSpacing": { + "description": "The amount of space between lines, as a percentage of normal, where normal\nis represented as 100.0. If unset, the value is inherited from the parent.", + "format": "float", + "type": "number" + }, + "indentFirstLine": { + "$ref": "Dimension", + "description": "The amount of indentation for the start of the first line of the paragraph.\nIf unset, the value is inherited from the parent." }, "spaceBelow": { - "$ref": "Dimension", - "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent." + "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent.", + "$ref": "Dimension" }, "direction": { "description": "The text direction of this paragraph. If unset, the value defaults to\nLEFT_TO_RIGHT since\ntext direction is not inherited.", @@ -2284,10 +2288,6 @@ "RIGHT_TO_LEFT" ] }, - "indentEnd": { - "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent.", - "$ref": "Dimension" - }, "spacingMode": { "description": "The spacing mode for the paragraph.", "type": "string", @@ -2302,34 +2302,20 @@ "COLLAPSE_LISTS" ] }, + "indentEnd": { + "description": "The amount indentation for the paragraph on the side that corresponds to\nthe end of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent.", + "$ref": "Dimension" + }, "indentStart": { "$ref": "Dimension", "description": "The amount indentation for the paragraph on the side that corresponds to\nthe start of the text, based on the current text direction. If unset, the\nvalue is inherited from the parent." - }, - "spaceAbove": { - "$ref": "Dimension", - "description": "The amount of extra space above the paragraph. If unset, the value is\ninherited from the parent." } - }, - "id": "ParagraphStyle" + } }, "UpdateTableRowPropertiesRequest": { "description": "Updates the properties of a Table row.", "type": "object", "properties": { - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableRowProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the minimum row height, set `fields` to\n`\"min_row_height\"`.\n\nIf '\"min_row_height\"' is included in the field mask but the property is\nleft unset, the minimum row height will default to 0.", - "format": "google-fieldmask", - "type": "string" - }, - "tableRowProperties": { - "description": "The table row properties to update.", - "$ref": "TableRowProperties" - }, - "objectId": { - "description": "The object ID of the table.", - "type": "string" - }, "rowIndices": { "description": "The list of zero-based indices specifying which rows to update. If no\nindices are provided, all rows in the table will be updated.", "type": "array", @@ -2337,6 +2323,19 @@ "format": "int32", "type": "integer" } + }, + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableRowProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the minimum row height, set `fields` to\n`\"min_row_height\"`.\n\nIf '\"min_row_height\"' is included in the field mask but the property is\nleft unset, the minimum row height will default to 0.", + "format": "google-fieldmask", + "type": "string" + }, + "tableRowProperties": { + "$ref": "TableRowProperties", + "description": "The table row properties to update." + }, + "objectId": { + "description": "The object ID of the table.", + "type": "string" } }, "id": "UpdateTableRowPropertiesRequest" @@ -2358,10 +2357,12 @@ "type": "object", "properties": { "tableCellBackgroundFill": { - "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor.", - "$ref": "TableCellBackgroundFill" + "$ref": "TableCellBackgroundFill", + "description": "The background fill of the table cell. The default fill matches the fill\nfor newly created table cells in the Slides editor." }, "contentAlignment": { + "description": "The alignment of the content in the table cell. The default alignment\nmatches the alignment for newly created table cells in the Slides editor.", + "type": "string", "enumDescriptions": [ "An unspecified content alignment. The content alignment is inherited from\nthe parent if it exists.", "An unsupported content alignment.", @@ -2375,14 +2376,13 @@ "TOP", "MIDDLE", "BOTTOM" - ], - "description": "The alignment of the content in the table cell. The default alignment\nmatches the alignment for newly created table cells in the Slides editor.", - "type": "string" + ] } }, "id": "TableCellProperties" }, "Outline": { + "id": "Outline", "description": "The outline of a PageElement.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.", "type": "object", "properties": { @@ -2417,8 +2417,6 @@ ] }, "propertyState": { - "description": "The outline property state.\n\nUpdating the outline on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.", - "type": "string", "enumDescriptions": [ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.", "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.", @@ -2428,12 +2426,14 @@ "RENDERED", "NOT_RENDERED", "INHERIT" - ] + ], + "description": "The outline property state.\n\nUpdating the outline on a page element will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no outline on a page element, set this field to `NOT_RENDERED`. In\nthis case, any other outline fields set in the same request will be\nignored.", + "type": "string" } - }, - "id": "Outline" + } }, "RefreshSheetsChartRequest": { + "id": "RefreshSheetsChartRequest", "description": "Refreshes an embedded Google Sheets chart by replacing it with the latest\nversion of the chart from Google Sheets.\n\nNOTE: Refreshing charts requires at least one of the spreadsheets.readonly,\nspreadsheets, drive.readonly, or drive OAuth scopes.", "type": "object", "properties": { @@ -2441,8 +2441,7 @@ "description": "The object ID of the chart to refresh.", "type": "string" } - }, - "id": "RefreshSheetsChartRequest" + } }, "NotesProperties": { "description": "The properties of Page that are only\nrelevant for pages with page_type NOTES.", @@ -2456,6 +2455,7 @@ "id": "NotesProperties" }, "TableColumnProperties": { + "id": "TableColumnProperties", "description": "Properties of each column in a table.", "type": "object", "properties": { @@ -2463,24 +2463,27 @@ "$ref": "Dimension", "description": "Width of a column." } - }, - "id": "TableColumnProperties" + } }, "ShapeProperties": { "description": "The properties of a Shape.\n\nIf the shape is a placeholder shape as determined by the\nplaceholder field, then these\nproperties may be inherited from a parent placeholder shape.\nDetermining the rendered value of the property depends on the corresponding\nproperty_state field value.", "type": "object", "properties": { + "link": { + "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders.", + "$ref": "Link" + }, "outline": { "description": "The outline of the shape. If unset, the outline is inherited from a\nparent placeholder if it exists. If the shape has no parent, then the\ndefault outline depends on the shape type, matching the defaults for\nnew shapes created in the Slides editor.", "$ref": "Outline" }, "shapeBackgroundFill": { - "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor.", - "$ref": "ShapeBackgroundFill" + "$ref": "ShapeBackgroundFill", + "description": "The background fill of the shape. If unset, the background fill is\ninherited from a parent placeholder if it exists. If the shape has no\nparent, then the default background fill depends on the shape type,\nmatching the defaults for new shapes created in the Slides editor." }, "shadow": { - "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only.", - "$ref": "Shadow" + "$ref": "Shadow", + "description": "The shadow properties of the shape. If unset, the shadow is inherited from\na parent placeholder if it exists. If the shape has no parent, then the\ndefault shadow matches the defaults for new shapes created in the Slides\neditor. This property is read-only." }, "contentAlignment": { "enumDescriptions": [ @@ -2499,10 +2502,6 @@ ], "description": "The alignment of the content in the shape. If unspecified,\nthe alignment is inherited from a parent placeholder if it exists. If the\nshape has no parent, the default alignment matches the alignment for new\nshapes created in the Slides editor.", "type": "string" - }, - "link": { - "description": "The hyperlink destination of the shape. If unset, there is no link. Links\nare not inherited from parent placeholders.", - "$ref": "Link" } }, "id": "ShapeProperties" @@ -2511,6 +2510,10 @@ "description": "Properties and contents of each row in a table.", "type": "object", "properties": { + "tableRowProperties": { + "$ref": "TableRowProperties", + "description": "Properties of the row." + }, "rowHeight": { "$ref": "Dimension", "description": "Height of a row." @@ -2521,18 +2524,20 @@ "items": { "$ref": "TableCell" } - }, - "tableRowProperties": { - "$ref": "TableRowProperties", - "description": "Properties of the row." } }, "id": "TableRow" }, "UpdateTableCellPropertiesRequest": { + "id": "UpdateTableCellPropertiesRequest", "description": "Update the properties of a TableCell.", "type": "object", "properties": { + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", + "format": "google-fieldmask", + "type": "string" + }, "objectId": { "description": "The object ID of the table.", "type": "string" @@ -2542,24 +2547,18 @@ "$ref": "TableRange" }, "tableCellProperties": { - "$ref": "TableCellProperties", - "description": "The table cell properties to update." - }, - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableCellProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table cell background solid fill color, set\n`fields` to `\"tableCellBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", - "format": "google-fieldmask", - "type": "string" + "description": "The table cell properties to update.", + "$ref": "TableCellProperties" } - }, - "id": "UpdateTableCellPropertiesRequest" + } }, "CreateSlideRequest": { "description": "Creates a new slide.", "type": "object", "properties": { "slideLayoutReference": { - "$ref": "LayoutReference", - "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`." + "description": "Layout reference of the slide to be inserted, based on the *current\nmaster*, which is one of the following:\n\n- The master of the previous slide index.\n- The master of the first slide, if the insertion_index is zero.\n- The first master in the presentation, if there are no slides.\n\nIf the LayoutReference is not found in the current master, a 400 bad\nrequest error is returned.\n\nIf you don't specify a layout reference, then the new slide will use the\npredefined layout `BLANK`.", + "$ref": "LayoutReference" }, "objectId": { "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.", @@ -2592,22 +2591,22 @@ "id": "TableRowProperties" }, "BatchUpdatePresentationRequest": { + "id": "BatchUpdatePresentationRequest", "description": "Request message for PresentationsService.BatchUpdatePresentation.", "type": "object", "properties": { + "writeControl": { + "description": "Provides control over how write requests are executed.", + "$ref": "WriteControl" + }, "requests": { "description": "A list of updates to apply to the presentation.", "type": "array", "items": { "$ref": "Request" } - }, - "writeControl": { - "$ref": "WriteControl", - "description": "Provides control over how write requests are executed." } - }, - "id": "BatchUpdatePresentationRequest" + } }, "GroupObjectsResponse": { "description": "The result of grouping objects.", @@ -2624,19 +2623,19 @@ "description": "The general text content. The text must reside in a compatible shape (e.g.\ntext box or rectangle) or a table cell in a page.", "type": "object", "properties": { + "lists": { + "additionalProperties": { + "$ref": "List" + }, + "description": "The bulleted lists contained in this text, keyed by list ID.", + "type": "object" + }, "textElements": { "description": "The text contents broken down into its component parts, including styling\ninformation. This property is read-only.", "type": "array", "items": { "$ref": "TextElement" } - }, - "lists": { - "description": "The bulleted lists contained in this text, keyed by list ID.", - "type": "object", - "additionalProperties": { - "$ref": "List" - } } }, "id": "TextContent" @@ -2645,13 +2644,13 @@ "description": "The properties of each border cell.", "type": "object", "properties": { + "tableBorderProperties": { + "$ref": "TableBorderProperties", + "description": "The border properties." + }, "location": { "description": "The location of the border within the border table.", "$ref": "TableCellLocation" - }, - "tableBorderProperties": { - "description": "The border properties.", - "$ref": "TableBorderProperties" } }, "id": "TableBorderCell" @@ -2661,8 +2660,8 @@ "type": "object", "properties": { "weight": { - "$ref": "Dimension", - "description": "The thickness of the border." + "description": "The thickness of the border.", + "$ref": "Dimension" }, "tableBorderFill": { "$ref": "TableBorderFill", @@ -2724,8 +2723,8 @@ "type": "string" }, "textRange": { - "description": "The range of text to delete bullets from, based on TextElement indexes.", - "$ref": "Range" + "$ref": "Range", + "description": "The range of text to delete bullets from, based on TextElement indexes." }, "cellLocation": { "description": "The optional table cell location if the text to be modified is in a table\ncell. If present, the object_id must refer to a table.", @@ -2739,20 +2738,26 @@ "type": "object", "properties": { "style": { - "$ref": "ParagraphStyle", - "description": "The paragraph's style" + "description": "The paragraph's style", + "$ref": "ParagraphStyle" }, "bullet": { - "$ref": "Bullet", - "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list." + "description": "The bullet for this paragraph. If not present, the paragraph does not\nbelong to a list.", + "$ref": "Bullet" } }, "id": "ParagraphMarker" }, "Thumbnail": { + "id": "Thumbnail", "description": "The thumbnail of a page.", "type": "object", "properties": { + "height": { + "description": "The positive height in pixels of the thumbnail image.", + "format": "int32", + "type": "integer" + }, "contentUrl": { "description": "The content URL of the thumbnail image.\n\nThe URL to the image has a default lifetime of 30 minutes.\nThis URL is tagged with the account of the requester. Anyone with the URL\neffectively accesses the image as the original requester. Access to the\nimage may be lost if the presentation's sharing settings change.\nThe mime type of the thumbnail image is the same as specified in the\n`GetPageThumbnailRequest`.", "type": "string" @@ -2761,16 +2766,11 @@ "description": "The positive width in pixels of the thumbnail image.", "format": "int32", "type": "integer" - }, - "height": { - "description": "The positive height in pixels of the thumbnail image.", - "format": "int32", - "type": "integer" } - }, - "id": "Thumbnail" + } }, "InsertTableColumnsRequest": { + "id": "InsertTableColumnsRequest", "description": "Inserts columns into a table.\n\nOther columns in the table will be resized to fit the new column.", "type": "object", "properties": { @@ -2791,8 +2791,7 @@ "description": "The table to insert columns into.", "type": "string" } - }, - "id": "InsertTableColumnsRequest" + } }, "LayoutPlaceholderIdMapping": { "description": "The user-specified ID mapping for a placeholder that will be created on a\nslide from a specified layout.", @@ -2817,18 +2816,6 @@ "description": "Updates the properties of the table borders in a Table.", "type": "object", "properties": { - "objectId": { - "description": "The object ID of the table.", - "type": "string" - }, - "tableRange": { - "$ref": "TableRange", - "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table." - }, - "tableBorderProperties": { - "description": "The table border properties to update.", - "$ref": "TableBorderProperties" - }, "borderPosition": { "enumDescriptions": [ "All borders in the range.", @@ -2859,14 +2846,32 @@ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableBorderProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the table border solid fill color, set\n`fields` to `\"tableBorderFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", "format": "google-fieldmask", "type": "string" + }, + "objectId": { + "description": "The object ID of the table.", + "type": "string" + }, + "tableRange": { + "description": "The table range representing the subset of the table to which the updates\nare applied. If a table range is not specified, the updates will apply to\nthe entire table.", + "$ref": "TableRange" + }, + "tableBorderProperties": { + "description": "The table border properties to update.", + "$ref": "TableBorderProperties" } }, "id": "UpdateTableBorderPropertiesRequest" }, "UpdateShapePropertiesRequest": { + "id": "UpdateShapePropertiesRequest", "description": "Update the properties of a Shape.", "type": "object", "properties": { + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", + "format": "google-fieldmask", + "type": "string" + }, "objectId": { "description": "The object ID of the shape the updates are applied to.", "type": "string" @@ -2874,16 +2879,11 @@ "shapeProperties": { "$ref": "ShapeProperties", "description": "The shape properties to update." - }, - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `shapeProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the shape background solid fill color, set `fields`\nto `\"shapeBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", - "format": "google-fieldmask", - "type": "string" } - }, - "id": "UpdateShapePropertiesRequest" + } }, "WordArt": { + "id": "WordArt", "description": "A PageElement kind representing\nword art.", "type": "object", "properties": { @@ -2891,13 +2891,17 @@ "description": "The text rendered as word art.", "type": "string" } - }, - "id": "WordArt" + } }, "UpdateTableColumnPropertiesRequest": { "description": "Updates the properties of a Table column.", "type": "object", "properties": { + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableColumnProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the column width, set `fields` to `\"column_width\"`.\n\nIf '\"column_width\"' is included in the field mask but the property is left\nunset, the column width will default to 406,400 EMU (32 points).", + "format": "google-fieldmask", + "type": "string" + }, "objectId": { "description": "The object ID of the table.", "type": "string" @@ -2913,16 +2917,12 @@ "tableColumnProperties": { "description": "The table column properties to update.\n\nIf the value of `table_column_properties#column_width` in the request is\nless than 406,400 EMU (32 points), a 400 bad request error is returned.", "$ref": "TableColumnProperties" - }, - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `tableColumnProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the column width, set `fields` to `\"column_width\"`.\n\nIf '\"column_width\"' is included in the field mask but the property is left\nunset, the column width will default to 406,400 EMU (32 points).", - "format": "google-fieldmask", - "type": "string" } }, "id": "UpdateTableColumnPropertiesRequest" }, "Recolor": { + "id": "Recolor", "description": "A recolor effect applied on an image.", "type": "object", "properties": { @@ -2934,6 +2934,8 @@ } }, "name": { + "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.", + "type": "string", "enumDescriptions": [ "No recolor effect. The default value.", "A recolor effect that lightens the image using the page's first available\ncolor from its color scheme.", @@ -2987,21 +2989,14 @@ "NEGATIVE", "SEPIA", "CUSTOM" - ], - "description": "The name of the recolor effect.\n\nThe name is determined from the `recolor_stops` by matching the gradient\nagainst the colors in the page's current color scheme. This property is\nread-only.", - "type": "string" + ] } - }, - "id": "Recolor" + } }, "Link": { "description": "A hypertext link.", "type": "object", "properties": { - "pageObjectId": { - "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.", - "type": "string" - }, "url": { "description": "If set, indicates this is a link to the external web page at this URL.", "type": "string" @@ -3028,6 +3023,10 @@ "description": "If set, indicates this is a link to the slide at this zero-based index\nin the presentation. There may not be a slide at this index.", "format": "int32", "type": "integer" + }, + "pageObjectId": { + "description": "If set, indicates this is a link to the specific page in this\npresentation with this ID. A page with this ID may not exist.", + "type": "string" } }, "id": "Link" @@ -3055,6 +3054,7 @@ "id": "RgbColor" }, "CreateShapeResponse": { + "id": "CreateShapeResponse", "description": "The result of creating a shape.", "type": "object", "properties": { @@ -3062,22 +3062,16 @@ "description": "The object ID of the created shape.", "type": "string" } - }, - "id": "CreateShapeResponse" + } }, "CreateLineRequest": { + "id": "CreateLineRequest", "description": "Creates a line.", "type": "object", "properties": { - "objectId": { - "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.", - "type": "string" - }, - "elementProperties": { - "$ref": "PageElementProperties", - "description": "The element properties for the line." - }, "lineCategory": { + "description": "The category of line to be created.", + "type": "string", "enumDescriptions": [ "Straight connectors, including straight connector 1. The is the default\ncategory when one is not specified.", "Bent connectors, including bent connector 2 to 5.", @@ -3087,14 +3081,20 @@ "STRAIGHT", "BENT", "CURVED" - ], - "description": "The category of line to be created.", + ] + }, + "objectId": { + "description": "A user-supplied object ID.\n\nIf you specify an ID, it must be unique among all pages and page elements\nin the presentation. The ID must start with an alphanumeric character or an\nunderscore (matches regex `[a-zA-Z0-9_]`); remaining characters\nmay include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`).\nThe length of the ID must not be less than 5 or greater than 50.\n\nIf you don't specify an ID, a unique one is generated.", "type": "string" + }, + "elementProperties": { + "description": "The element properties for the line.", + "$ref": "PageElementProperties" } - }, - "id": "CreateLineRequest" + } }, "CreateSlideResponse": { + "id": "CreateSlideResponse", "description": "The result of creating a slide.", "type": "object", "properties": { @@ -3102,8 +3102,7 @@ "description": "The object ID of the created slide.", "type": "string" } - }, - "id": "CreateSlideResponse" + } }, "CreateShapeRequest": { "description": "Creates a new shape.", @@ -3418,11 +3417,9 @@ "description": "A PageElement kind representing a\nvideo.", "type": "object", "properties": { - "videoProperties": { - "$ref": "VideoProperties", - "description": "The properties of the video." - }, "source": { + "description": "The video source.", + "type": "string", "enumDescriptions": [ "The video source is unspecified.", "The video source is YouTube." @@ -3430,9 +3427,7 @@ "enum": [ "SOURCE_UNSPECIFIED", "YOUTUBE" - ], - "description": "The video source.", - "type": "string" + ] }, "url": { "description": "An URL to a video. The URL is valid as long as the source video\nexists and sharing settings do not change.", @@ -3441,6 +3436,10 @@ "id": { "description": "The video source's unique identifier for this video.", "type": "string" + }, + "videoProperties": { + "$ref": "VideoProperties", + "description": "The properties of the video." } }, "id": "Video" @@ -3449,13 +3448,13 @@ "description": "The properties of the Page.\n\nThe page will inherit properties from the parent page. Depending on the page\ntype the hierarchy is defined in either\nSlideProperties or\nLayoutProperties.", "type": "object", "properties": { + "colorScheme": { + "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only.", + "$ref": "ColorScheme" + }, "pageBackgroundFill": { "description": "The background fill of the page. If unset, the background fill is inherited\nfrom a parent page if it exists. If the page has no parent, then the\nbackground fill defaults to the corresponding fill in the Slides editor.", "$ref": "PageBackgroundFill" - }, - "colorScheme": { - "$ref": "ColorScheme", - "description": "The color scheme of the page. If unset, the color scheme is inherited from\na parent page. If the page has no parent, the color scheme uses a default\nSlides color scheme. This field is read-only." } }, "id": "PageProperties" @@ -3465,23 +3464,24 @@ "type": "object", "properties": { "bulletStyle": { - "description": "The style of a bullet at this level of nesting.", - "$ref": "TextStyle" + "$ref": "TextStyle", + "description": "The style of a bullet at this level of nesting." } }, "id": "NestingLevel" }, "TableCell": { + "id": "TableCell", "description": "Properties and contents of each table cell.", "type": "object", "properties": { "text": { - "description": "The text content of the cell.", - "$ref": "TextContent" + "$ref": "TextContent", + "description": "The text content of the cell." }, "tableCellProperties": { - "description": "The properties of the table cell.", - "$ref": "TableCellProperties" + "$ref": "TableCellProperties", + "description": "The properties of the table cell." }, "location": { "$ref": "TableCellLocation", @@ -3497,17 +3497,13 @@ "format": "int32", "type": "integer" } - }, - "id": "TableCell" + } }, "UpdateLinePropertiesRequest": { + "id": "UpdateLinePropertiesRequest", "description": "Updates the properties of a Line.", "type": "object", "properties": { - "objectId": { - "description": "The object ID of the line the update is applied to.", - "type": "string" - }, "lineProperties": { "description": "The line properties to update.", "$ref": "LineProperties" @@ -3516,38 +3512,63 @@ "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `lineProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the line solid fill color, set `fields` to\n`\"lineFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", "format": "google-fieldmask", "type": "string" + }, + "objectId": { + "description": "The object ID of the line the update is applied to.", + "type": "string" } - }, - "id": "UpdateLinePropertiesRequest" + } + }, + "UpdatePageElementAltTextRequest": { + "id": "UpdatePageElementAltTextRequest", + "description": "Updates the alt text title and/or description of a\npage element.", + "type": "object", + "properties": { + "description": { + "description": "The updated alt text description of the page element. If unset the existing\nvalue will be maintained. The description is exposed to screen readers\nand other accessibility interfaces. Only use human readable values related\nto the content of the page element.", + "type": "string" + }, + "objectId": { + "description": "The object ID of the page element the updates are applied to.", + "type": "string" + }, + "title": { + "description": "The updated alt text title of the page element. If unset the\nexisting value will be maintained. The title is exposed to screen readers\nand other accessibility interfaces. Only use human readable values related\nto the content of the page element.", + "type": "string" + } + } }, "UpdateSlidesPositionRequest": { + "id": "UpdateSlidesPositionRequest", "description": "Updates the position of slides in the presentation.", "type": "object", "properties": { + "insertionIndex": { + "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.", + "format": "int32", + "type": "integer" + }, "slideObjectIds": { "description": "The IDs of the slides in the presentation that should be moved.\nThe slides in this list must be in existing presentation order, without\nduplicates.", "type": "array", "items": { "type": "string" } - }, - "insertionIndex": { - "description": "The index where the slides should be inserted, based on the slide\narrangement before the move takes place. Must be between zero and the\nnumber of slides in the presentation, inclusive.", - "format": "int32", - "type": "integer" } - }, - "id": "UpdateSlidesPositionRequest" + } }, "TableCellBackgroundFill": { + "id": "TableCellBackgroundFill", "description": "The table cell background fill.", "type": "object", "properties": { "solidFill": { - "description": "Solid color fill.", - "$ref": "SolidFill" + "$ref": "SolidFill", + "description": "Solid color fill." }, "propertyState": { + "description": "The background fill property state.\n\nUpdating the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.", + "type": "string", "enumDescriptions": [ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.", "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.", @@ -3557,32 +3578,29 @@ "RENDERED", "NOT_RENDERED", "INHERIT" - ], - "description": "The background fill property state.\n\nUpdating the fill on a table cell will implicitly update this field\nto `RENDERED`, unless another value is specified in the same request. To\nhave no fill on a table cell, set this field to `NOT_RENDERED`. In this\ncase, any other fill fields set in the same request will be ignored.", - "type": "string" + ] } - }, - "id": "TableCellBackgroundFill" + } }, "UpdatePagePropertiesRequest": { + "id": "UpdatePagePropertiesRequest", "description": "Updates the properties of a Page.", "type": "object", "properties": { - "fields": { - "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", - "format": "google-fieldmask", - "type": "string" - }, "objectId": { "description": "The object ID of the page the update is applied to.", "type": "string" }, "pageProperties": { - "$ref": "PageProperties", - "description": "The page properties to update." + "description": "The page properties to update.", + "$ref": "PageProperties" + }, + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `pageProperties` is\nimplied and should not be specified. A single `\"*\"` can be used as\nshort-hand for listing every field.\n\nFor example to update the page background solid fill color, set `fields`\nto `\"pageBackgroundFill.solidFill.color\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", + "format": "google-fieldmask", + "type": "string" } - }, - "id": "UpdatePagePropertiesRequest" + } }, "Group": { "description": "A PageElement kind representing a\njoined collection of PageElements.", @@ -3602,6 +3620,10 @@ "description": "The placeholder information that uniquely identifies a placeholder shape.", "type": "object", "properties": { + "parentObjectId": { + "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.", + "type": "string" + }, "index": { "description": "The index of the placeholder. If the same placeholder types are present in\nthe same page, they would have different index values.", "format": "int32", @@ -3648,15 +3670,12 @@ "TITLE", "SLIDE_IMAGE" ] - }, - "parentObjectId": { - "description": "The object ID of this shape's parent placeholder.\nIf unset, the parent placeholder shape does not exist, so the shape does\nnot inherit properties from any other shape.", - "type": "string" } }, "id": "Placeholder" }, "DuplicateObjectRequest": { + "id": "DuplicateObjectRequest", "description": "Duplicates a slide or page element.\n\nWhen duplicating a slide, the duplicate slide will be created immediately\nfollowing the specified slide. When duplicating a page element, the duplicate\nwill be placed on the same page at the same position as the original.", "type": "object", "properties": { @@ -3671,8 +3690,7 @@ "description": "The object being duplicated may contain other objects, for example when\nduplicating a slide or a group page element. This map defines how the IDs\nof duplicated objects are generated: the keys are the IDs of the original\nobjects and its values are the IDs that will be assigned to the\ncorresponding duplicate object. The ID of the source object's duplicate\nmay be specified in this map as well, using the same value of the\n`object_id` field as a key and the newly desired ID as the value.\n\nAll keys must correspond to existing IDs in the presentation. All values\nmust be unique in the presentation and must start with an alphanumeric\ncharacter or an underscore (matches regex `[a-zA-Z0-9_]`); remaining\ncharacters may include those as well as a hyphen or colon (matches regex\n`[a-zA-Z0-9_-:]`). The length of the new ID must not be less than 5 or\ngreater than 50.\n\nIf any IDs of source objects are omitted from the map, a new random ID will\nbe assigned. If the map is empty or unset, all duplicate objects will\nreceive a new random ID.", "type": "object" } - }, - "id": "DuplicateObjectRequest" + } }, "ReplaceAllTextRequest": { "description": "Replaces all instances of text matching a criteria with replace text.", @@ -3690,13 +3708,14 @@ } }, "containsText": { - "$ref": "SubstringMatchCriteria", - "description": "Finds text in a shape matching this substring." + "description": "Finds text in a shape matching this substring.", + "$ref": "SubstringMatchCriteria" } }, "id": "ReplaceAllTextRequest" }, "UnmergeTableCellsRequest": { + "id": "UnmergeTableCellsRequest", "description": "Unmerges cells in a Table.", "type": "object", "properties": { @@ -3705,28 +3724,15 @@ "type": "string" }, "tableRange": { - "description": "The table range specifying which cells of the table to unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells.", - "$ref": "TableRange" + "$ref": "TableRange", + "description": "The table range specifying which cells of the table to unmerge.\n\nAll merged cells in this range will be unmerged, and cells that are already\nunmerged will not be affected. If the range has no merged cells, the\nrequest will do nothing. If there is text in any of the merged cells, the\ntext will remain in the upper-left (\"head\") cell of the resulting block of\nunmerged cells." } - }, - "id": "UnmergeTableCellsRequest" + } }, "Page": { "description": "A page in a presentation.", "type": "object", "properties": { - "objectId": { - "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace.", - "type": "string" - }, - "revisionId": { - "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.", - "type": "string" - }, - "layoutProperties": { - "$ref": "LayoutProperties", - "description": "Layout specific properties. Only set if page_type = LAYOUT." - }, "pageElements": { "description": "The page elements rendered on the page.", "type": "array", @@ -3753,8 +3759,8 @@ "type": "string" }, "notesProperties": { - "description": "Notes specific properties. Only set if page_type = NOTES.", - "$ref": "NotesProperties" + "$ref": "NotesProperties", + "description": "Notes specific properties. Only set if page_type = NOTES." }, "slideProperties": { "$ref": "SlideProperties", @@ -3767,21 +3773,32 @@ "masterProperties": { "$ref": "MasterProperties", "description": "Master specific properties. Only set if page_type = MASTER." + }, + "objectId": { + "description": "The object ID for this page. Object IDs used by\nPage and\nPageElement share the same namespace.", + "type": "string" + }, + "revisionId": { + "description": "The revision ID of the presentation containing this page. Can be used in\nupdate requests to assert that the presentation revision hasn't changed\nsince the last read operation. Only populated if the user has edit access\nto the presentation.\n\nThe format of the revision ID may change over time, so it should be treated\nopaquely. A returned revision ID is only guaranteed to be valid for 24\nhours after it has been returned and cannot be shared across users. If the\nrevision ID is unchanged between calls, then the presentation has not\nchanged. Conversely, a changed ID (for the same presentation and user)\nusually means the presentation has been updated; however, a changed ID can\nalso be due to internal factors such as ID format changes.", + "type": "string" + }, + "layoutProperties": { + "$ref": "LayoutProperties", + "description": "Layout specific properties. Only set if page_type = LAYOUT." } }, "id": "Page" }, "ShapeBackgroundFill": { + "id": "ShapeBackgroundFill", "description": "The shape background fill.", "type": "object", "properties": { "solidFill": { - "description": "Solid color fill.", - "$ref": "SolidFill" + "$ref": "SolidFill", + "description": "Solid color fill." }, "propertyState": { - "description": "The background fill property state.\n\nUpdating the fill on a shape will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a shape, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.", - "type": "string", "enumDescriptions": [ "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.", "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.", @@ -3791,15 +3808,21 @@ "RENDERED", "NOT_RENDERED", "INHERIT" - ] + ], + "description": "The background fill property state.\n\nUpdating the fill on a shape will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To\nhave no fill on a shape, set this field to `NOT_RENDERED`. In this case,\nany other fill fields set in the same request will be ignored.", + "type": "string" } - }, - "id": "ShapeBackgroundFill" + } }, "CropProperties": { "description": "The crop properties of an object enclosed in a container. For example, an\nImage.\n\nThe crop properties is represented by the offsets of four edges which define\na crop rectangle. The offsets are measured in percentage from the\ncorresponding edges of the object's original bounding rectangle towards\ninside, relative to the object's original dimensions.\n\n- If the offset is in the interval (0, 1), the corresponding edge of crop\nrectangle is positioned inside of the object's original bounding rectangle.\n- If the offset is negative or greater than 1, the corresponding edge of crop\nrectangle is positioned outside of the object's original bounding rectangle.\n- If the left edge of the crop rectangle is on the right side of its right\nedge, the object will be flipped horizontally.\n- If the top edge of the crop rectangle is below its bottom edge, the object\nwill be flipped vertically.\n- If all offsets and rotation angle is 0, the object is not cropped.\n\nAfter cropping, the content in the crop rectangle will be stretched to fit\nits container.", "type": "object", "properties": { + "bottomOffset": { + "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.", + "format": "float", + "type": "number" + }, "angle": { "description": "The rotation angle of the crop window around its center, in radians.\nRotation angle is applied after the offset.", "format": "float", @@ -3819,11 +3842,6 @@ "description": "The offset specifies the right edge of the crop rectangle that is located\nto the left of the original bounding rectangle right edge, relative to the\nobject's original width.", "format": "float", "type": "number" - }, - "bottomOffset": { - "description": "The offset specifies the bottom edge of the crop rectangle that is located\nabove the original bounding rectangle bottom edge, relative to the object's\noriginal height.", - "format": "float", - "type": "number" } }, "id": "CropProperties" @@ -3871,6 +3889,10 @@ "description": "A color and position in a gradient band.", "type": "object", "properties": { + "color": { + "$ref": "OpaqueColor", + "description": "The color of the gradient stop." + }, "alpha": { "description": "The alpha value of this color in the gradient band. Defaults to 1.0,\nfully opaque.", "format": "float", @@ -3880,10 +3902,6 @@ "description": "The relative position of the color stop in the gradient band measured\nin percentage. The value should be in the interval [0.0, 1.0].", "format": "float", "type": "number" - }, - "color": { - "$ref": "OpaqueColor", - "description": "The color of the gradient stop." } }, "id": "ColorStop" @@ -3892,17 +3910,9 @@ "description": "Specifies a contiguous range of an indexed collection, such as characters in\ntext.", "type": "object", "properties": { - "startIndex": { - "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.", - "format": "int32", - "type": "integer" - }, - "endIndex": { - "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.", - "format": "int32", - "type": "integer" - }, "type": { + "description": "The type of range.", + "type": "string", "enumDescriptions": [ "Unspecified range type. This value must not be used.", "A fixed range. Both the `start_index` and\n`end_index` must be specified.", @@ -3914,9 +3924,17 @@ "FIXED_RANGE", "FROM_START_INDEX", "ALL" - ], - "description": "The type of range.", - "type": "string" + ] + }, + "startIndex": { + "description": "The optional zero-based index of the beginning of the collection.\nRequired for `FIXED_RANGE` and `FROM_START_INDEX` ranges.", + "format": "int32", + "type": "integer" + }, + "endIndex": { + "description": "The optional zero-based index of the end of the collection.\nRequired for `FIXED_RANGE` ranges.", + "format": "int32", + "type": "integer" } }, "id": "Range" @@ -3930,8 +3948,6 @@ "type": "string" }, "source": { - "description": "The video source.", - "type": "string", "enumDescriptions": [ "The video source is unspecified.", "The video source is YouTube." @@ -3939,11 +3955,13 @@ "enum": [ "SOURCE_UNSPECIFIED", "YOUTUBE" - ] + ], + "description": "The video source.", + "type": "string" }, "elementProperties": { - "description": "The element properties for the video.\n\nThe PageElementProperties.size property is\noptional. If you don't specify a size, a default size is chosen by the\nserver.\n\nThe PageElementProperties.transform property is\noptional. The transform must not have shear components.\nIf you don't specify a transform, the video will be placed at the top left\ncorner of the page.", - "$ref": "PageElementProperties" + "$ref": "PageElementProperties", + "description": "The element properties for the video.\n\nThe PageElementProperties.size property is\noptional. If you don't specify a size, a default size is chosen by the\nserver.\n\nThe PageElementProperties.transform property is\noptional. The transform must not have shear components.\nIf you don't specify a transform, the video will be placed at the top left\ncorner of the page." }, "id": { "description": "The video source's unique identifier for this video.\n\ne.g. For YouTube video https://www.youtube.com/watch?v=7U3axjORYZ0,\nthe ID is 7U3axjORYZ0.", @@ -3953,6 +3971,7 @@ "id": "CreateVideoRequest" }, "DuplicateObjectResponse": { + "id": "DuplicateObjectResponse", "description": "The response of duplicating an object.", "type": "object", "properties": { @@ -3960,326 +3979,330 @@ "description": "The ID of the new duplicate object.", "type": "string" } + } + }, + "ReplaceAllShapesWithImageRequest": { + "description": "Replaces all shapes that match the given criteria with the provided image.", + "type": "object", + "properties": { + "imageUrl": { + "description": "The image URL.\n\nThe image is fetched once at insertion time and a copy is stored for\ndisplay inside the presentation. Images must be less than 50MB in size,\ncannot exceed 25 megapixels, and must be in either in PNG, JPEG, or GIF\nformat.\n\nThe provided URL can be at most 2 kB in length.", + "type": "string" + }, + "replaceMethod": { + "description": "The replace method.", + "type": "string", + "enumDescriptions": [ + "Scales and centers the image to fit within the bounds of the original\nshape and maintains the image's aspect ratio. The rendered size of the\nimage may be smaller than the size of the shape. This is the default\nmethod when one is not specified.", + "Scales and centers the image to fill the bounds of the original shape.\nThe image may be cropped in order to fill the shape. The rendered size of\nthe image will be the same as that of the original shape." + ], + "enum": [ + "CENTER_INSIDE", + "CENTER_CROP" + ] + }, + "containsText": { + "description": "If set, this request will replace all of the shapes that contain the\ngiven text.", + "$ref": "SubstringMatchCriteria" + }, + "pageObjectIds": { + "description": "If non-empty, limits the matches to page elements only on the given pages.\n\nReturns a 400 bad request error if given the page object ID of a\nnotes page or a\nnotes master, or if a\npage with that object ID doesn't exist in the presentation.", + "type": "array", + "items": { + "type": "string" + } + } }, - "id": "DuplicateObjectResponse" + "id": "ReplaceAllShapesWithImageRequest" + }, + "MergeTableCellsRequest": { + "id": "MergeTableCellsRequest", + "description": "Merges cells in a Table.", + "type": "object", + "properties": { + "objectId": { + "description": "The object ID of the table.", + "type": "string" + }, + "tableRange": { + "$ref": "TableRange", + "description": "The table range specifying which cells of the table to merge.\n\nAny text in the cells being merged will be concatenated and stored in the\nupper-left (\"head\") cell of the range. If the range is non-rectangular\n(which can occur in some cases where the range covers cells that are\nalready merged), a 400 bad request error is returned." + } + } + }, + "UngroupObjectsRequest": { + "id": "UngroupObjectsRequest", + "description": "Ungroups objects, such as groups.", + "type": "object", + "properties": { + "objectIds": { + "description": "The object IDs of the objects to ungroup.\n\nOnly groups that are not inside other\ngroups can be ungrouped. All the groups\nshould be on the same page. The group itself is deleted. The visual sizes\nand positions of all the children are preserved.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Shadow": { + "description": "The shadow properties of a page element.\n\nIf these fields are unset, they may be inherited from a parent placeholder\nif it exists. If there is no parent, the fields will default to the value\nused for new page elements created in the Slides editor, which may depend on\nthe page element kind.", + "type": "object", + "properties": { + "alpha": { + "description": "The alpha of the shadow's color, from 0.0 to 1.0.", + "format": "float", + "type": "number" + }, + "color": { + "$ref": "OpaqueColor", + "description": "The shadow color value." + }, + "rotateWithShape": { + "description": "Whether the shadow should rotate with the shape.", + "type": "boolean" + }, + "propertyState": { + "enumDescriptions": [ + "If a property's state is RENDERED, then the element has the corresponding\nproperty when rendered on a page. If the element is a placeholder shape as\ndetermined by the placeholder\nfield, and it inherits from a placeholder shape, the corresponding field\nmay be unset, meaning that the property value is inherited from a parent\nplaceholder. If the element does not inherit, then the field will contain\nthe rendered value. This is the default value.", + "If a property's state is NOT_RENDERED, then the element does not have the\ncorresponding property when rendered on a page. However, the field may\nstill be set so it can be inherited by child shapes. To remove a property\nfrom a rendered element, set its property_state to NOT_RENDERED.", + "If a property's state is INHERIT, then the property state uses the value of\ncorresponding `property_state` field on the parent shape. Elements that do\nnot inherit will never have an INHERIT property state." + ], + "enum": [ + "RENDERED", + "NOT_RENDERED", + "INHERIT" + ], + "description": "The shadow property state.\n\nUpdating the shadow on a page element will implicitly update this field to\n`RENDERED`, unless another value is specified in the same request. To have\nno shadow on a page element, set this field to `NOT_RENDERED`. In this\ncase, any other shadow fields set in the same request will be ignored.", + "type": "string" + }, + "blurRadius": { + "description": "The radius of the shadow blur. The larger the radius, the more diffuse the\nshadow becomes.", + "$ref": "Dimension" + }, + "transform": { + "description": "Transform that encodes the translate, scale, and skew of the shadow,\nrelative to the alignment position.", + "$ref": "AffineTransform" + }, + "type": { + "description": "The type of the shadow.", + "type": "string", + "enumDescriptions": [ + "Unspecified shadow type.", + "Outer shadow." + ], + "enum": [ + "SHADOW_TYPE_UNSPECIFIED", + "OUTER" + ] + }, + "alignment": { + "enumDescriptions": [ + "Unspecified.", + "Top left.", + "Top center.", + "Top right.", + "Left center.", + "Center.", + "Right center.", + "Bottom left.", + "Bottom center.", + "Bottom right." + ], + "enum": [ + "RECTANGLE_POSITION_UNSPECIFIED", + "TOP_LEFT", + "TOP_CENTER", + "TOP_RIGHT", + "LEFT_CENTER", + "CENTER", + "RIGHT_CENTER", + "BOTTOM_LEFT", + "BOTTOM_CENTER", + "BOTTOM_RIGHT" + ], + "description": "The alignment point of the shadow, that sets the origin for translate,\nscale and skew of the shadow.", + "type": "string" + } + }, + "id": "Shadow" + }, + "DeleteTableRowRequest": { + "description": "Deletes a row from a table.", + "type": "object", + "properties": { + "cellLocation": { + "$ref": "TableCellLocation", + "description": "The reference table cell location from which a row will be deleted.\n\nThe row this cell spans will be deleted. If this is a merged cell, multiple\nrows will be deleted. If no rows remain in the table after this deletion,\nthe whole table is deleted." + }, + "tableObjectId": { + "description": "The table to delete rows from.", + "type": "string" + } + }, + "id": "DeleteTableRowRequest" + }, + "Bullet": { + "id": "Bullet", + "description": "Describes the bullet of a paragraph.", + "type": "object", + "properties": { + "bulletStyle": { + "description": "The paragraph specific text style applied to this bullet.", + "$ref": "TextStyle" + }, + "listId": { + "description": "The ID of the list this paragraph belongs to.", + "type": "string" + }, + "glyph": { + "description": "The rendered bullet glyph for this paragraph.", + "type": "string" + }, + "nestingLevel": { + "description": "The nesting level of this paragraph in the list.", + "format": "int32", + "type": "integer" + } + } + }, + "OutlineFill": { + "id": "OutlineFill", + "description": "The fill of the outline.", + "type": "object", + "properties": { + "solidFill": { + "$ref": "SolidFill", + "description": "Solid color fill." + } + } + }, + "CreateLineResponse": { + "description": "The result of creating a line.", + "type": "object", + "properties": { + "objectId": { + "description": "The object ID of the created line.", + "type": "string" + } + }, + "id": "CreateLineResponse" + }, + "TableCellLocation": { + "description": "A location of a single table cell within a table.", + "type": "object", + "properties": { + "rowIndex": { + "description": "The 0-based row index.", + "format": "int32", + "type": "integer" + }, + "columnIndex": { + "description": "The 0-based column index.", + "format": "int32", + "type": "integer" + } + }, + "id": "TableCellLocation" + }, + "ReplaceAllTextResponse": { + "description": "The result of replacing text.", + "type": "object", + "properties": { + "occurrencesChanged": { + "description": "The number of occurrences changed by replacing all text.", + "format": "int32", + "type": "integer" + } + }, + "id": "ReplaceAllTextResponse" + }, + "TableBorderFill": { + "description": "The fill of the border.", + "type": "object", + "properties": { + "solidFill": { + "$ref": "SolidFill", + "description": "Solid fill." + } + }, + "id": "TableBorderFill" + }, + "UpdateParagraphStyleRequest": { + "description": "Updates the styling for all of the paragraphs within a Shape or Table that\noverlap with the given text index range.", + "type": "object", + "properties": { + "objectId": { + "description": "The object ID of the shape or table with the text to be styled.", + "type": "string" + }, + "textRange": { + "description": "The range of text containing the paragraph(s) to style.", + "$ref": "Range" + }, + "cellLocation": { + "$ref": "TableCellLocation", + "description": "The location of the cell in the table containing the paragraph(s) to\nstyle. If `object_id` refers to a table, `cell_location` must have a value.\nOtherwise, it must not." + }, + "style": { + "$ref": "ParagraphStyle", + "description": "The paragraph's style." + }, + "fields": { + "description": "The fields that should be updated.\n\nAt least one field must be specified. The root `style` is implied and\nshould not be specified. A single `\"*\"` can be used as short-hand for\nlisting every field.\n\nFor example, to update the paragraph alignment, set `fields` to\n`\"alignment\"`.\n\nTo reset a property to its default value, include its field name in the\nfield mask but leave the field itself unset.", + "format": "google-fieldmask", + "type": "string" + } + }, + "id": "UpdateParagraphStyleRequest" + }, + "ColorScheme": { + "description": "The palette of predefined colors for a page.", + "type": "object", + "properties": { + "colors": { + "description": "The ThemeColorType and corresponding concrete color pairs.", + "type": "array", + "items": { + "$ref": "ThemeColorPair" + } + } + }, + "id": "ColorScheme" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "canonicalName": "Slides", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/spreadsheets": { - "description": "View and manage your spreadsheets in Google Drive" - }, - "https://www.googleapis.com/auth/presentations": { - "description": "View and manage your Google Slides presentations" - }, "https://www.googleapis.com/auth/presentations.readonly": { "description": "View your Google Slides presentations" }, "https://www.googleapis.com/auth/drive.file": { "description": "View and manage Google Drive files and folders that you have opened or created with this app" }, + "https://www.googleapis.com/auth/drive.readonly": { + "description": "View the files in your Google Drive" + }, "https://www.googleapis.com/auth/spreadsheets.readonly": { "description": "View your Google Spreadsheets" }, "https://www.googleapis.com/auth/drive": { "description": "View and manage the files in your Google Drive" }, - "https://www.googleapis.com/auth/drive.readonly": { - "description": "View the files in your Google Drive" + "https://www.googleapis.com/auth/spreadsheets": { + "description": "View and manage your spreadsheets in Google Drive" + }, + "https://www.googleapis.com/auth/presentations": { + "description": "View and manage your Google Slides presentations" } } } }, "rootUrl": "https://slides.googleapis.com/", - "ownerDomain": "google.com", - "name": "slides", - "batchPath": "batch", - "title": "Google Slides API", - "ownerName": "Google", - "resources": { - "presentations": { - "methods": { - "get": { - "flatPath": "v1/presentations/{presentationsId}", - "path": "v1/presentations/{+presentationId}", - "id": "slides.presentations.get", - "description": "Gets the latest version of the specified presentation.", - "response": { - "$ref": "Presentation" - }, - "parameterOrder": [ - "presentationId" - ], - "httpMethod": "GET", - "parameters": { - "presentationId": { - "location": "path", - "description": "The ID of the presentation to retrieve.", - "required": true, - "type": "string", - "pattern": "^[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/presentations", - "https://www.googleapis.com/auth/presentations.readonly" - ] - }, - "create": { - "description": "Creates a new presentation using the title given in the request. Other\nfields in the request are ignored.\nReturns the created presentation.", - "request": { - "$ref": "Presentation" - }, - "response": { - "$ref": "Presentation" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/presentations" - ], - "parameters": {}, - "flatPath": "v1/presentations", - "path": "v1/presentations", - "id": "slides.presentations.create" - }, - "batchUpdate": { - "httpMethod": "POST", - "parameterOrder": [ - "presentationId" - ], - "response": { - "$ref": "BatchUpdatePresentationResponse" - }, - "parameters": { - "presentationId": { - "description": "The presentation to apply the updates to.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/presentations", - "https://www.googleapis.com/auth/spreadsheets", - "https://www.googleapis.com/auth/spreadsheets.readonly" - ], - "flatPath": "v1/presentations/{presentationId}:batchUpdate", - "id": "slides.presentations.batchUpdate", - "path": "v1/presentations/{presentationId}:batchUpdate", - "request": { - "$ref": "BatchUpdatePresentationRequest" - }, - "description": "Applies one or more updates to the presentation.\n\nEach request is validated before\nbeing applied. If any request is not valid, then the entire request will\nfail and nothing will be applied.\n\nSome requests have replies to\ngive you some information about how they are applied. Other requests do\nnot need to return information; these each return an empty reply.\nThe order of replies matches that of the requests.\n\nFor example, suppose you call batchUpdate with four updates, and only the\nthird one returns information. The response would have two empty replies:\nthe reply to the third request, and another empty reply, in that order.\n\nBecause other users may be editing the presentation, the presentation\nmight not exactly reflect your changes: your changes may\nbe altered with respect to collaborator changes. If there are no\ncollaborators, the presentation should reflect your changes. In any case,\nthe updates in your request are guaranteed to be applied together\natomically." - } - }, - "resources": { - "pages": { - "methods": { - "getThumbnail": { - "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail", - "path": "v1/presentations/{presentationId}/pages/{pageObjectId}/thumbnail", - "id": "slides.presentations.pages.getThumbnail", - "description": "Generates a thumbnail of the latest version of the specified page in the\npresentation and returns a URL to the thumbnail image.", - "response": { - "$ref": "Thumbnail" - }, - "parameterOrder": [ - "presentationId", - "pageObjectId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/presentations", - "https://www.googleapis.com/auth/presentations.readonly" - ], - "parameters": { - "pageObjectId": { - "location": "path", - "description": "The object ID of the page whose thumbnail to retrieve.", - "required": true, - "type": "string" - }, - "thumbnailProperties.mimeType": { - "description": "The optional mime type of the thumbnail image.\n\nIf you don't specify the mime type, the default mime type will be PNG.", - "type": "string", - "location": "query", - "enum": [ - "PNG" - ] - }, - "thumbnailProperties.thumbnailSize": { - "location": "query", - "enum": [ - "THUMBNAIL_SIZE_UNSPECIFIED", - "LARGE" - ], - "description": "The optional thumbnail image size.\n\nIf you don't specify the size, the server chooses a default size of the\nimage.", - "type": "string" - }, - "presentationId": { - "description": "The ID of the presentation to retrieve.", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "get": { - "description": "Gets the latest version of the specified page in the presentation.", - "httpMethod": "GET", - "response": { - "$ref": "Page" - }, - "parameterOrder": [ - "presentationId", - "pageObjectId" - ], - "parameters": { - "presentationId": { - "location": "path", - "description": "The ID of the presentation to retrieve.", - "required": true, - "type": "string" - }, - "pageObjectId": { - "location": "path", - "description": "The object ID of the page to retrieve.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/drive", - "https://www.googleapis.com/auth/drive.file", - "https://www.googleapis.com/auth/drive.readonly", - "https://www.googleapis.com/auth/presentations", - "https://www.googleapis.com/auth/presentations.readonly" - ], - "flatPath": "v1/presentations/{presentationId}/pages/{pageObjectId}", - "id": "slides.presentations.pages.get", - "path": "v1/presentations/{presentationId}/pages/{pageObjectId}" - } - } - } - } - } - }, - "parameters": { - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "alt": { - "type": "string", - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - } - }, - "version": "v1", - "baseUrl": "https://slides.googleapis.com/", - "description": "An API for creating and editing Google Slides presentations.", - "kind": "discovery#restDescription", - "servicePath": "", - "basePath": "", - "revision": "20171220", - "documentationLink": "https://developers.google.com/slides/", - "id": "slides:v1", - "discoveryVersion": "v1", - "version_module": true + "ownerDomain": "google.com" }
diff --git a/slides/v1/slides-gen.go b/slides/v1/slides-gen.go index d85e723..44625f7 100644 --- a/slides/v1/slides-gen.go +++ b/slides/v1/slides-gen.go
@@ -4396,6 +4396,11 @@ // UpdateLineProperties: Updates the properties of a Line. UpdateLineProperties *UpdateLinePropertiesRequest `json:"updateLineProperties,omitempty"` + // UpdatePageElementAltText: Updates the alt text title and/or + // description of a + // page element. + UpdatePageElementAltText *UpdatePageElementAltTextRequest `json:"updatePageElementAltText,omitempty"` + // UpdatePageElementTransform: Updates the transform of a page element. UpdatePageElementTransform *UpdatePageElementTransformRequest `json:"updatePageElementTransform,omitempty"` @@ -6691,6 +6696,55 @@ return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) } +// UpdatePageElementAltTextRequest: Updates the alt text title and/or +// description of a +// page element. +type UpdatePageElementAltTextRequest struct { + // Description: The updated alt text description of the page element. If + // unset the existing + // value will be maintained. The description is exposed to screen + // readers + // and other accessibility interfaces. Only use human readable values + // related + // to the content of the page element. + Description string `json:"description,omitempty"` + + // ObjectId: The object ID of the page element the updates are applied + // to. + ObjectId string `json:"objectId,omitempty"` + + // Title: The updated alt text title of the page element. If unset + // the + // existing value will be maintained. The title is exposed to screen + // readers + // and other accessibility interfaces. Only use human readable values + // related + // to the content of the page element. + Title string `json:"title,omitempty"` + + // ForceSendFields is a list of field names (e.g. "Description") to + // unconditionally include in API requests. By default, fields with + // empty values are omitted from API requests. However, any non-pointer, + // non-interface field appearing in ForceSendFields will be sent to the + // server regardless of whether the field is empty or not. This may be + // used to include empty fields in Patch requests. + ForceSendFields []string `json:"-"` + + // NullFields is a list of field names (e.g. "Description") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as + // null. It is an error if a field in this list has a non-empty value. + // This may be used to include null fields in Patch requests. + NullFields []string `json:"-"` +} + +func (s *UpdatePageElementAltTextRequest) MarshalJSON() ([]byte, error) { + type NoMethod UpdatePageElementAltTextRequest + raw := NoMethod(*s) + return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields) +} + // UpdatePageElementTransformRequest: Updates the transform of a page // element. //
diff --git a/sourcerepo/v1/sourcerepo-api.json b/sourcerepo/v1/sourcerepo-api.json index ac7a13c..a36f4ce 100644 --- a/sourcerepo/v1/sourcerepo-api.json +++ b/sourcerepo/v1/sourcerepo-api.json
@@ -1,17 +1,48 @@ { + "batchPath": "batch", + "title": "Cloud Source Repositories API", + "ownerName": "Google", "resources": { "projects": { "resources": { "repos": { "methods": { - "list": { - "httpMethod": "GET", + "delete": { + "httpMethod": "DELETE", "parameterOrder": [ "name" ], "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "location": "path", + "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/repos/.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/source.full_control", + "https://www.googleapis.com/auth/source.read_only", + "https://www.googleapis.com/auth/source.read_write" + ], + "flatPath": "v1/projects/{projectsId}/repos/{reposId}", + "id": "sourcerepo.projects.repos.delete", + "path": "v1/{+name}", + "description": "Deletes a repo." + }, + "list": { + "response": { "$ref": "ListReposResponse" }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", "parameters": { "name": { "location": "path", @@ -21,15 +52,15 @@ "pattern": "^projects/[^/]+$" }, "pageToken": { - "type": "string", "location": "query", - "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field." + "description": "Resume listing repositories where a prior ListReposResponse\nleft off. This is an opaque token that must be obtained from\na recent, prior ListReposResponse's next_page_token field.", + "type": "string" }, "pageSize": { + "type": "integer", "location": "query", "description": "Maximum number of repositories to return; between 1 and 500.\nIf not set or zero, defaults to 100 at the server.", - "format": "int32", - "type": "integer" + "format": "int32" } }, "scopes": [ @@ -39,25 +70,25 @@ "https://www.googleapis.com/auth/source.read_write" ], "flatPath": "v1/projects/{projectsId}/repos", - "id": "sourcerepo.projects.repos.list", "path": "v1/{+name}/repos", + "id": "sourcerepo.projects.repos.list", "description": "Returns all repos belonging to a project. The sizes of the repos are\nnot set by ListRepos. To get the size of a repo, use GetRepo." }, "create": { "flatPath": "v1/projects/{projectsId}/repos", - "path": "v1/{+parent}/repos", "id": "sourcerepo.projects.repos.create", + "path": "v1/{+parent}/repos", "request": { "$ref": "Repo" }, "description": "Creates a repo in the given project with the given name.\n\nIf the named repository already exists, `CreateRepo` returns\n`ALREADY_EXISTS`.", - "response": { - "$ref": "Repo" - }, + "httpMethod": "POST", "parameterOrder": [ "parent" ], - "httpMethod": "POST", + "response": { + "$ref": "Repo" + }, "parameters": { "parent": { "location": "path", @@ -84,11 +115,11 @@ "httpMethod": "POST", "parameters": { "resource": { + "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^projects/[^/]+/repos/.+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being specified.\nSee the operation documentation for the appropriate value for this field." + "location": "path" } }, "scopes": [ @@ -106,13 +137,13 @@ "description": "Sets the access control policy on the specified resource. Replaces any\nexisting policy." }, "getIamPolicy": { - "httpMethod": "GET", - "parameterOrder": [ - "resource" - ], "response": { "$ref": "Policy" }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform", "https://www.googleapis.com/auth/source.full_control", @@ -121,19 +152,21 @@ ], "parameters": { "resource": { + "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, "type": "string", "pattern": "^projects/[^/]+/repos/.+$", - "location": "path", - "description": "REQUIRED: The resource for which the policy is being requested.\nSee the operation documentation for the appropriate value for this field." + "location": "path" } }, "flatPath": "v1/projects/{projectsId}/repos/{reposId}:getIamPolicy", - "id": "sourcerepo.projects.repos.getIamPolicy", "path": "v1/{+resource}:getIamPolicy", + "id": "sourcerepo.projects.repos.getIamPolicy", "description": "Gets the access control policy for a resource.\nReturns an empty policy if the resource exists and does not have a policy\nset." }, "get": { + "id": "sourcerepo.projects.repos.get", + "path": "v1/{+name}", "description": "Returns information about a repo.", "httpMethod": "GET", "response": { @@ -157,11 +190,15 @@ "https://www.googleapis.com/auth/source.read_only", "https://www.googleapis.com/auth/source.read_write" ], - "flatPath": "v1/projects/{projectsId}/repos/{reposId}", - "id": "sourcerepo.projects.repos.get", - "path": "v1/{+name}" + "flatPath": "v1/projects/{projectsId}/repos/{reposId}" }, "testIamPermissions": { + "path": "v1/{+resource}:testIamPermissions", + "id": "sourcerepo.projects.repos.testIamPermissions", + "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error.", + "request": { + "$ref": "TestIamPermissionsRequest" + }, "response": { "$ref": "TestIamPermissionsResponse" }, @@ -169,56 +206,22 @@ "resource" ], "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/source.full_control", + "https://www.googleapis.com/auth/source.read_only", + "https://www.googleapis.com/auth/source.read_write" + ], "parameters": { "resource": { - "required": true, - "type": "string", "pattern": "^projects/[^/]+/repos/.+$", "location": "path", - "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/source.full_control", - "https://www.googleapis.com/auth/source.read_only", - "https://www.googleapis.com/auth/source.read_write" - ], - "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "sourcerepo.projects.repos.testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that a caller has on the specified resource.\nIf the resource does not exist, this will return an empty set of\npermissions, not a NOT_FOUND error." - }, - "delete": { - "description": "Deletes a repo.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { + "description": "REQUIRED: The resource for which the policy detail is being requested.\nSee the operation documentation for the appropriate value for this field.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/repos/.+$", - "location": "path", - "description": "The name of the repo to delete. Values are of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`." + "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/source.full_control", - "https://www.googleapis.com/auth/source.read_only", - "https://www.googleapis.com/auth/source.read_write" - ], - "flatPath": "v1/projects/{projectsId}/repos/{reposId}", - "path": "v1/{+name}", - "id": "sourcerepo.projects.repos.delete" + "flatPath": "v1/projects/{projectsId}/repos/{reposId}:testIamPermissions" } } } @@ -226,10 +229,31 @@ } }, "parameters": { - "upload_protocol": { - "type": "string", + "quotaUser": { "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." + "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.", + "type": "string" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" }, "prettyPrint": { "type": "boolean", @@ -238,16 +262,17 @@ "description": "Returns response with indentations and line breaks." }, "fields": { + "description": "Selector specifying which fields to include in a partial response.", "type": "string", - "location": "query", - "description": "Selector specifying which fields to include in a partial response." + "location": "query" }, "uploadType": { - "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" + "type": "string", + "location": "query" }, "$.xgafv": { + "description": "V1 error format.", "type": "string", "enumDescriptions": [ "v1 error format", @@ -257,15 +282,20 @@ "enum": [ "1", "2" - ], - "description": "V1 error format." + ] }, "callback": { - "type": "string", "location": "query", - "description": "JSONP" + "description": "JSONP", + "type": "string" }, "alt": { + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", @@ -273,51 +303,24 @@ "Responses with Content-Type of application/x-protobuf" ], "location": "query", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] + "description": "Data format for response." }, "access_token": { - "type": "string", "location": "query", - "description": "OAuth access token." + "description": "OAuth access token.", + "type": "string" }, "key": { - "location": "query", "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.", - "type": "string" - }, - "quotaUser": { "type": "string", - "location": "query", - "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." - }, - "pp": { - "type": "boolean", - "default": "true", - "location": "query", - "description": "Pretty-print response." - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" + "location": "query" } }, "version": "v1", "baseUrl": "https://sourcerepo.googleapis.com/", - "servicePath": "", - "description": "Access source code repositories hosted by Google.", "kind": "discovery#restDescription", + "description": "Access source code repositories hosted by Google.", + "servicePath": "", "basePath": "", "revision": "20171110", "documentationLink": "https://cloud.google.com/source-repositories/docs/apis", @@ -325,45 +328,21 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { - "AuditConfig": { - "type": "object", - "properties": { - "exemptedMembers": { - "type": "array", - "items": { - "type": "string" - } - }, - "service": { - "type": "string", - "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services." - }, - "auditLogConfigs": { - "description": "The configuration for logging of each type of permission.\nNext ID: 4", - "type": "array", - "items": { - "$ref": "AuditLogConfig" - } - } - }, - "id": "AuditConfig", - "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging." - }, "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", "properties": { - "policy": { - "$ref": "Policy", - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." - }, "updateMask": { + "type": "string", "description": "OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only\nthe fields in the mask will be modified. If no mask is provided, the\nfollowing default mask is used:\npaths: \"bindings, etag\"\nThis field is only used by Cloud IAM.", - "format": "google-fieldmask", - "type": "string" + "format": "google-fieldmask" + }, + "policy": { + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", + "$ref": "Policy" } }, - "id": "SetIamPolicyRequest" + "id": "SetIamPolicyRequest", + "description": "Request message for `SetIamPolicy` method.", + "type": "object" }, "Binding": { "description": "Associates `members` with a `role`.", @@ -374,26 +353,46 @@ "description": "The condition that is associated with this binding.\nNOTE: an unsatisfied condition will not allow user access via current\nbinding. Different bindings, including their conditions, are examined\nindependently.\nThis field is GOOGLE_INTERNAL." }, "members": { + "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", "type": "array", "items": { "type": "string" - }, - "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n" + } }, "role": { - "type": "string", - "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired" + "description": "Role that is assigned to `members`.\nFor example, `roles/viewer`, `roles/editor`, or `roles/owner`.\nRequired", + "type": "string" } }, "id": "Binding" }, - "MirrorConfig": { + "Expr": { + "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"", "type": "object", "properties": { - "webhookId": { - "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webhook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.", + "description": { + "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", "type": "string" }, + "expression": { + "type": "string", + "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported." + }, + "title": { + "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression.", + "type": "string" + }, + "location": { + "type": "string", + "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file." + } + }, + "id": "Expr" + }, + "MirrorConfig": { + "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket.", + "type": "object", + "properties": { "deployKeyId": { "description": "ID of the SSH deploy key at the other hosting service.\nRemoving this key from the other service would deauthorize\nGoogle Cloud Source Repositories from mirroring.", "type": "string" @@ -401,10 +400,13 @@ "url": { "description": "URL of the main repository at the other hosting service.", "type": "string" + }, + "webhookId": { + "description": "ID of the webhook listening to updates to trigger mirroring.\nRemoving this webhook from the other hosting service will stop\nGoogle Cloud Source Repositories from receiving notifications,\nand thereby disabling mirroring.", + "type": "string" } }, - "id": "MirrorConfig", - "description": "Configuration to automatically mirror a repository from another\nhosting service, for example GitHub or BitBucket." + "id": "MirrorConfig" }, "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 `{}`.", @@ -412,68 +414,46 @@ "properties": {}, "id": "Empty" }, - "Expr": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "An optional title for the expression, i.e. a short string describing\nits purpose. This can be used e.g. in UIs which allow to enter the\nexpression." - }, - "location": { - "description": "An optional string indicating the location of the expression for error\nreporting, e.g. a file name and a position in the file.", - "type": "string" - }, - "description": { - "description": "An optional description of the expression. This is a longer text which\ndescribes the expression, e.g. when hovered over it in a UI.", - "type": "string" - }, - "expression": { - "description": "Textual representation of an expression in\nCommon Expression Language syntax.\n\nThe application context of the containing message determines which\nwell-known feature set of CEL is supported.", - "type": "string" - } - }, - "id": "Expr", - "description": "Represents an expression text. Example:\n\n title: \"User account presence\"\n description: \"Determines whether the request has a user account\"\n expression: \"size(request.user) \u003e 0\"" - }, "Repo": { - "description": "A repository (or repo) is a Git repository storing versioned source content.", "type": "object", "properties": { - "name": { - "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`", - "type": "string" - }, "mirrorConfig": { "$ref": "MirrorConfig", "description": "How this repository mirrors a repository managed by another service.\nRead-only field." }, "url": { - "type": "string", - "description": "URL to clone the repository from Google Cloud Source Repositories.\nRead-only field." + "description": "URL to clone the repository from Google Cloud Source Repositories.\nRead-only field.", + "type": "string" }, "size": { - "type": "string", "description": "The disk usage of the repo, in bytes. Read-only field. Size is only\nreturned by GetRepo.", - "format": "int64" + "format": "int64", + "type": "string" + }, + "name": { + "description": "Resource name of the repository, of the form\n`projects/\u003cproject\u003e/repos/\u003crepo\u003e`. The repo name may contain slashes.\neg, `projects/myproject/repos/name/with/slash`", + "type": "string" } }, - "id": "Repo" + "id": "Repo", + "description": "A repository (or repo) is a Git repository storing versioned source content." }, "TestIamPermissionsResponse": { "description": "Response message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { + "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", "type": "array", "items": { "type": "string" - }, - "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed." + } } }, "id": "TestIamPermissionsResponse" }, "ListReposResponse": { + "description": "Response for ListRepos. The size is not set in the returned repositories.", "type": "object", "properties": { "repos": { @@ -488,12 +468,9 @@ "type": "string" } }, - "id": "ListReposResponse", - "description": "Response for ListRepos. The size is not set in the returned repositories." + "id": "ListReposResponse" }, "AuditLogConfig": { - "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", - "type": "object", "properties": { "exemptedMembers": { "description": "Specifies the identities that do not cause logging for this type of\npermission.\nFollows the same format of Binding.members.", @@ -503,6 +480,7 @@ } }, "logType": { + "description": "The log type that this config enables.", "type": "string", "enumDescriptions": [ "Default case. Should never be this.", @@ -515,14 +493,14 @@ "ADMIN_READ", "DATA_WRITE", "DATA_READ" - ], - "description": "The log type that this config enables." + ] } }, - "id": "AuditLogConfig" + "id": "AuditLogConfig", + "description": "Provides the configuration for logging a type of permissions.\nExample:\n\n {\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n }\n ]\n }\n\nThis enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting\nfoo@gmail.com from DATA_READ logging.", + "type": "object" }, "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", "type": "object", "properties": { "permissions": { @@ -533,12 +511,26 @@ } } }, - "id": "TestIamPermissionsRequest" + "id": "TestIamPermissionsRequest", + "description": "Request message for `TestIamPermissions` method." }, "Policy": { + "id": "Policy", "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", "type": "object", "properties": { + "version": { + "description": "Version of the `Policy`. The default version is 0.", + "format": "int32", + "type": "integer" + }, + "auditConfigs": { + "description": "Specifies cloud audit logging configuration for this policy.", + "type": "array", + "items": { + "$ref": "AuditConfig" + } + }, "bindings": { "type": "array", "items": { @@ -550,24 +542,35 @@ "type": "boolean" }, "etag": { - "type": "string", "description": "`etag` is used for optimistic concurrency control as a way to help\nprevent simultaneous updates of a policy from overwriting each other.\nIt is strongly suggested that systems make use of the `etag` in the\nread-modify-write cycle to perform policy updates in order to avoid race\nconditions: An `etag` is returned in the response to `getIamPolicy`, and\nsystems are expected to put that etag in the request to `setIamPolicy` to\nensure that their change will be applied to the same version of the policy.\n\nIf no `etag` is provided in the call to `setIamPolicy`, then the existing\npolicy is overwritten blindly.", - "format": "byte" - }, - "version": { - "description": "Version of the `Policy`. The default version is 0.", - "format": "int32", - "type": "integer" - }, - "auditConfigs": { + "format": "byte", + "type": "string" + } + } + }, + "AuditConfig": { + "properties": { + "exemptedMembers": { "type": "array", "items": { - "$ref": "AuditConfig" - }, - "description": "Specifies cloud audit logging configuration for this policy." + "type": "string" + } + }, + "service": { + "description": "Specifies a service that will be enabled for audit logging.\nFor example, `storage.googleapis.com`, `cloudsql.googleapis.com`.\n`allServices` is a special value that covers all services.", + "type": "string" + }, + "auditLogConfigs": { + "description": "The configuration for logging of each type of permission.\nNext ID: 4", + "type": "array", + "items": { + "$ref": "AuditLogConfig" + } } }, - "id": "Policy" + "id": "AuditConfig", + "description": "Specifies the audit configuration for a service.\nThe configuration determines which permission types are logged, and what\nidentities, if any, are exempted from logging.\nAn AuditConfig must have one or more AuditLogConfigs.\n\nIf there are AuditConfigs for both `allServices` and a specific service,\nthe union of the two AuditConfigs is used for that service: the log_types\nspecified in each AuditConfig are enabled, and the exempted_members in each\nAuditConfig are exempted.\n\nExample Policy with multiple AuditConfigs:\n\n {\n \"audit_configs\": [\n {\n \"service\": \"allServices\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n \"exempted_members\": [\n \"user:foo@gmail.com\"\n ]\n },\n {\n \"log_type\": \"DATA_WRITE\",\n },\n {\n \"log_type\": \"ADMIN_READ\",\n }\n ]\n },\n {\n \"service\": \"fooservice.googleapis.com\"\n \"audit_log_configs\": [\n {\n \"log_type\": \"DATA_READ\",\n },\n {\n \"log_type\": \"DATA_WRITE\",\n \"exempted_members\": [\n \"user:bar@gmail.com\"\n ]\n }\n ]\n }\n ]\n }\n\nFor fooservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ\nlogging. It also exempts foo@gmail.com from DATA_READ logging, and\nbar@gmail.com from DATA_WRITE logging.", + "type": "object" } }, "icons": { @@ -579,25 +582,22 @@ "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/source.full_control": { - "description": "Manage your source code repositories" - }, "https://www.googleapis.com/auth/source.read_only": { "description": "View the contents of your source code repositories" }, "https://www.googleapis.com/auth/source.read_write": { "description": "Manage the contents of your source code repositories" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/source.full_control": { + "description": "Manage your source code repositories" } } } }, "rootUrl": "https://sourcerepo.googleapis.com/", "ownerDomain": "google.com", - "name": "sourcerepo", - "batchPath": "batch", - "title": "Cloud Source Repositories API", - "ownerName": "Google" + "name": "sourcerepo" }
diff --git a/spanner/v1/spanner-api.json b/spanner/v1/spanner-api.json index 48f9515..591b2d0 100644 --- a/spanner/v1/spanner-api.json +++ b/spanner/v1/spanner-api.json
@@ -1,7 +1,1260 @@ { - "servicePath": "", + "ownerName": "Google", + "resources": { + "projects": { + "resources": { + "instances": { + "methods": { + "list": { + "description": "Lists all instances in the given project.", + "response": { + "$ref": "ListInstancesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "pageSize": { + "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "parent": { + "location": "path", + "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$" + }, + "filter": { + "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `name`\n * `display_name`\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `name:*` --\u003e The instance has a name.\n * `name:Howl` --\u003e The instance's name contains the string \"howl\".\n * `name:HOWL` --\u003e Equivalent to above.\n * `NAME:howl` --\u003e Equivalent to above.\n * `labels.env:*` --\u003e The instance has the label \"env\".\n * `labels.env:dev` --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * `name:howl labels.env:dev` --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".", + "type": "string", + "location": "query" + }, + "pageToken": { + "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/projects/{projectsId}/instances", + "path": "v1/{+parent}/instances", + "id": "spanner.projects.instances.list" + }, + "setIamPolicy": { + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "id": "spanner.projects.instances.setIamPolicy", + "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "location": "path" + } + } + }, + "create": { + "flatPath": "v1/projects/{projectsId}/instances", + "id": "spanner.projects.instances.create", + "path": "v1/{+parent}/instances", + "request": { + "$ref": "CreateInstanceRequest" + }, + "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n`ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation:\n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track creation of the instance. The\nmetadata field type is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "parent": { + "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "getIamPolicy": { + "path": "v1/{+resource}:getIamPolicy", + "id": "spanner.projects.instances.getIamPolicy", + "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "response": { + "$ref": "Policy" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy" + }, + "patch": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "PATCH", + "parameters": { + "name": { + "location": "path", + "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.patch", + "request": { + "$ref": "UpdateInstanceRequest" + }, + "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name." + }, + "get": { + "response": { + "$ref": "Instance" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "location": "path", + "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.get", + "description": "Gets information about a particular instance." + }, + "testIamPermissions": { + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameterOrder": [ + "resource" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "resource": { + "location": "path", + "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions", + "path": "v1/{+resource}:testIamPermissions", + "id": "spanner.projects.instances.testIamPermissions", + "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.", + "request": { + "$ref": "TestIamPermissionsRequest" + } + }, + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+$", + "location": "path", + "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.delete", + "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted." + } + }, + "resources": { + "databases": { + "methods": { + "setIamPolicy": { + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy", + "id": "spanner.projects.instances.databases.setIamPolicy", + "path": "v1/{+resource}:setIamPolicy", + "request": { + "$ref": "SetIamPolicyRequest" + }, + "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource." + }, + "create": { + "id": "spanner.projects.instances.databases.create", + "path": "v1/{+parent}/databases", + "request": { + "$ref": "CreateDatabaseRequest" + }, + "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.", + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "parent": { + "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases" + }, + "getIamPolicy": { + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy", + "id": "spanner.projects.instances.databases.getIamPolicy", + "path": "v1/{+resource}:getIamPolicy", + "request": { + "$ref": "GetIamPolicyRequest" + }, + "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "Policy" + }, + "parameters": { + "resource": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path", + "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + }, + "get": { + "response": { + "$ref": "Database" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path", + "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.databases.get", + "description": "Gets the state of a Cloud Spanner database." + }, + "dropDatabase": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "DELETE", + "parameters": { + "database": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path", + "description": "Required. The database to be dropped.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}", + "path": "v1/{+database}", + "id": "spanner.projects.instances.databases.dropDatabase", + "description": "Drops (aka deletes) a Cloud Spanner database." + }, + "updateDdl": { + "request": { + "$ref": "UpdateDatabaseDdlRequest" + }, + "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.", + "httpMethod": "PATCH", + "parameterOrder": [ + "database" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "database": { + "description": "Required. The database to update.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl", + "id": "spanner.projects.instances.databases.updateDdl", + "path": "v1/{+database}/ddl" + }, + "testIamPermissions": { + "request": { + "$ref": "TestIamPermissionsRequest" + }, + "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.", + "httpMethod": "POST", + "parameterOrder": [ + "resource" + ], + "response": { + "$ref": "TestIamPermissionsResponse" + }, + "parameters": { + "resource": { + "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions", + "id": "spanner.projects.instances.databases.testIamPermissions", + "path": "v1/{+resource}:testIamPermissions" + }, + "getDdl": { + "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API.", + "httpMethod": "GET", + "response": { + "$ref": "GetDatabaseDdlResponse" + }, + "parameterOrder": [ + "database" + ], + "parameters": { + "database": { + "location": "path", + "description": "Required. The database whose schema we wish to get.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl", + "id": "spanner.projects.instances.databases.getDdl", + "path": "v1/{+database}/ddl" + }, + "list": { + "response": { + "$ref": "ListDatabasesResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.", + "format": "int32", + "type": "integer" + }, + "parent": { + "pattern": "^projects/[^/]+/instances/[^/]+$", + "location": "path", + "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.", + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", + "path": "v1/{+parent}/databases", + "id": "spanner.projects.instances.databases.list", + "description": "Lists Cloud Spanner databases." + } + }, + "resources": { + "operations": { + "methods": { + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "httpMethod": "POST", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "Empty" + }, + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel", + "id": "spanner.projects.instances.databases.operations.cancel", + "path": "v1/{+name}:cancel" + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.databases.operations.delete" + }, + "list": { + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "description": "The standard list filter.", + "type": "string", + "location": "query" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations", + "path": "v1/{+name}", + "id": "spanner.projects.instances.databases.operations.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." + }, + "get": { + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.databases.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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ] + } + } + }, + "sessions": { + "methods": { + "delete": { + "description": "Ends a session, releasing server resources associated with it.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The name of the session to delete.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.databases.sessions.delete" + }, + "executeStreamingSql": { + "response": { + "$ref": "PartialResultSet" + }, + "parameterOrder": [ + "session" + ], + "httpMethod": "POST", + "parameters": { + "session": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The session in which the SQL query should be performed.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql", + "path": "v1/{+session}:executeStreamingSql", + "id": "spanner.projects.instances.databases.sessions.executeStreamingSql", + "request": { + "$ref": "ExecuteSqlRequest" + }, + "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB." + }, + "beginTransaction": { + "request": { + "$ref": "BeginTransactionRequest" + }, + "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.", + "response": { + "$ref": "Transaction" + }, + "parameterOrder": [ + "session" + ], + "httpMethod": "POST", + "parameters": { + "session": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The session in which the transaction runs.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction", + "path": "v1/{+session}:beginTransaction", + "id": "spanner.projects.instances.databases.sessions.beginTransaction" + }, + "commit": { + "request": { + "$ref": "CommitRequest" + }, + "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session.", + "response": { + "$ref": "CommitResponse" + }, + "parameterOrder": [ + "session" + ], + "httpMethod": "POST", + "parameters": { + "session": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The session in which the transaction to be committed is running.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit", + "path": "v1/{+session}:commit", + "id": "spanner.projects.instances.databases.sessions.commit" + }, + "list": { + "description": "Lists all sessions in a given database.", + "response": { + "$ref": "ListSessionsResponse" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "parameters": { + "filter": { + "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `labels.env:*` --\u003e The session has the label \"env\".\n * `labels.env:dev` --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".", + "type": "string", + "location": "query" + }, + "pageToken": { + "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "Number of sessions to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.", + "format": "int32", + "type": "integer" + }, + "database": { + "description": "Required. The database in which to list sessions.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions", + "path": "v1/{+database}/sessions", + "id": "spanner.projects.instances.databases.sessions.list" + }, + "executeSql": { + "path": "v1/{+session}:executeSql", + "id": "spanner.projects.instances.databases.sessions.executeSql", + "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.", + "request": { + "$ref": "ExecuteSqlRequest" + }, + "response": { + "$ref": "ResultSet" + }, + "parameterOrder": [ + "session" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "parameters": { + "session": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The session in which the SQL query should be performed.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql" + }, + "rollback": { + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback", + "path": "v1/{+session}:rollback", + "id": "spanner.projects.instances.databases.sessions.rollback", + "request": { + "$ref": "RollbackRequest" + }, + "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "session" + ], + "httpMethod": "POST", + "parameters": { + "session": { + "location": "path", + "description": "Required. The session in which the transaction to roll back is running.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ] + }, + "streamingRead": { + "request": { + "$ref": "ReadRequest" + }, + "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB.", + "httpMethod": "POST", + "parameterOrder": [ + "session" + ], + "response": { + "$ref": "PartialResultSet" + }, + "parameters": { + "session": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The session in which the read should be performed.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead", + "id": "spanner.projects.instances.databases.sessions.streamingRead", + "path": "v1/{+session}:streamingRead" + }, + "create": { + "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.", + "request": { + "$ref": "CreateSessionRequest" + }, + "response": { + "$ref": "Session" + }, + "parameterOrder": [ + "database" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "parameters": { + "database": { + "description": "Required. The database in which the new session is created.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions", + "path": "v1/{+database}/sessions", + "id": "spanner.projects.instances.databases.sessions.create" + }, + "read": { + "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.", + "request": { + "$ref": "ReadRequest" + }, + "response": { + "$ref": "ResultSet" + }, + "parameterOrder": [ + "session" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "parameters": { + "session": { + "location": "path", + "description": "Required. The session in which the read should be performed.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read", + "path": "v1/{+session}:read", + "id": "spanner.projects.instances.databases.sessions.read" + }, + "get": { + "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive.", + "response": { + "$ref": "Session" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.data" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", + "location": "path", + "description": "Required. The name of the session to retrieve.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.databases.sessions.get" + } + } + } + } + }, + "operations": { + "methods": { + "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.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/operations$", + "location": "path" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations", + "path": "v1/{+name}", + "id": "spanner.projects.instances.operations.list" + }, + "get": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}", + "path": "v1/{+name}", + "id": "spanner.projects.instances.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." + }, + "cancel": { + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel", + "path": "v1/{+name}:cancel", + "id": "spanner.projects.instances.operations.cancel" + }, + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}", + "id": "spanner.projects.instances.operations.delete", + "path": "v1/{+name}", + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`." + } + } + } + } + }, + "instanceConfigs": { + "methods": { + "list": { + "response": { + "$ref": "ListInstanceConfigsResponse" + }, + "parameterOrder": [ + "parent" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "parameters": { + "pageSize": { + "location": "query", + "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.", + "format": "int32", + "type": "integer" + }, + "parent": { + "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/projects/{projectsId}/instanceConfigs", + "path": "v1/{+parent}/instanceConfigs", + "id": "spanner.projects.instanceConfigs.list", + "description": "Lists the supported instance configurations for a given project." + }, + "get": { + "httpMethod": "GET", + "parameterOrder": [ + "name" + ], + "response": { + "$ref": "InstanceConfig" + }, + "parameters": { + "name": { + "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/spanner.admin" + ], + "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", + "id": "spanner.projects.instanceConfigs.get", + "path": "v1/{+name}", + "description": "Gets information about a particular instance configuration." + } + } + } + } + } + }, + "parameters": { + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "quotaUser": { + "location": "query", + "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.", + "type": "string" + } + }, + "version": "v1", + "baseUrl": "https://spanner.googleapis.com/", "kind": "discovery#restDescription", "description": "Cloud Spanner is a managed, mission-critical, globally consistent and scalable relational database service.", + "servicePath": "", "basePath": "", "revision": "20171204", "documentationLink": "https://cloud.google.com/spanner/", @@ -9,6 +1262,542 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { + "UpdateInstanceMetadata": { + "description": "Metadata type for the operation returned by\nUpdateInstance.", + "type": "object", + "properties": { + "instance": { + "description": "The desired end state of the update.", + "$ref": "Instance" + }, + "startTime": { + "description": "The time at which UpdateInstance\nrequest was received.", + "format": "google-datetime", + "type": "string" + }, + "cancelTime": { + "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time at which this operation failed or was completed successfully.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "UpdateInstanceMetadata" + }, + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + }, + "id": "ListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object" + }, + "ResultSetMetadata": { + "description": "Metadata about a ResultSet or PartialResultSet.", + "type": "object", + "properties": { + "transaction": { + "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here.", + "$ref": "Transaction" + }, + "rowType": { + "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]", + "$ref": "StructType" + } + }, + "id": "ResultSetMetadata" + }, + "TransactionSelector": { + "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.", + "type": "object", + "properties": { + "singleUse": { + "$ref": "TransactionOptions", + "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query." + }, + "begin": { + "$ref": "TransactionOptions", + "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction." + }, + "id": { + "description": "Execute the read or SQL query in a previously-started transaction.", + "format": "byte", + "type": "string" + } + }, + "id": "TransactionSelector" + }, + "Mutation": { + "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.", + "type": "object", + "properties": { + "insert": { + "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.", + "$ref": "Write" + }, + "insertOrUpdate": { + "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved.", + "$ref": "Write" + }, + "update": { + "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`.", + "$ref": "Write" + }, + "replace": { + "$ref": "Write", + "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`." + }, + "delete": { + "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present.", + "$ref": "Delete" + } + }, + "id": "Mutation" + }, + "KeySet": { + "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.", + "type": "object", + "properties": { + "ranges": { + "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.", + "type": "array", + "items": { + "$ref": "KeyRange" + } + }, + "keys": { + "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.", + "type": "array", + "items": { + "type": "array", + "items": { + "type": "any" + } + } + }, + "all": { + "description": "For convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.", + "type": "boolean" + } + }, + "id": "KeySet" + }, + "GetDatabaseDdlResponse": { + "description": "The response for GetDatabaseDdl.", + "type": "object", + "properties": { + "statements": { + "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "GetDatabaseDdlResponse" + }, + "Database": { + "description": "A Cloud Spanner database.", + "type": "object", + "properties": { + "state": { + "enumDescriptions": [ + "Not specified.", + "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.", + "The database is fully created and ready for use." + ], + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "READY" + ], + "description": "Output only. The current database state.", + "type": "string" + }, + "name": { + "description": "Required. The name of the database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`,\nwhere `\u003cdatabase\u003e` is as specified in the `CREATE DATABASE`\nstatement. This name can be passed to other API methods to\nidentify the database.", + "type": "string" + } + }, + "id": "Database" + }, + "SetIamPolicyRequest": { + "description": "Request message for `SetIamPolicy` method.", + "type": "object", + "properties": { + "policy": { + "$ref": "Policy", + "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them." + } + }, + "id": "SetIamPolicyRequest" + }, + "ListDatabasesResponse": { + "description": "The response for ListDatabases.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.", + "type": "string" + }, + "databases": { + "description": "Databases that matched the request.", + "type": "array", + "items": { + "$ref": "Database" + } + } + }, + "id": "ListDatabasesResponse" + }, + "Instance": { + "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.", + "type": "object", + "properties": { + "displayName": { + "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.", + "type": "string" + }, + "nodeCount": { + "description": "Required. The number of nodes allocated to this instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nSee [the documentation](https://cloud.google.com/spanner/docs/instances#node_count)\nfor more information about nodes.", + "format": "int32", + "type": "integer" + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to filter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e.g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.", + "type": "object" + }, + "config": { + "description": "Required. The name of the instance's configuration. Values are of the form\n`projects/\u003cproject\u003e/instanceConfigs/\u003cconfiguration\u003e`. See\nalso InstanceConfig and\nListInstanceConfigs.", + "type": "string" + }, + "state": { + "enum": [ + "STATE_UNSPECIFIED", + "CREATING", + "READY" + ], + "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.", + "The instance is fully created and ready to do work such as\ncreating databases." + ] + }, + "name": { + "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.", + "type": "string" + } + }, + "id": "Instance" + }, + "RollbackRequest": { + "description": "The request for Rollback.", + "type": "object", + "properties": { + "transactionId": { + "description": "Required. The transaction to roll back.", + "format": "byte", + "type": "string" + } + }, + "id": "RollbackRequest" + }, + "Transaction": { + "description": "A transaction.", + "type": "object", + "properties": { + "readTimestamp": { + "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.\n\nA timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds.\nExample: `\"2014-10-02T15:01:23.045123456Z\"`.", + "format": "google-datetime", + "type": "string" + }, + "id": { + "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.", + "format": "byte", + "type": "string" + } + }, + "id": "Transaction" + }, + "UpdateDatabaseDdlMetadata": { + "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.", + "type": "object", + "properties": { + "statements": { + "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.", + "type": "array", + "items": { + "type": "string" + } + }, + "commitTimestamps": { + "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.", + "type": "array", + "items": { + "format": "google-datetime", + "type": "string" + } + }, + "database": { + "description": "The database being modified.", + "type": "string" + } + }, + "id": "UpdateDatabaseDdlMetadata" + }, + "QueryPlan": { + "description": "Contains an ordered list of nodes appearing in the query plan.", + "type": "object", + "properties": { + "planNodes": { + "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.", + "type": "array", + "items": { + "$ref": "PlanNode" + } + } + }, + "id": "QueryPlan" + }, + "StructType": { + "properties": { + "fields": { + "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nlists, where the order of field values matches the order of\nfields in the StructType. In turn, the order of fields\nmatches the order of columns in a read request, or the order of\nfields in the `SELECT` clause of a query.", + "type": "array", + "items": { + "$ref": "Field" + } + } + }, + "id": "StructType", + "description": "`StructType` defines the fields of a STRUCT type.", + "type": "object" + }, + "Field": { + "description": "Message representing a single field of a struct.", + "type": "object", + "properties": { + "name": { + "description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.", + "type": "string" + }, + "type": { + "description": "The type of the field.", + "$ref": "Type" + } + }, + "id": "Field" + }, + "TestIamPermissionsRequest": { + "description": "Request message for `TestIamPermissions` method.", + "type": "object", + "properties": { + "permissions": { + "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "TestIamPermissionsRequest" + }, + "ResultSetStats": { + "properties": { + "queryPlan": { + "$ref": "QueryPlan", + "description": "QueryPlan for the query associated with this result." + }, + "queryStats": { + "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }", + "type": "object", + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + } + } + }, + "id": "ResultSetStats", + "description": "Additional statistics about a ResultSet or PartialResultSet.", + "type": "object" + }, + "CommitResponse": { + "description": "The response for Commit.", + "type": "object", + "properties": { + "commitTimestamp": { + "description": "The Cloud Spanner timestamp at which the transaction committed.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "CommitResponse" + }, + "Type": { + "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.", + "type": "object", + "properties": { + "arrayElementType": { + "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements.", + "$ref": "Type" + }, + "code": { + "description": "Required. The TypeCode for this type.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "Encoded as JSON `true` or `false`.", + "Encoded as `string`, in decimal format.", + "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.", + "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.", + "Encoded as `string` in RFC 3339 date format.", + "Encoded as `string`.", + "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.", + "Encoded as `list`, where the list elements are represented\naccording to array_element_type.", + "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]." + ], + "enum": [ + "TYPE_CODE_UNSPECIFIED", + "BOOL", + "INT64", + "FLOAT64", + "TIMESTAMP", + "DATE", + "STRING", + "BYTES", + "ARRAY", + "STRUCT" + ] + }, + "structType": { + "$ref": "StructType", + "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields." + } + }, + "id": "Type" + }, + "PlanNode": { + "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.", + "type": "object", + "properties": { + "metadata": { + "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }", + "type": "object", + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + } + }, + "executionStats": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.", + "type": "object" + }, + "shortRepresentation": { + "description": "Condensed representation for SCALAR nodes.", + "$ref": "ShortRepresentation" + }, + "index": { + "description": "The `PlanNode`'s index in node list.", + "format": "int32", + "type": "integer" + }, + "displayName": { + "description": "The display name for the node.", + "type": "string" + }, + "kind": { + "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.", + "type": "string", + "enumDescriptions": [ + "Not specified.", + "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.", + "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names." + ], + "enum": [ + "KIND_UNSPECIFIED", + "RELATIONAL", + "SCALAR" + ] + }, + "childLinks": { + "description": "List of child node `index`es and their relationship to this parent.", + "type": "array", + "items": { + "$ref": "ChildLink" + } + } + }, + "id": "PlanNode" + }, + "CreateInstanceMetadata": { + "description": "Metadata type for the operation returned by\nCreateInstance.", + "type": "object", + "properties": { + "cancelTime": { + "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.", + "format": "google-datetime", + "type": "string" + }, + "endTime": { + "description": "The time at which this operation failed or was completed successfully.", + "format": "google-datetime", + "type": "string" + }, + "instance": { + "$ref": "Instance", + "description": "The instance being created." + }, + "startTime": { + "description": "The time at which the\nCreateInstance request was\nreceived.", + "format": "google-datetime", + "type": "string" + } + }, + "id": "CreateInstanceMetadata" + }, + "ChildLink": { + "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.", + "type": "object", + "properties": { + "type": { + "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.", + "type": "string" + }, + "childIndex": { + "description": "The node to which the link points.", + "format": "int32", + "type": "integer" + }, + "variable": { + "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.", + "type": "string" + } + }, + "id": "ChildLink" + }, "Delete": { "description": "Arguments to delete operations.", "type": "object", @@ -29,8 +1818,8 @@ "type": "object", "properties": { "singleUseTransaction": { - "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead.", - "$ref": "TransactionOptions" + "$ref": "TransactionOptions", + "description": "Execute mutations in a temporary transaction. Note that unlike\ncommit of a previously-started transaction, commit with a\ntemporary transaction is non-idempotent. That is, if the\n`CommitRequest` is sent to Cloud Spanner more than once (for\ninstance, due to retries in the application, or in the\ntransport library), it is possible that the mutations are\nexecuted more than once. If this is undesirable, use\nBeginTransaction and\nCommit instead." }, "mutations": { "description": "The mutations to be executed when this transaction commits. All\nmutations are applied atomically, in the order they appear in\nthis list.", @@ -48,15 +1837,15 @@ "id": "CommitRequest" }, "BeginTransactionRequest": { - "description": "The request for BeginTransaction.", - "type": "object", "properties": { "options": { - "description": "Required. Options for the new transaction.", - "$ref": "TransactionOptions" + "$ref": "TransactionOptions", + "description": "Required. Options for the new transaction." } }, - "id": "BeginTransactionRequest" + "id": "BeginTransactionRequest", + "description": "The request for BeginTransaction.", + "type": "object" }, "ListInstanceConfigsResponse": { "description": "The response for ListInstanceConfigs.", @@ -83,8 +1872,6 @@ "id": "GetIamPolicyRequest" }, "TestIamPermissionsResponse": { - "description": "Response message for `TestIamPermissions` method.", - "type": "object", "properties": { "permissions": { "description": "A subset of `TestPermissionsRequest.permissions` that the caller is\nallowed.", @@ -94,7 +1881,9 @@ } } }, - "id": "TestIamPermissionsResponse" + "id": "TestIamPermissionsResponse", + "description": "Response message for `TestIamPermissions` method.", + "type": "object" }, "CreateDatabaseMetadata": { "description": "Metadata type for the operation returned by\nCreateDatabase.", @@ -126,21 +1915,7 @@ "id": "ListSessionsResponse" }, "Session": { - "description": "A session in the Cloud Spanner API.", - "type": "object", "properties": { - "labels": { - "description": "The labels for the session.\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given session.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "createTime": { - "description": "Output only. The timestamp when the session is created.", - "format": "google-datetime", - "type": "string" - }, "name": { "description": "The name of the session. This is always system-assigned; values provided\nwhen creating a session are ignored.", "type": "string" @@ -149,31 +1924,25 @@ "description": "Output only. The approximate timestamp when the session is last used. It is\ntypically earlier than the actual last use time.", "format": "google-datetime", "type": "string" - } - }, - "id": "Session" - }, - "ListInstancesResponse": { - "description": "The response for ListInstances.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.", - "type": "string" }, - "instances": { - "description": "The list of requested instances.", - "type": "array", - "items": { - "$ref": "Instance" - } + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "The labels for the session.\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given session.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.", + "type": "object" + }, + "createTime": { + "description": "Output only. The timestamp when the session is created.", + "format": "google-datetime", + "type": "string" } }, - "id": "ListInstancesResponse" + "id": "Session", + "description": "A session in the Cloud Spanner API.", + "type": "object" }, "KeyRange": { - "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.", - "type": "object", "properties": { "startClosed": { "description": "If the start is closed, then the range includes all rows whose\nfirst `len(start_closed)` key columns exactly match `start_closed`.", @@ -204,7 +1973,27 @@ } } }, - "id": "KeyRange" + "id": "KeyRange", + "description": "KeyRange represents a range of rows in a table or index.\n\nA range has a start key and an end key. These keys can be open or\nclosed, indicating if the range includes rows with that key.\n\nKeys are represented by lists, where the ith value in the list\ncorresponds to the ith component of the table or index primary key.\nIndividual values are encoded as described here.\n\nFor example, consider the following table definition:\n\n CREATE TABLE UserEvents (\n UserName STRING(MAX),\n EventDate STRING(10)\n ) PRIMARY KEY(UserName, EventDate);\n\nThe following keys name rows in this table:\n\n \"Bob\", \"2014-09-23\"\n\nSince the `UserEvents` table's `PRIMARY KEY` clause names two\ncolumns, each `UserEvents` key has two elements; the first is the\n`UserName`, and the second is the `EventDate`.\n\nKey ranges with multiple components are interpreted\nlexicographically by component using the table or index key's declared\nsort order. For example, the following range returns all events for\nuser `\"Bob\"` that occurred in the year 2015:\n\n \"start_closed\": [\"Bob\", \"2015-01-01\"]\n \"end_closed\": [\"Bob\", \"2015-12-31\"]\n\nStart and end keys can omit trailing key components. This affects the\ninclusion and exclusion of rows that exactly match the provided key\ncomponents: if the key is closed, then rows that exactly match the\nprovided components are included; if the key is open, then rows\nthat exactly match are not included.\n\nFor example, the following range includes all events for `\"Bob\"` that\noccurred during and after the year 2000:\n\n \"start_closed\": [\"Bob\", \"2000-01-01\"]\n \"end_closed\": [\"Bob\"]\n\nThe next example retrieves all events for `\"Bob\"`:\n\n \"start_closed\": [\"Bob\"]\n \"end_closed\": [\"Bob\"]\n\nTo retrieve events before the year 2000:\n\n \"start_closed\": [\"Bob\"]\n \"end_open\": [\"Bob\", \"2000-01-01\"]\n\nThe following range includes all rows in the table:\n\n \"start_closed\": []\n \"end_closed\": []\n\nThis range returns all users whose `UserName` begins with any\ncharacter from A to C:\n\n \"start_closed\": [\"A\"]\n \"end_open\": [\"D\"]\n\nThis range returns all users whose `UserName` begins with B:\n\n \"start_closed\": [\"B\"]\n \"end_open\": [\"C\"]\n\nKey ranges honor column sort order. For example, suppose a table is\ndefined as follows:\n\n CREATE TABLE DescendingSortedTable {\n Key INT64,\n ...\n ) PRIMARY KEY(Key DESC);\n\nThe following range retrieves all rows with key values between 1\nand 100 inclusive:\n\n \"start_closed\": [\"100\"]\n \"end_closed\": [\"1\"]\n\nNote that 100 is passed as the start, and 1 is passed as the end,\nbecause `Key` is a descending column in the schema.", + "type": "object" + }, + "ListInstancesResponse": { + "description": "The response for ListInstances.", + "type": "object", + "properties": { + "instances": { + "description": "The list of requested instances.", + "type": "array", + "items": { + "$ref": "Instance" + } + }, + "nextPageToken": { + "description": "`next_page_token` can be sent in a subsequent\nListInstances call to fetch more\nof the matching instances.", + "type": "string" + } + }, + "id": "ListInstancesResponse" }, "ShortRepresentation": { "description": "Condensed representation of a node and its subtree. Only present for\n`SCALAR` PlanNode(s).", @@ -229,13 +2018,13 @@ "description": "A possible configuration for a Cloud Spanner instance. Configurations\ndefine the geographic placement of nodes and their replication.", "type": "object", "properties": { - "name": { - "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/\u003cproject\u003e/instanceConfigs/a-z*`", - "type": "string" - }, "displayName": { "description": "The name of this instance configuration as it appears in UIs.", "type": "string" + }, + "name": { + "description": "A unique identifier for the instance configuration. Values\nare of the form\n`projects/\u003cproject\u003e/instanceConfigs/a-z*`", + "type": "string" } }, "id": "InstanceConfig" @@ -263,23 +2052,21 @@ "id": "Empty" }, "TransactionOptions": { - "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.", - "type": "object", "properties": { "readWrite": { "$ref": "ReadWrite", "description": "Transaction may write.\n\nAuthorization to begin a read-write transaction requires\n`spanner.databases.beginOrRollbackReadWriteTransaction` permission\non the `session` resource." }, "readOnly": { - "description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource.", - "$ref": "ReadOnly" + "$ref": "ReadOnly", + "description": "Transaction will not write.\n\nAuthorization to begin a read-only transaction requires\n`spanner.databases.beginReadOnlyTransaction` permission\non the `session` resource." } }, - "id": "TransactionOptions" + "id": "TransactionOptions", + "description": "# Transactions\n\n\nEach session can have at most one active transaction at a time. After the\nactive transaction is completed, the session can immediately be\nre-used for the next transaction. It is not necessary to create a\nnew session for each transaction.\n\n# Transaction Modes\n\nCloud Spanner supports two transaction modes:\n\n 1. Locking read-write. This type of transaction is the only way\n to write data into Cloud Spanner. These transactions rely on\n pessimistic locking and, if necessary, two-phase commit.\n Locking read-write transactions may abort, requiring the\n application to retry.\n\n 2. Snapshot read-only. This transaction type provides guaranteed\n consistency across several reads, but does not allow\n writes. Snapshot read-only transactions can be configured to\n read at timestamps in the past. Snapshot read-only\n transactions do not need to be committed.\n\nFor transactions that only read, snapshot read-only transactions\nprovide simpler semantics and are almost always faster. In\nparticular, read-only transactions do not take locks, so they do\nnot conflict with read-write transactions. As a consequence of not\ntaking locks, they also do not abort, so retry loops are not needed.\n\nTransactions may only read/write data in a single database. They\nmay, however, read/write data in different tables within that\ndatabase.\n\n## Locking Read-Write Transactions\n\nLocking transactions may be used to atomically read-modify-write\ndata anywhere in a database. This type of transaction is externally\nconsistent.\n\nClients should attempt to minimize the amount of time a transaction\nis active. Faster transactions commit with higher probability\nand cause less contention. Cloud Spanner attempts to keep read locks\nactive as long as the transaction continues to do reads, and the\ntransaction has not been terminated by\nCommit or\nRollback. Long periods of\ninactivity at the client may cause Cloud Spanner to release a\ntransaction's locks and abort it.\n\nReads performed within a transaction acquire locks on the data\nbeing read. Writes can only be done at commit time, after all reads\nhave been completed.\nConceptually, a read-write transaction consists of zero or more\nreads or SQL queries followed by\nCommit. At any time before\nCommit, the client can send a\nRollback request to abort the\ntransaction.\n\n### Semantics\n\nCloud Spanner can commit the transaction if all read locks it acquired\nare still valid at commit time, and it is able to acquire write\nlocks for all writes. Cloud Spanner can abort the transaction for any\nreason. If a commit attempt returns `ABORTED`, Cloud Spanner guarantees\nthat the transaction has not modified any user data in Cloud Spanner.\n\nUnless the transaction commits, Cloud Spanner makes no guarantees about\nhow long the transaction's locks were held for. It is an error to\nuse Cloud Spanner locks for any sort of mutual exclusion other than\nbetween Cloud Spanner transactions themselves.\n\n### Retrying Aborted Transactions\n\nWhen a transaction aborts, the application can choose to retry the\nwhole transaction again. To maximize the chances of successfully\ncommitting the retry, the client should execute the retry in the\nsame session as the original attempt. The original session's lock\npriority increases with each consecutive abort, meaning that each\nattempt has a slightly better chance of success than the previous.\n\nUnder some circumstances (e.g., many transactions attempting to\nmodify the same row(s)), a transaction can abort many times in a\nshort period before successfully committing. Thus, it is not a good\nidea to cap the number of retries a transaction can attempt;\ninstead, it is better to limit the total amount of wall time spent\nretrying.\n\n### Idle Transactions\n\nA transaction is considered idle if it has no outstanding reads or\nSQL queries and has not started a read or SQL query within the last 10\nseconds. Idle transactions can be aborted by Cloud Spanner so that they\ndon't hold on to locks indefinitely. In that case, the commit will\nfail with error `ABORTED`.\n\nIf this behavior is undesirable, periodically executing a simple\nSQL query in the transaction (e.g., `SELECT 1`) prevents the\ntransaction from becoming idle.\n\n## Snapshot Read-Only Transactions\n\nSnapshot read-only transactions provides a simpler method than\nlocking read-write transactions for doing several consistent\nreads. However, this type of transaction does not support writes.\n\nSnapshot transactions do not take locks. Instead, they work by\nchoosing a Cloud Spanner timestamp, then executing all reads at that\ntimestamp. Since they do not acquire locks, they do not block\nconcurrent read-write transactions.\n\nUnlike locking read-write transactions, snapshot read-only\ntransactions never abort. They can fail if the chosen read\ntimestamp is garbage collected; however, the default garbage\ncollection policy is generous enough that most applications do not\nneed to worry about this in practice.\n\nSnapshot read-only transactions do not need to call\nCommit or\nRollback (and in fact are not\npermitted to do so).\n\nTo execute a snapshot transaction, the client specifies a timestamp\nbound, which tells Cloud Spanner how to choose a read timestamp.\n\nThe types of timestamp bound are:\n\n - Strong (the default).\n - Bounded staleness.\n - Exact staleness.\n\nIf the Cloud Spanner database to be read is geographically distributed,\nstale read-only transactions can execute more quickly than strong\nor read-write transaction, because they are able to execute far\nfrom the leader replica.\n\nEach type of timestamp bound is discussed in detail below.\n\n### Strong\n\nStrong reads are guaranteed to see the effects of all transactions\nthat have committed before the start of the read. Furthermore, all\nrows yielded by a single read are consistent with each other -- if\nany part of the read observes a transaction, all parts of the read\nsee the transaction.\n\nStrong reads are not repeatable: two consecutive strong read-only\ntransactions might return inconsistent results if there are\nconcurrent writes. If consistency across reads is required, the\nreads should be executed within a transaction or at an exact read\ntimestamp.\n\nSee TransactionOptions.ReadOnly.strong.\n\n### Exact Staleness\n\nThese timestamp bounds execute reads at a user-specified\ntimestamp. Reads at a timestamp are guaranteed to see a consistent\nprefix of the global transaction history: they observe\nmodifications done by all transactions with a commit timestamp \u003c=\nthe read timestamp, and observe none of the modifications done by\ntransactions with a larger commit timestamp. They will block until\nall conflicting transactions that may be assigned commit timestamps\n\u003c= the read timestamp have finished.\n\nThe timestamp can either be expressed as an absolute Cloud Spanner commit\ntimestamp or a staleness relative to the current time.\n\nThese modes do not require a \"negotiation phase\" to pick a\ntimestamp. As a result, they execute slightly faster than the\nequivalent boundedly stale concurrency modes. On the other hand,\nboundedly stale reads usually return fresher results.\n\nSee TransactionOptions.ReadOnly.read_timestamp and\nTransactionOptions.ReadOnly.exact_staleness.\n\n### Bounded Staleness\n\nBounded staleness modes allow Cloud Spanner to pick the read timestamp,\nsubject to a user-provided staleness bound. Cloud Spanner chooses the\nnewest timestamp within the staleness bound that allows execution\nof the reads at the closest available replica without blocking.\n\nAll rows yielded are consistent with each other -- if any part of\nthe read observes a transaction, all parts of the read see the\ntransaction. Boundedly stale reads are not repeatable: two stale\nreads, even if they use the same staleness bound, can execute at\ndifferent timestamps and thus return inconsistent results.\n\nBoundedly stale reads execute in two phases: the first phase\nnegotiates a timestamp among all replicas needed to serve the\nread. In the second phase, reads are executed at the negotiated\ntimestamp.\n\nAs a result of the two phase execution, bounded staleness reads are\nusually a little slower than comparable exact staleness\nreads. However, they are typically able to return fresher\nresults, and are more likely to execute at the closest replica.\n\nBecause the timestamp negotiation requires up-front knowledge of\nwhich rows will be read, it can only be used with single-use\nread-only transactions.\n\nSee TransactionOptions.ReadOnly.max_staleness and\nTransactionOptions.ReadOnly.min_read_timestamp.\n\n### Old Read Timestamps and Garbage Collection\n\nCloud Spanner continuously garbage collects deleted and overwritten data\nin the background to reclaim storage space. This process is known\nas \"version GC\". By default, version GC reclaims versions after they\nare one hour old. Because of this, Cloud Spanner cannot perform reads\nat read timestamps more than one hour in the past. This\nrestriction also applies to in-progress reads and/or SQL queries whose\ntimestamp become too old while executing. Reads and SQL queries with\ntoo-old read timestamps fail with the error `FAILED_PRECONDITION`.", + "type": "object" }, "CreateDatabaseRequest": { - "description": "The request for CreateDatabase.", - "type": "object", "properties": { "extraStatements": { "description": "An optional list of DDL statements to run inside the newly created\ndatabase. Statements can create tables, indexes, etc. These\nstatements execute atomically with the creation of the database:\nif there is an error in any statement, the database is not created.", @@ -293,7 +2080,9 @@ "type": "string" } }, - "id": "CreateDatabaseRequest" + "id": "CreateDatabaseRequest", + "description": "The request for CreateDatabase.", + "type": "object" }, "CreateInstanceRequest": { "description": "The request for CreateInstance.", @@ -311,18 +2100,7 @@ "id": "CreateInstanceRequest" }, "ReadOnly": { - "description": "Message type to initiate a read-only transaction.", - "type": "object", "properties": { - "exactStaleness": { - "description": "Executes all reads at a timestamp that is `exact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.", - "format": "google-duration", - "type": "string" - }, - "strong": { - "description": "Read at a timestamp where all previously committed transactions\nare visible.", - "type": "boolean" - }, "minReadTimestamp": { "description": "Executes all reads at a timestamp \u003e= `min_read_timestamp`.\n\nThis is useful for requesting fresher data than some previous\nread, or data that is fresh enough to observe the effects of some\npreviously committed transaction whose timestamp is known.\n\nNote that this option can only be used in single-use transactions.\n\nA timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds.\nExample: `\"2014-10-02T15:01:23.045123456Z\"`.", "format": "google-datetime", @@ -341,14 +2119,31 @@ "returnReadTimestamp": { "description": "If true, the Cloud Spanner-selected read timestamp is included in\nthe Transaction message that describes the transaction.", "type": "boolean" + }, + "exactStaleness": { + "description": "Executes all reads at a timestamp that is `exact_staleness`\nold. The timestamp is chosen soon after the read is started.\n\nGuarantees that all writes that have committed more than the\nspecified number of seconds ago are visible. Because Cloud Spanner\nchooses the exact timestamp, this mode works even if the client's\nlocal clock is substantially skewed from Cloud Spanner commit\ntimestamps.\n\nUseful for reading at nearby replicas without the distributed\ntimestamp negotiation overhead of `max_staleness`.", + "format": "google-duration", + "type": "string" + }, + "strong": { + "description": "Read at a timestamp where all previously committed transactions\nare visible.", + "type": "boolean" } }, - "id": "ReadOnly" + "id": "ReadOnly", + "description": "Message type to initiate a read-only transaction.", + "type": "object" }, "ExecuteSqlRequest": { - "description": "The request for ExecuteSql and\nExecuteStreamingSql.", - "type": "object", "properties": { + "params": { + "additionalProperties": { + "description": "Properties of the object.", + "type": "any" + }, + "description": "The SQL query string can contain parameter placeholders. A parameter\nplaceholder consists of `'@'` followed by the parameter\nname. Parameter names consist of any combination of letters,\nnumbers, and underscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id \u003e @msg_id AND id \u003c @msg_id + 100\"`\n\nIt is an error to execute an SQL query with unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorresponding parameter values.", + "type": "object" + }, "queryMode": { "enumDescriptions": [ "The default mode where only the query result, without any information\nabout the query plan is returned.", @@ -373,26 +2168,20 @@ "type": "string" }, "paramTypes": { + "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.", + "type": "object", "additionalProperties": { "$ref": "Type" - }, - "description": "It is not always possible for Cloud Spanner to infer the right SQL type\nfrom a JSON value. For example, values of type `BYTES` and values\nof type `STRING` both appear in params as JSON strings.\n\nIn these cases, `param_types` can be used to specify the exact\nSQL type for some or all of the SQL query parameters. See the\ndefinition of Type for more information\nabout SQL types.", - "type": "object" + } }, "sql": { "description": "Required. The SQL query string.", "type": "string" - }, - "params": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "The SQL query string can contain parameter placeholders. A parameter\nplaceholder consists of `'@'` followed by the parameter\nname. Parameter names consist of any combination of letters,\nnumbers, and underscores.\n\nParameters can appear anywhere that a literal value is expected. The same\nparameter name can be used more than once, for example:\n `\"WHERE id \u003e @msg_id AND id \u003c @msg_id + 100\"`\n\nIt is an error to execute an SQL query with unbound parameters.\n\nParameter values are specified using `params`, which is a JSON\nobject whose keys are parameter names, and whose values are the\ncorresponding parameter values.", - "type": "object" } }, - "id": "ExecuteSqlRequest" + "id": "ExecuteSqlRequest", + "description": "The request for ExecuteSql and\nExecuteStreamingSql.", + "type": "object" }, "Policy": { "description": "Defines an Identity and Access Management (IAM) policy. It is used to\nspecify access control policies for Cloud Platform resources.\n\n\nA `Policy` consists of a list of `bindings`. A `Binding` binds a list of\n`members` to a `role`, where the members can be user accounts, Google groups,\nGoogle domains, and service accounts. A `role` is a named list of permissions\ndefined by IAM.\n\n**Example**\n\n {\n \"bindings\": [\n {\n \"role\": \"roles/owner\",\n \"members\": [\n \"user:mike@example.com\",\n \"group:admins@example.com\",\n \"domain:google.com\",\n \"serviceAccount:my-other-app@appspot.gserviceaccount.com\",\n ]\n },\n {\n \"role\": \"roles/viewer\",\n \"members\": [\"user:sean@example.com\"]\n }\n ]\n }\n\nFor a description of IAM and its features, see the\n[IAM developer's guide](https://cloud.google.com/iam).", @@ -422,6 +2211,10 @@ "description": "The request for Read and\nStreamingRead.", "type": "object", "properties": { + "table": { + "description": "Required. The name of the table in the database to be read.", + "type": "string" + }, "limit": { "description": "If greater than zero, only the first `limit` rows are yielded. If `limit`\nis zero, the default is no limit.", "format": "int64", @@ -450,10 +2243,6 @@ "description": "If this request is resuming a previously interrupted read,\n`resume_token` should be copied from the last\nPartialResultSet yielded before the interruption. Doing this\nenables the new read to resume where the last read left off. The\nrest of the request parameters must exactly match the request\nthat yielded this token.", "format": "byte", "type": "string" - }, - "table": { - "description": "Required. The name of the table in the database to be read.", - "type": "string" } }, "id": "ReadRequest" @@ -462,10 +2251,6 @@ "description": "Arguments to insert, update, insert_or_update, and\nreplace operations.", "type": "object", "properties": { - "table": { - "description": "Required. The table whose rows will be written.", - "type": "string" - }, "columns": { "description": "The names of the columns in table to be written.\n\nThe list of columns must contain enough columns to allow\nCloud Spanner to derive values for all primary key columns in the\nrow(s) to be modified.", "type": "array", @@ -482,6 +2267,10 @@ "type": "any" } } + }, + "table": { + "description": "Required. The table whose rows will be written.", + "type": "string" } }, "id": "Write" @@ -555,11 +2344,11 @@ "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "type": "object" } } }, @@ -569,13 +2358,9 @@ "description": "Results from Read or\nExecuteSql.", "type": "object", "properties": { - "metadata": { - "description": "Metadata about the result set, such as row type information.", - "$ref": "ResultSetMetadata" - }, "stats": { - "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode.", - "$ref": "ResultSetStats" + "$ref": "ResultSetStats", + "description": "Query plan and execution statistics for the query that produced this\nresult set. These can be requested by setting\nExecuteSqlRequest.query_mode." }, "rows": { "description": "Each element in `rows` is a row whose format is defined by\nmetadata.row_type. The ith element\nin each row matches the ith field in\nmetadata.row_type. Elements are\nencoded based on type as described\nhere.", @@ -586,13 +2371,15 @@ "type": "any" } } + }, + "metadata": { + "$ref": "ResultSetMetadata", + "description": "Metadata about the result set, such as row type information." } }, "id": "ResultSet" }, "Binding": { - "description": "Associates `members` with a `role`.", - "type": "object", "properties": { "members": { "description": "Specifies the identities requesting access for a Cloud Platform resource.\n`members` can have the following values:\n\n* `allUsers`: A special identifier that represents anyone who is\n on the internet; with or without a Google account.\n\n* `allAuthenticatedUsers`: A special identifier that represents anyone\n who is authenticated with a Google account or a service account.\n\n* `user:{emailid}`: An email address that represents a specific Google\n account. For example, `alice@gmail.com` or `joe@example.com`.\n\n\n* `serviceAccount:{emailid}`: An email address that represents a service\n account. For example, `my-other-app@appspot.gserviceaccount.com`.\n\n* `group:{emailid}`: An email address that represents a Google group.\n For example, `admins@example.com`.\n\n\n* `domain:{domain}`: A Google Apps domain name that represents all the\n users of that domain. For example, `google.com` or `example.com`.\n\n", @@ -606,22 +2393,24 @@ "type": "string" } }, - "id": "Binding" + "id": "Binding", + "description": "Associates `members` with a `role`.", + "type": "object" }, "UpdateDatabaseDdlRequest": { "description": "Enqueues the given DDL statements to be applied, in order but not\nnecessarily all at once, to the database schema at some point (or\npoints) in the future. The server checks that the statements\nare executable (syntactically valid, name tables that exist, etc.)\nbefore enqueueing them, but they may still fail upon\nlater execution (e.g., if a statement from another batch of\nstatements is applied first and it conflicts in some way, or if\nthere is some data-related problem like a `NULL` value in a column to\nwhich `NOT NULL` would be added). If a statement fails, all\nsubsequent statements in the batch are automatically cancelled.\n\nEach batch of statements is assigned a name which can be used with\nthe Operations API to monitor\nprogress. See the\noperation_id field for more\ndetails.", "type": "object", "properties": { - "operationId": { - "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `\u003cdatabase\u003e/operations/\u003coperation_id\u003e`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.", - "type": "string" - }, "statements": { "description": "DDL statements to be applied to the database.", "type": "array", "items": { "type": "string" } + }, + "operationId": { + "description": "If empty, the new update request is assigned an\nautomatically-generated operation ID. Otherwise, `operation_id`\nis used to construct the name of the resulting\nOperation.\n\nSpecifying an explicit operation ID simplifies determining\nwhether the statements were executed in the event that the\nUpdateDatabaseDdl call is replayed,\nor the return value is otherwise lost: the database and\n`operation_id` fields can be combined to form the\nname of the resulting\nlongrunning.Operation: `\u003cdatabase\u003e/operations/\u003coperation_id\u003e`.\n\n`operation_id` should be unique within the database, and must be\na valid identifier: `a-z*`. Note that\nautomatically-generated operation IDs always begin with an\nunderscore. If the named operation already exists,\nUpdateDatabaseDdl returns\n`ALREADY_EXISTS`.", + "type": "string" } }, "id": "UpdateDatabaseDdlRequest" @@ -630,17 +2419,22 @@ "description": "Partial results from a streaming read or SQL query. Streaming reads and\nSQL queries better tolerate large result sets, large rows, and large\nvalues, but are a little trickier to consume.", "type": "object", "properties": { + "resumeToken": { + "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.", + "format": "byte", + "type": "string" + }, "stats": { - "$ref": "ResultSetStats", - "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream." + "description": "Query plan and execution statistics for the query that produced this\nstreaming result set. These can be requested by setting\nExecuteSqlRequest.query_mode and are sent\nonly once with the last response in the stream.", + "$ref": "ResultSetStats" }, "chunkedValue": { "description": "If true, then the final value in values is chunked, and must\nbe combined with more values from subsequent `PartialResultSet`s\nto obtain a complete field value.", "type": "boolean" }, "metadata": { - "$ref": "ResultSetMetadata", - "description": "Metadata about the result set, such as row type information.\nOnly present in the first response." + "description": "Metadata about the result set, such as row type information.\nOnly present in the first response.", + "$ref": "ResultSetMetadata" }, "values": { "description": "A streamed result set consists of a stream of values, which might\nbe split into many `PartialResultSet` messages to accommodate\nlarge rows and/or large values. Every N complete values defines a\nrow, where N is equal to the number of entries in\nmetadata.row_type.fields.\n\nMost values are encoded based on type as described\nhere.\n\nIt is possible that the last value in values is \"chunked\",\nmeaning that the rest of the value is sent in subsequent\n`PartialResultSet`(s). This is denoted by the chunked_value\nfield. Two or more chunked values can be merged to form a\ncomplete value as follows:\n\n * `bool/number/null`: cannot be chunked\n * `string`: concatenate the strings\n * `list`: concatenate the lists. If the last element in a list is a\n `string`, `list`, or `object`, merge it with the first element in\n the next list by applying these rules recursively.\n * `object`: concatenate the (field name, field value) pairs. If a\n field name is duplicated, then apply these rules recursively\n to merge the field values.\n\nSome examples of merging:\n\n # Strings are concatenated.\n \"foo\", \"bar\" =\u003e \"foobar\"\n\n # Lists of non-strings are concatenated.\n [2, 3], [4] =\u003e [2, 3, 4]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are strings.\n [\"a\", \"b\"], [\"c\", \"d\"] =\u003e [\"a\", \"bc\", \"d\"]\n\n # Lists are concatenated, but the last and first elements are merged\n # because they are lists. Recursively, the last and first elements\n # of the inner lists are merged because they are strings.\n [\"a\", [\"b\", \"c\"]], [[\"d\"], \"e\"] =\u003e [\"a\", [\"b\", \"cd\"], \"e\"]\n\n # Non-overlapping object fields are combined.\n {\"a\": \"1\"}, {\"b\": \"2\"} =\u003e {\"a\": \"1\", \"b\": 2\"}\n\n # Overlapping object fields are merged.\n {\"a\": \"1\"}, {\"a\": \"2\"} =\u003e {\"a\": \"12\"}\n\n # Examples of merging objects containing lists of strings.\n {\"a\": [\"1\"]}, {\"a\": [\"2\"]} =\u003e {\"a\": [\"12\"]}\n\nFor a more complete example, suppose a streaming SQL query is\nyielding a result set whose rows contain a single string\nfield. The following `PartialResultSet`s might be yielded:\n\n {\n \"metadata\": { ... }\n \"values\": [\"Hello\", \"W\"]\n \"chunked_value\": true\n \"resume_token\": \"Af65...\"\n }\n {\n \"values\": [\"orl\"]\n \"chunked_value\": true\n \"resume_token\": \"Bqp2...\"\n }\n {\n \"values\": [\"d\"]\n \"resume_token\": \"Zx1B...\"\n }\n\nThis sequence of `PartialResultSet`s encodes two rows, one\ncontaining the field value `\"Hello\"`, and a second containing the\nfield value `\"World\" = \"W\" + \"orl\" + \"d\"`.", @@ -648,557 +2442,16 @@ "items": { "type": "any" } - }, - "resumeToken": { - "description": "Streaming calls might be interrupted for a variety of reasons, such\nas TCP connection loss. If this occurs, the stream of results can\nbe resumed by re-sending the original request and including\n`resume_token`. Note that executing any other transaction in the\nsame session invalidates the token.", - "format": "byte", - "type": "string" } }, "id": "PartialResultSet" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Operation" - } - }, - "nextPageToken": { - "description": "The standard List next-page token.", - "type": "string" - } - }, - "id": "ListOperationsResponse" - }, - "UpdateInstanceMetadata": { - "description": "Metadata type for the operation returned by\nUpdateInstance.", - "type": "object", - "properties": { - "cancelTime": { - "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time at which this operation failed or was completed successfully.", - "format": "google-datetime", - "type": "string" - }, - "instance": { - "$ref": "Instance", - "description": "The desired end state of the update." - }, - "startTime": { - "description": "The time at which UpdateInstance\nrequest was received.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "UpdateInstanceMetadata" - }, - "ResultSetMetadata": { - "description": "Metadata about a ResultSet or PartialResultSet.", - "type": "object", - "properties": { - "transaction": { - "$ref": "Transaction", - "description": "If the read or SQL query began a transaction as a side-effect, the\ninformation about the new transaction is yielded here." - }, - "rowType": { - "description": "Indicates the field names and types for the rows in the result\nset. For example, a SQL query like `\"SELECT UserId, UserName FROM\nUsers\"` could return a `row_type` value like:\n\n \"fields\": [\n { \"name\": \"UserId\", \"type\": { \"code\": \"INT64\" } },\n { \"name\": \"UserName\", \"type\": { \"code\": \"STRING\" } },\n ]", - "$ref": "StructType" - } - }, - "id": "ResultSetMetadata" - }, - "TransactionSelector": { - "description": "This message is used to select the transaction in which a\nRead or\nExecuteSql call runs.\n\nSee TransactionOptions for more information about transactions.", - "type": "object", - "properties": { - "singleUse": { - "description": "Execute the read or SQL query in a temporary transaction.\nThis is the most efficient way to execute a transaction that\nconsists of a single SQL query.", - "$ref": "TransactionOptions" - }, - "begin": { - "$ref": "TransactionOptions", - "description": "Begin a new transaction and execute this read or SQL query in\nit. The transaction ID of the new transaction is returned in\nResultSetMetadata.transaction, which is a Transaction." - }, - "id": { - "description": "Execute the read or SQL query in a previously-started transaction.", - "format": "byte", - "type": "string" - } - }, - "id": "TransactionSelector" - }, - "Mutation": { - "description": "A modification to one or more Cloud Spanner rows. Mutations can be\napplied to a Cloud Spanner database by sending them in a\nCommit call.", - "type": "object", - "properties": { - "insert": { - "description": "Insert new rows in a table. If any of the rows already exist,\nthe write or transaction fails with error `ALREADY_EXISTS`.", - "$ref": "Write" - }, - "insertOrUpdate": { - "description": "Like insert, except that if the row already exists, then\nits column values are overwritten with the ones provided. Any\ncolumn values not explicitly written are preserved.", - "$ref": "Write" - }, - "update": { - "$ref": "Write", - "description": "Update existing rows in a table. If any of the rows does not\nalready exist, the transaction fails with error `NOT_FOUND`." - }, - "replace": { - "$ref": "Write", - "description": "Like insert, except that if the row already exists, it is\ndeleted, and the column values provided are inserted\ninstead. Unlike insert_or_update, this means any values not\nexplicitly written become `NULL`." - }, - "delete": { - "description": "Delete rows from a table. Succeeds whether or not the named\nrows were present.", - "$ref": "Delete" - } - }, - "id": "Mutation" - }, - "KeySet": { - "description": "`KeySet` defines a collection of Cloud Spanner keys and/or key ranges. All\nthe keys are expected to be in the same table or index. The keys need\nnot be sorted in any particular way.\n\nIf the same key is specified multiple times in the set (for example\nif two ranges, two keys, or a key and a range overlap), Cloud Spanner\nbehaves as if the key were only specified once.", - "type": "object", - "properties": { - "ranges": { - "description": "A list of key ranges. See KeyRange for more information about\nkey range specifications.", - "type": "array", - "items": { - "$ref": "KeyRange" - } - }, - "keys": { - "description": "A list of specific keys. Entries in `keys` should have exactly as\nmany elements as there are columns in the primary or index key\nwith which this `KeySet` is used. Individual key values are\nencoded as described here.", - "type": "array", - "items": { - "type": "array", - "items": { - "type": "any" - } - } - }, - "all": { - "description": "For convenience `all` can be set to `true` to indicate that this\n`KeySet` matches all keys in the table or index. Note that any keys\nspecified in `keys` or `ranges` are only yielded once.", - "type": "boolean" - } - }, - "id": "KeySet" - }, - "GetDatabaseDdlResponse": { - "description": "The response for GetDatabaseDdl.", - "type": "object", - "properties": { - "statements": { - "description": "A list of formatted DDL statements defining the schema of the database\nspecified in the request.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "GetDatabaseDdlResponse" - }, - "Database": { - "description": "A Cloud Spanner database.", - "type": "object", - "properties": { - "state": { - "description": "Output only. The current database state.", - "type": "string", - "enumDescriptions": [ - "Not specified.", - "The database is still being created. Operations on the database may fail\nwith `FAILED_PRECONDITION` in this state.", - "The database is fully created and ready for use." - ], - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "READY" - ] - }, - "name": { - "description": "Required. The name of the database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`,\nwhere `\u003cdatabase\u003e` is as specified in the `CREATE DATABASE`\nstatement. This name can be passed to other API methods to\nidentify the database.", - "type": "string" - } - }, - "id": "Database" - }, - "SetIamPolicyRequest": { - "description": "Request message for `SetIamPolicy` method.", - "type": "object", - "properties": { - "policy": { - "description": "REQUIRED: The complete policy to be applied to the `resource`. The size of\nthe policy is limited to a few 10s of KB. An empty policy is a\nvalid policy but certain Cloud Platform services (such as Projects)\nmight reject them.", - "$ref": "Policy" - } - }, - "id": "SetIamPolicyRequest" - }, - "ListDatabasesResponse": { - "description": "The response for ListDatabases.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "`next_page_token` can be sent in a subsequent\nListDatabases call to fetch more\nof the matching databases.", - "type": "string" - }, - "databases": { - "description": "Databases that matched the request.", - "type": "array", - "items": { - "$ref": "Database" - } - } - }, - "id": "ListDatabasesResponse" - }, - "Instance": { - "description": "An isolated set of Cloud Spanner resources on which databases can be hosted.", - "type": "object", - "properties": { - "displayName": { - "description": "Required. The descriptive name for this instance as it appears in UIs.\nMust be unique per project and between 4 and 30 characters in length.", - "type": "string" - }, - "nodeCount": { - "description": "Required. The number of nodes allocated to this instance. This may be zero\nin API responses for instances that are not yet in state `READY`.\n\nSee [the documentation](https://cloud.google.com/spanner/docs/instances#node_count)\nfor more information about nodes.", - "format": "int32", - "type": "integer" - }, - "labels": { - "additionalProperties": { - "type": "string" - }, - "description": "Cloud Labels are a flexible and lightweight mechanism for organizing cloud\nresources into groups that reflect a customer's organizational needs and\ndeployment strategies. Cloud Labels can be used to filter collections of\nresources. They can be used to control how resource metrics are aggregated.\nAnd they can be used as arguments to policy management rules (e.g. route,\nfirewall, load balancing, etc.).\n\n * Label keys must be between 1 and 63 characters long and must conform to\n the following regular expression: `[a-z]([-a-z0-9]*[a-z0-9])?`.\n * Label values must be between 0 and 63 characters long and must conform\n to the regular expression `([a-z]([-a-z0-9]*[a-z0-9])?)?`.\n * No more than 64 labels can be associated with a given resource.\n\nSee https://goo.gl/xmQnxf for more information on and examples of labels.\n\nIf you plan to use labels in your own code, please note that additional\ncharacters may be allowed in the future. And so you are advised to use an\ninternal label representation, such as JSON, which doesn't rely upon\nspecific characters being disallowed. For example, representing labels\nas the string: name + \"_\" + value would prove problematic if we were to\nallow \"_\" in a future release.", - "type": "object" - }, - "config": { - "description": "Required. The name of the instance's configuration. Values are of the form\n`projects/\u003cproject\u003e/instanceConfigs/\u003cconfiguration\u003e`. See\nalso InstanceConfig and\nListInstanceConfigs.", - "type": "string" - }, - "state": { - "enumDescriptions": [ - "Not specified.", - "The instance is still being created. Resources may not be\navailable yet, and operations such as database creation may not\nwork.", - "The instance is fully created and ready to do work such as\ncreating databases." - ], - "enum": [ - "STATE_UNSPECIFIED", - "CREATING", - "READY" - ], - "description": "Output only. The current instance state. For\nCreateInstance, the state must be\neither omitted or set to `CREATING`. For\nUpdateInstance, the state must be\neither omitted or set to `READY`.", - "type": "string" - }, - "name": { - "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.", - "type": "string" - } - }, - "id": "Instance" - }, - "RollbackRequest": { - "description": "The request for Rollback.", - "type": "object", - "properties": { - "transactionId": { - "description": "Required. The transaction to roll back.", - "format": "byte", - "type": "string" - } - }, - "id": "RollbackRequest" - }, - "Transaction": { - "description": "A transaction.", - "type": "object", - "properties": { - "readTimestamp": { - "description": "For snapshot read-only transactions, the read timestamp chosen\nfor the transaction. Not returned by default: see\nTransactionOptions.ReadOnly.return_read_timestamp.\n\nA timestamp in RFC3339 UTC \\\"Zulu\\\" format, accurate to nanoseconds.\nExample: `\"2014-10-02T15:01:23.045123456Z\"`.", - "format": "google-datetime", - "type": "string" - }, - "id": { - "description": "`id` may be used to identify the transaction in subsequent\nRead,\nExecuteSql,\nCommit, or\nRollback calls.\n\nSingle-use read-only transactions do not have IDs, because\nsingle-use transactions do not support multiple requests.", - "format": "byte", - "type": "string" - } - }, - "id": "Transaction" - }, - "UpdateDatabaseDdlMetadata": { - "description": "Metadata type for the operation returned by\nUpdateDatabaseDdl.", - "type": "object", - "properties": { - "commitTimestamps": { - "description": "Reports the commit timestamps of all statements that have\nsucceeded so far, where `commit_timestamps[i]` is the commit\ntimestamp for the statement `statements[i]`.", - "type": "array", - "items": { - "format": "google-datetime", - "type": "string" - } - }, - "database": { - "description": "The database being modified.", - "type": "string" - }, - "statements": { - "description": "For an update this list contains all the statements. For an\nindividual statement, this list contains only that statement.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "UpdateDatabaseDdlMetadata" - }, - "StructType": { - "description": "`StructType` defines the fields of a STRUCT type.", - "type": "object", - "properties": { - "fields": { - "description": "The list of fields that make up this struct. Order is\nsignificant, because values of this struct type are represented as\nlists, where the order of field values matches the order of\nfields in the StructType. In turn, the order of fields\nmatches the order of columns in a read request, or the order of\nfields in the `SELECT` clause of a query.", - "type": "array", - "items": { - "$ref": "Field" - } - } - }, - "id": "StructType" - }, - "QueryPlan": { - "description": "Contains an ordered list of nodes appearing in the query plan.", - "type": "object", - "properties": { - "planNodes": { - "description": "The nodes in the query plan. Plan nodes are returned in pre-order starting\nwith the plan root. Each PlanNode's `id` corresponds to its index in\n`plan_nodes`.", - "type": "array", - "items": { - "$ref": "PlanNode" - } - } - }, - "id": "QueryPlan" - }, - "Field": { - "description": "Message representing a single field of a struct.", - "type": "object", - "properties": { - "type": { - "$ref": "Type", - "description": "The type of the field." - }, - "name": { - "description": "The name of the field. For reads, this is the column name. For\nSQL queries, it is the column alias (e.g., `\"Word\"` in the\nquery `\"SELECT 'hello' AS Word\"`), or the column name (e.g.,\n`\"ColName\"` in the query `\"SELECT ColName FROM Table\"`). Some\ncolumns might have an empty name (e.g., !\"SELECT\nUPPER(ColName)\"`). Note that a query result can contain\nmultiple fields with the same name.", - "type": "string" - } - }, - "id": "Field" - }, - "ResultSetStats": { - "description": "Additional statistics about a ResultSet or PartialResultSet.", - "type": "object", - "properties": { - "queryPlan": { - "$ref": "QueryPlan", - "description": "QueryPlan for the query associated with this result." - }, - "queryStats": { - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - }, - "description": "Aggregated statistics from the execution of the query. Only present when\nthe query is profiled. For example, a query could return the statistics as\nfollows:\n\n {\n \"rows_returned\": \"3\",\n \"elapsed_time\": \"1.22 secs\",\n \"cpu_time\": \"1.19 secs\"\n }", - "type": "object" - } - }, - "id": "ResultSetStats" - }, - "TestIamPermissionsRequest": { - "description": "Request message for `TestIamPermissions` method.", - "type": "object", - "properties": { - "permissions": { - "description": "REQUIRED: The set of permissions to check for 'resource'.\nPermissions with wildcards (such as '*', 'spanner.*', 'spanner.instances.*') are not allowed.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "TestIamPermissionsRequest" - }, - "CommitResponse": { - "description": "The response for Commit.", - "type": "object", - "properties": { - "commitTimestamp": { - "description": "The Cloud Spanner timestamp at which the transaction committed.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "CommitResponse" - }, - "Type": { - "description": "`Type` indicates the type of a Cloud Spanner value, as might be stored in a\ntable cell or returned from an SQL query.", - "type": "object", - "properties": { - "arrayElementType": { - "description": "If code == ARRAY, then `array_element_type`\nis the type of the array elements.", - "$ref": "Type" - }, - "code": { - "enumDescriptions": [ - "Not specified.", - "Encoded as JSON `true` or `false`.", - "Encoded as `string`, in decimal format.", - "Encoded as `number`, or the strings `\"NaN\"`, `\"Infinity\"`, or\n`\"-Infinity\"`.", - "Encoded as `string` in RFC 3339 timestamp format. The time zone\nmust be present, and must be `\"Z\"`.", - "Encoded as `string` in RFC 3339 date format.", - "Encoded as `string`.", - "Encoded as a base64-encoded `string`, as described in RFC 4648,\nsection 4.", - "Encoded as `list`, where the list elements are represented\naccording to array_element_type.", - "Encoded as `list`, where list element `i` is represented according\nto [struct_type.fields[i]][google.spanner.v1.StructType.fields]." - ], - "enum": [ - "TYPE_CODE_UNSPECIFIED", - "BOOL", - "INT64", - "FLOAT64", - "TIMESTAMP", - "DATE", - "STRING", - "BYTES", - "ARRAY", - "STRUCT" - ], - "description": "Required. The TypeCode for this type.", - "type": "string" - }, - "structType": { - "description": "If code == STRUCT, then `struct_type`\nprovides type information for the struct's fields.", - "$ref": "StructType" - } - }, - "id": "Type" - }, - "PlanNode": { - "description": "Node information for nodes appearing in a QueryPlan.plan_nodes.", - "type": "object", - "properties": { - "metadata": { - "description": "Attributes relevant to the node contained in a group of key-value pairs.\nFor example, a Parameter Reference node could have the following\ninformation in its metadata:\n\n {\n \"parameter_reference\": \"param1\",\n \"parameter_type\": \"array\"\n }", - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - } - }, - "executionStats": { - "description": "The execution statistics associated with the node, contained in a group of\nkey-value pairs. Only present if the plan was returned as a result of a\nprofile query. For example, number of executions, number of rows/time per\nexecution etc.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object.", - "type": "any" - } - }, - "shortRepresentation": { - "$ref": "ShortRepresentation", - "description": "Condensed representation for SCALAR nodes." - }, - "index": { - "description": "The `PlanNode`'s index in node list.", - "format": "int32", - "type": "integer" - }, - "kind": { - "description": "Used to determine the type of node. May be needed for visualizing\ndifferent kinds of nodes differently. For example, If the node is a\nSCALAR node, it will have a condensed representation\nwhich can be used to directly embed a description of the node in its\nparent.", - "type": "string", - "enumDescriptions": [ - "Not specified.", - "Denotes a Relational operator node in the expression tree. Relational\noperators represent iterative processing of rows during query execution.\nFor example, a `TableScan` operation that reads rows from a table.", - "Denotes a Scalar node in the expression tree. Scalar nodes represent\nnon-iterable entities in the query plan. For example, constants or\narithmetic operators appearing inside predicate expressions or references\nto column names." - ], - "enum": [ - "KIND_UNSPECIFIED", - "RELATIONAL", - "SCALAR" - ] - }, - "displayName": { - "description": "The display name for the node.", - "type": "string" - }, - "childLinks": { - "description": "List of child node `index`es and their relationship to this parent.", - "type": "array", - "items": { - "$ref": "ChildLink" - } - } - }, - "id": "PlanNode" - }, - "CreateInstanceMetadata": { - "description": "Metadata type for the operation returned by\nCreateInstance.", - "type": "object", - "properties": { - "cancelTime": { - "description": "The time at which this operation was cancelled. If set, this operation is\nin the process of undoing itself (which is guaranteed to succeed) and\ncannot be cancelled again.", - "format": "google-datetime", - "type": "string" - }, - "endTime": { - "description": "The time at which this operation failed or was completed successfully.", - "format": "google-datetime", - "type": "string" - }, - "instance": { - "$ref": "Instance", - "description": "The instance being created." - }, - "startTime": { - "description": "The time at which the\nCreateInstance request was\nreceived.", - "format": "google-datetime", - "type": "string" - } - }, - "id": "CreateInstanceMetadata" - }, - "ChildLink": { - "description": "Metadata associated with a parent-child relationship appearing in a\nPlanNode.", - "type": "object", - "properties": { - "type": { - "description": "The type of the link. For example, in Hash Joins this could be used to\ndistinguish between the build child and the probe child, or in the case\nof the child being an output variable, to represent the tag associated\nwith the output variable.", - "type": "string" - }, - "childIndex": { - "description": "The node to which the link points.", - "format": "int32", - "type": "integer" - }, - "variable": { - "description": "Only present if the child node is SCALAR and corresponds\nto an output variable of the parent node. The field carries the name of\nthe output variable.\nFor example, a `TableScan` operator that reads rows from a table will\nhave child links to the `SCALAR` nodes representing the output variables\ncreated for each column that is read by the operator. The corresponding\n`variable` fields will be set to the variable names assigned to the\ncolumns.", - "type": "string" - } - }, - "id": "ChildLink" } }, - "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, + "protocol": "rest", "canonicalName": "Spanner", "auth": { "oauth2": { @@ -1219,1258 +2472,5 @@ "ownerDomain": "google.com", "name": "spanner", "batchPath": "batch", - "title": "Cloud Spanner API", - "ownerName": "Google", - "resources": { - "projects": { - "resources": { - "instances": { - "methods": { - "getIamPolicy": { - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for an instance resource. Returns an empty\npolicy if an instance exists but does not have a policy set.\n\nAuthorization requires `spanner.instances.getIamPolicy` on\nresource.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "spanner.projects.instances.getIamPolicy" - }, - "get": { - "description": "Gets information about a particular instance.", - "response": { - "$ref": "Instance" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "name": { - "description": "Required. The name of the requested instance. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}", - "path": "v1/{+name}", - "id": "spanner.projects.instances.get" - }, - "patch": { - "request": { - "$ref": "UpdateInstanceRequest" - }, - "description": "Updates an instance, and begins allocating or releasing resources\nas requested. The returned long-running\noperation can be used to track the\nprogress of updating the instance. If the named instance does not\nexist, returns `NOT_FOUND`.\n\nImmediately upon completion of this request:\n\n * For resource types for which a decrease in the instance's allocation\n has been requested, billing is based on the newly-requested level.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation sets its metadata's\n cancel_time, and begins\n restoring resources to their pre-request values. The operation\n is guaranteed to succeed at undoing all resource changes,\n after which point it terminates with a `CANCELLED` status.\n * All other attempts to modify the instance are rejected.\n * Reading the instance via the API continues to give the pre-request\n resource levels.\n\nUpon completion of the returned operation:\n\n * Billing begins for all successfully-allocated resources (some types\n may have lower than the requested levels).\n * All newly-reserved resources are available for serving the instance's\n tables.\n * The instance's new resource levels are readable via the API.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track the instance modification. The\nmetadata field type is\nUpdateInstanceMetadata.\nThe response field type is\nInstance, if successful.\n\nAuthorization requires `spanner.instances.update` permission on\nresource name.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "name": { - "location": "path", - "description": "Required. A unique identifier for the instance, which cannot be changed\nafter the instance is created. Values are of the form\n`projects/\u003cproject\u003e/instances/a-z*[a-z0-9]`. The final\nsegment of the name must be between 6 and 30 characters in length.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}", - "path": "v1/{+name}", - "id": "spanner.projects.instances.patch" - }, - "testIamPermissions": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "spanner.projects.instances.testIamPermissions", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "description": "Returns permissions that the caller has on the specified instance resource.\n\nAttempting this RPC on a non-existent Cloud Spanner instance resource will\nresult in a NOT_FOUND error if the user has `spanner.instances.list`\npermission on the containing Google Cloud Project. Otherwise returns an\nempty set of permissions.", - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ] - }, - "delete": { - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the instance to be deleted. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e`", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}", - "id": "spanner.projects.instances.delete", - "path": "v1/{+name}", - "description": "Deletes an instance.\n\nImmediately upon completion of the request:\n\n * Billing ceases for all of the instance's reserved resources.\n\nSoon afterward:\n\n * The instance and *all of its databases* immediately and\n irrevocably disappear from the API. All data in the databases\n is permanently deleted." - }, - "list": { - "description": "Lists all instances in the given project.", - "response": { - "$ref": "ListInstancesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageSize": { - "location": "query", - "description": "Number of instances to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Required. The name of the project for which a list of instances is\nrequested. Values are of the form `projects/\u003cproject\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - }, - "filter": { - "location": "query", - "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `name`\n * `display_name`\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `name:*` --\u003e The instance has a name.\n * `name:Howl` --\u003e The instance's name contains the string \"howl\".\n * `name:HOWL` --\u003e Equivalent to above.\n * `NAME:howl` --\u003e Equivalent to above.\n * `labels.env:*` --\u003e The instance has the label \"env\".\n * `labels.env:dev` --\u003e The instance has the label \"env\" and the value of\n the label contains the string \"dev\".\n * `name:howl labels.env:dev` --\u003e The instance's name contains \"howl\" and\n it has the label \"env\" with its value\n containing \"dev\".", - "type": "string" - }, - "pageToken": { - "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListInstancesResponse.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances", - "path": "v1/{+parent}/instances", - "id": "spanner.projects.instances.list" - }, - "create": { - "request": { - "$ref": "CreateInstanceRequest" - }, - "description": "Creates an instance and begins preparing it to begin serving. The\nreturned long-running operation\ncan be used to track the progress of preparing the new\ninstance. The instance name is assigned by the caller. If the\nnamed instance already exists, `CreateInstance` returns\n`ALREADY_EXISTS`.\n\nImmediately upon completion of this request:\n\n * The instance is readable via the API, with all requested attributes\n but no allocated resources. Its state is `CREATING`.\n\nUntil completion of the returned operation:\n\n * Cancelling the operation renders the instance immediately unreadable\n via the API.\n * The instance can be deleted.\n * All other attempts to modify the instance are rejected.\n\nUpon completion of the returned operation:\n\n * Billing for all successfully-allocated resources begins (some types\n may have lower than the requested levels).\n * Databases can be created in the instance.\n * The instance's allocated resource levels are readable via the API.\n * The instance's state becomes `READY`.\n\nThe returned long-running operation will\nhave a name of the format `\u003cinstance_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track creation of the instance. The\nmetadata field type is\nCreateInstanceMetadata.\nThe response field type is\nInstance, if successful.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "parameters": { - "parent": { - "description": "Required. The name of the project in which to create the instance. Values\nare of the form `projects/\u003cproject\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances", - "path": "v1/{+parent}/instances", - "id": "spanner.projects.instances.create" - }, - "setIamPolicy": { - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on an instance resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.instances.setIamPolicy` on\nresource.", - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "spanner.projects.instances.setIamPolicy" - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "spanner.projects.instances.operations.cancel" - }, - "delete": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}", - "path": "v1/{+name}", - "id": "spanner.projects.instances.operations.delete", - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ] - }, - "list": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations", - "id": "spanner.projects.instances.operations.list", - "path": "v1/{+name}", - "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", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "ListOperationsResponse" - }, - "parameters": { - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, - "name": { - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/operations$", - "location": "path" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ] - }, - "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", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/operations/{operationsId}", - "id": "spanner.projects.instances.operations.get", - "path": "v1/{+name}" - } - } - }, - "databases": { - "methods": { - "list": { - "description": "Lists Cloud Spanner databases.", - "response": { - "$ref": "ListDatabasesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "Number of databases to be returned in the response. If 0 or less,\ndefaults to the server's maximum allowed page size.", - "format": "int32", - "type": "integer" - }, - "parent": { - "description": "Required. The instance whose databases should be listed.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$", - "location": "path" - }, - "pageToken": { - "description": "If non-empty, `page_token` should contain a\nnext_page_token from a\nprevious ListDatabasesResponse.", - "type": "string", - "location": "query" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", - "path": "v1/{+parent}/databases", - "id": "spanner.projects.instances.databases.list" - }, - "setIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The Cloud Spanner resource for which the policy is being set. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for databases resources.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:setIamPolicy", - "path": "v1/{+resource}:setIamPolicy", - "id": "spanner.projects.instances.databases.setIamPolicy", - "request": { - "$ref": "SetIamPolicyRequest" - }, - "description": "Sets the access control policy on a database resource. Replaces any\nexisting policy.\n\nAuthorization requires `spanner.databases.setIamPolicy` permission on\nresource." - }, - "create": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "parent": { - "description": "Required. The name of the instance that will serve the new database.\nValues are of the form `projects/\u003cproject\u003e/instances/\u003cinstance\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases", - "path": "v1/{+parent}/databases", - "id": "spanner.projects.instances.databases.create", - "description": "Creates a new Cloud Spanner database and starts to prepare it for serving.\nThe returned long-running operation will\nhave a name of the format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and\ncan be used to track preparation of the database. The\nmetadata field type is\nCreateDatabaseMetadata. The\nresponse field type is\nDatabase, if successful.", - "request": { - "$ref": "CreateDatabaseRequest" - } - }, - "getIamPolicy": { - "response": { - "$ref": "Policy" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The Cloud Spanner resource for which the policy is being retrieved. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:getIamPolicy", - "path": "v1/{+resource}:getIamPolicy", - "id": "spanner.projects.instances.databases.getIamPolicy", - "request": { - "$ref": "GetIamPolicyRequest" - }, - "description": "Gets the access control policy for a database resource. Returns an empty\npolicy if a database exists but does not have a policy set.\n\nAuthorization requires `spanner.databases.getIamPolicy` permission on\nresource." - }, - "get": { - "description": "Gets the state of a Cloud Spanner database.", - "response": { - "$ref": "Database" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the requested database. Values are of the form\n`projects/\u003cproject\u003e/instances/\u003cinstance\u003e/databases/\u003cdatabase\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}", - "path": "v1/{+name}", - "id": "spanner.projects.instances.databases.get" - }, - "dropDatabase": { - "description": "Drops (aka deletes) a Cloud Spanner database.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "database": { - "location": "path", - "description": "Required. The database to be dropped.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}", - "path": "v1/{+database}", - "id": "spanner.projects.instances.databases.dropDatabase" - }, - "updateDdl": { - "request": { - "$ref": "UpdateDatabaseDdlRequest" - }, - "description": "Updates the schema of a Cloud Spanner database by\ncreating/altering/dropping tables, columns, indexes, etc. The returned\nlong-running operation will have a name of\nthe format `\u003cdatabase_name\u003e/operations/\u003coperation_id\u003e` and can be used to\ntrack execution of the schema change(s). The\nmetadata field type is\nUpdateDatabaseDdlMetadata. The operation has no response.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "PATCH", - "parameters": { - "database": { - "location": "path", - "description": "Required. The database to update.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl", - "path": "v1/{+database}/ddl", - "id": "spanner.projects.instances.databases.updateDdl" - }, - "testIamPermissions": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}:testIamPermissions", - "path": "v1/{+resource}:testIamPermissions", - "id": "spanner.projects.instances.databases.testIamPermissions", - "description": "Returns permissions that the caller has on the specified database resource.\n\nAttempting this RPC on a non-existent Cloud Spanner database will result in\na NOT_FOUND error if the user has `spanner.databases.list` permission on\nthe containing Cloud Spanner instance. Otherwise returns an empty set of\npermissions.", - "request": { - "$ref": "TestIamPermissionsRequest" - }, - "response": { - "$ref": "TestIamPermissionsResponse" - }, - "parameterOrder": [ - "resource" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "resource": { - "location": "path", - "description": "REQUIRED: The Cloud Spanner resource for which permissions are being tested. The format is `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e` for instance resources and `projects/\u003cproject ID\u003e/instances/\u003cinstance ID\u003e/databases/\u003cdatabase ID\u003e` for database resources.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - } - }, - "getDdl": { - "description": "Returns the schema of a Cloud Spanner database as a list of formatted\nDDL statements. This method does not show pending schema updates, those may\nbe queried using the Operations API.", - "response": { - "$ref": "GetDatabaseDdlResponse" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "GET", - "parameters": { - "database": { - "description": "Required. The database whose schema we wish to get.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/ddl", - "path": "v1/{+database}/ddl", - "id": "spanner.projects.instances.databases.getDdl" - } - }, - "resources": { - "operations": { - "methods": { - "cancel": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "spanner.projects.instances.databases.operations.cancel", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ] - }, - "delete": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}", - "id": "spanner.projects.instances.databases.operations.delete", - "path": "v1/{+name}", - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", - "httpMethod": "DELETE", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ] - }, - "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.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, - "name": { - "location": "path", - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations$" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations", - "path": "v1/{+name}", - "id": "spanner.projects.instances.databases.operations.list" - }, - "get": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/operations/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/operations/{operationsId}", - "path": "v1/{+name}", - "id": "spanner.projects.instances.databases.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." - } - } - }, - "sessions": { - "methods": { - "get": { - "description": "Gets a session. Returns `NOT_FOUND` if the session does not exist.\nThis is mainly useful for determining whether a session is still\nalive.", - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Session" - }, - "parameters": { - "name": { - "description": "Required. The name of the session to retrieve.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}", - "id": "spanner.projects.instances.databases.sessions.get", - "path": "v1/{+name}" - }, - "commit": { - "response": { - "$ref": "CommitResponse" - }, - "parameterOrder": [ - "session" - ], - "httpMethod": "POST", - "parameters": { - "session": { - "location": "path", - "description": "Required. The session in which the transaction to be committed is running.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:commit", - "path": "v1/{+session}:commit", - "id": "spanner.projects.instances.databases.sessions.commit", - "request": { - "$ref": "CommitRequest" - }, - "description": "Commits a transaction. The request includes the mutations to be\napplied to rows in the database.\n\n`Commit` might return an `ABORTED` error. This can occur at any time;\ncommonly, the cause is conflicts with concurrent\ntransactions. However, it can also happen for a variety of other\nreasons. If `Commit` returns `ABORTED`, the caller should re-attempt\nthe transaction from the beginning, re-using the same session." - }, - "beginTransaction": { - "request": { - "$ref": "BeginTransactionRequest" - }, - "description": "Begins a new transaction. This step can often be skipped:\nRead, ExecuteSql and\nCommit can begin a new transaction as a\nside-effect.", - "httpMethod": "POST", - "parameterOrder": [ - "session" - ], - "response": { - "$ref": "Transaction" - }, - "parameters": { - "session": { - "description": "Required. The session in which the transaction runs.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:beginTransaction", - "id": "spanner.projects.instances.databases.sessions.beginTransaction", - "path": "v1/{+session}:beginTransaction" - }, - "executeStreamingSql": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeStreamingSql", - "path": "v1/{+session}:executeStreamingSql", - "id": "spanner.projects.instances.databases.sessions.executeStreamingSql", - "request": { - "$ref": "ExecuteSqlRequest" - }, - "description": "Like ExecuteSql, except returns the result\nset as a stream. Unlike ExecuteSql, there\nis no limit on the size of the returned result set. However, no\nindividual row in the result set can exceed 100 MiB, and no\ncolumn value can exceed 10 MiB.", - "response": { - "$ref": "PartialResultSet" - }, - "parameterOrder": [ - "session" - ], - "httpMethod": "POST", - "parameters": { - "session": { - "description": "Required. The session in which the SQL query should be performed.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ] - }, - "delete": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}", - "path": "v1/{+name}", - "id": "spanner.projects.instances.databases.sessions.delete", - "description": "Ends a session, releasing server resources associated with it.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "Required. The name of the session to delete.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ] - }, - "executeSql": { - "response": { - "$ref": "ResultSet" - }, - "parameterOrder": [ - "session" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "parameters": { - "session": { - "description": "Required. The session in which the SQL query should be performed.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:executeSql", - "path": "v1/{+session}:executeSql", - "id": "spanner.projects.instances.databases.sessions.executeSql", - "description": "Executes an SQL query, returning all rows in a single reply. This\nmethod cannot be used to return a result set larger than 10 MiB;\nif the query yields more data than that, the query fails with\na `FAILED_PRECONDITION` error.\n\nQueries inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be fetched in streaming fashion by calling\nExecuteStreamingSql instead.", - "request": { - "$ref": "ExecuteSqlRequest" - } - }, - "list": { - "description": "Lists all sessions in a given database.", - "httpMethod": "GET", - "parameterOrder": [ - "database" - ], - "response": { - "$ref": "ListSessionsResponse" - }, - "parameters": { - "filter": { - "location": "query", - "description": "An expression for filtering the results of the request. Filter rules are\ncase insensitive. The fields eligible for filtering are:\n\n * `labels.key` where key is the name of a label\n\nSome examples of using filters are:\n\n * `labels.env:*` --\u003e The session has the label \"env\".\n * `labels.env:dev` --\u003e The session has the label \"env\" and the value of\n the label contains the string \"dev\".", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "If non-empty, `page_token` should contain a\nnext_page_token from a previous\nListSessionsResponse.", - "type": "string" - }, - "pageSize": { - "location": "query", - "description": "Number of sessions to be returned in the response. If 0 or less, defaults\nto the server's maximum allowed page size.", - "format": "int32", - "type": "integer" - }, - "database": { - "location": "path", - "description": "Required. The database in which to list sessions.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions", - "id": "spanner.projects.instances.databases.sessions.list", - "path": "v1/{+database}/sessions" - }, - "streamingRead": { - "httpMethod": "POST", - "parameterOrder": [ - "session" - ], - "response": { - "$ref": "PartialResultSet" - }, - "parameters": { - "session": { - "description": "Required. The session in which the read should be performed.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:streamingRead", - "id": "spanner.projects.instances.databases.sessions.streamingRead", - "path": "v1/{+session}:streamingRead", - "request": { - "$ref": "ReadRequest" - }, - "description": "Like Read, except returns the result set as a\nstream. Unlike Read, there is no limit on the\nsize of the returned result set. However, no individual row in\nthe result set can exceed 100 MiB, and no column value can exceed\n10 MiB." - }, - "rollback": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "session" - ], - "httpMethod": "POST", - "parameters": { - "session": { - "description": "Required. The session in which the transaction to roll back is running.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:rollback", - "path": "v1/{+session}:rollback", - "id": "spanner.projects.instances.databases.sessions.rollback", - "request": { - "$ref": "RollbackRequest" - }, - "description": "Rolls back a transaction, releasing any locks it holds. It is a good\nidea to call this for any transaction that includes one or more\nRead or ExecuteSql requests and\nultimately decides not to commit.\n\n`Rollback` returns `OK` if it successfully aborts the transaction, the\ntransaction was already aborted, or the transaction is not\nfound. `Rollback` never returns `ABORTED`." - }, - "create": { - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions", - "path": "v1/{+database}/sessions", - "id": "spanner.projects.instances.databases.sessions.create", - "request": { - "$ref": "CreateSessionRequest" - }, - "description": "Creates a new session. A session can be used to perform\ntransactions that read and/or modify data in a Cloud Spanner database.\nSessions are meant to be reused for many consecutive\ntransactions.\n\nSessions can only execute one transaction at a time. To execute\nmultiple concurrent read-write/write-only transactions, create\nmultiple sessions. Note that standalone reads and queries use a\ntransaction internally, and count toward the one transaction\nlimit.\n\nCloud Spanner limits the number of sessions that can exist at any given\ntime; thus, it is a good idea to delete idle and/or unneeded sessions.\nAside from explicit deletes, Cloud Spanner can delete sessions for which no\noperations are sent for more than an hour. If a session is deleted,\nrequests to it return `NOT_FOUND`.\n\nIdle sessions can be kept alive by sending a trivial SQL query\nperiodically, e.g., `\"SELECT 1\"`.", - "response": { - "$ref": "Session" - }, - "parameterOrder": [ - "database" - ], - "httpMethod": "POST", - "parameters": { - "database": { - "description": "Required. The database in which the new session is created.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ] - }, - "read": { - "description": "Reads rows from the database using key lookups and scans, as a\nsimple key/value style alternative to\nExecuteSql. This method cannot be used to\nreturn a result set larger than 10 MiB; if the read matches more\ndata than that, the read fails with a `FAILED_PRECONDITION`\nerror.\n\nReads inside read-write transactions might return `ABORTED`. If\nthis occurs, the application should restart the transaction from\nthe beginning. See Transaction for more details.\n\nLarger result sets can be yielded in streaming fashion by calling\nStreamingRead instead.", - "request": { - "$ref": "ReadRequest" - }, - "response": { - "$ref": "ResultSet" - }, - "parameterOrder": [ - "session" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.data" - ], - "parameters": { - "session": { - "location": "path", - "description": "Required. The session in which the read should be performed.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instances/[^/]+/databases/[^/]+/sessions/[^/]+$" - } - }, - "flatPath": "v1/projects/{projectsId}/instances/{instancesId}/databases/{databasesId}/sessions/{sessionsId}:read", - "path": "v1/{+session}:read", - "id": "spanner.projects.instances.databases.sessions.read" - } - } - } - } - } - } - }, - "instanceConfigs": { - "methods": { - "list": { - "response": { - "$ref": "ListInstanceConfigsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "parameters": { - "pageToken": { - "description": "If non-empty, `page_token` should contain a\nnext_page_token\nfrom a previous ListInstanceConfigsResponse.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "Number of instance configurations to be returned in the response. If 0 or\nless, defaults to the server's maximum allowed page size.", - "format": "int32", - "type": "integer" - }, - "parent": { - "location": "path", - "description": "Required. The name of the project for which a list of supported instance\nconfigurations is requested. Values are of the form\n`projects/\u003cproject\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instanceConfigs", - "path": "v1/{+parent}/instanceConfigs", - "id": "spanner.projects.instanceConfigs.list", - "description": "Lists the supported instance configurations for a given project." - }, - "get": { - "httpMethod": "GET", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "InstanceConfig" - }, - "parameters": { - "name": { - "location": "path", - "description": "Required. The name of the requested instance configuration. Values are of\nthe form `projects/\u003cproject\u003e/instanceConfigs/\u003cconfig\u003e`.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/instanceConfigs/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/spanner.admin" - ], - "flatPath": "v1/projects/{projectsId}/instanceConfigs/{instanceConfigsId}", - "id": "spanner.projects.instanceConfigs.get", - "path": "v1/{+name}", - "description": "Gets information about a particular instance configuration." - } - } - } - } - } - }, - "parameters": { - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - } - }, - "version": "v1", - "baseUrl": "https://spanner.googleapis.com/" + "title": "Cloud Spanner API" }
diff --git a/speech/v1/speech-api.json b/speech/v1/speech-api.json index 6b0577a..afcc898 100644 --- a/speech/v1/speech-api.json +++ b/speech/v1/speech-api.json
@@ -1,32 +1,355 @@ { - "id": "speech:v1", - "documentationLink": "https://cloud.google.com/speech/", + "resources": { + "operations": { + "methods": { + "cancel": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + } + }, + "flatPath": "v1/operations/{operationsId}:cancel", + "path": "v1/operations/{+name}:cancel", + "id": "speech.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "request": { + "$ref": "CancelOperationRequest" + } + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/operations/{operationsId}", + "path": "v1/operations/{+name}", + "id": "speech.operations.delete" + }, + "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.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the operation's parent resource.", + "type": "string", + "location": "query" + }, + "pageToken": { + "location": "query", + "description": "The standard list page token.", + "type": "string" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + }, + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + } + }, + "flatPath": "v1/operations", + "path": "v1/operations", + "id": "speech.operations.list" + }, + "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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/operations/{operationsId}", + "path": "v1/operations/{+name}", + "id": "speech.operations.get" + } + } + }, + "speech": { + "methods": { + "longrunningrecognize": { + "response": { + "$ref": "Operation" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": {}, + "flatPath": "v1/speech:longrunningrecognize", + "path": "v1/speech:longrunningrecognize", + "id": "speech.speech.longrunningrecognize", + "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.", + "request": { + "$ref": "LongRunningRecognizeRequest" + } + }, + "recognize": { + "request": { + "$ref": "RecognizeRequest" + }, + "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed.", + "response": { + "$ref": "RecognizeResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/speech:recognize", + "path": "v1/speech:recognize", + "id": "speech.speech.recognize" + } + } + } + }, + "parameters": { + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "description": "Pretty-print response.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://speech.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Converts audio to text by applying powerful neural network models.", + "servicePath": "", + "basePath": "", "revision": "20180102", + "documentationLink": "https://cloud.google.com/speech/", + "id": "speech:v1", "discoveryVersion": "v1", "version_module": true, "schemas": { - "SpeechRecognitionResult": { + "RecognizeRequest": { "properties": { - "channelTag": { - "description": "For multi-channel audio, this is the channel number corresponding to the\nrecognized result for the audio from that channel.\nFor audio_channel_count = N, its output values can range from '0' to 'N-1'.", - "format": "int32", - "type": "integer" + "config": { + "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.", + "$ref": "RecognitionConfig" }, + "audio": { + "description": "*Required* The audio data to be recognized.", + "$ref": "RecognitionAudio" + } + }, + "id": "RecognizeRequest", + "description": "The top-level message sent by the client for the `Recognize` method.", + "type": "object" + }, + "SpeechContext": { + "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.", + "type": "object", + "properties": { + "phrases": { + "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "SpeechContext" + }, + "SpeechRecognitionAlternative": { + "properties": { + "confidence": { + "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.", + "format": "float", + "type": "number" + }, + "transcript": { + "description": "*Output-only* Transcript text representing the words that the user spoke.", + "type": "string" + }, + "words": { + "description": "*Output-only* A list of word-specific information for each recognized word.", + "type": "array", + "items": { + "$ref": "WordInfo" + } + } + }, + "id": "SpeechRecognitionAlternative", + "description": "Alternative hypotheses (a.k.a. n-best list).", + "type": "object" + }, + "ListOperationsResponse": { + "description": "The response message for Operations.ListOperations.", + "type": "object", + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + }, + "id": "ListOperationsResponse" + }, + "SpeechRecognitionResult": { + "description": "A speech recognition result corresponding to a portion of the audio.", + "type": "object", + "properties": { "alternatives": { "description": "*Output-only* May contain one or more recognition hypotheses (up to the\nmaximum specified in `max_alternatives`).\nThese alternatives are ordered in terms of accuracy, with the top (first)\nalternative being the most probable, as ranked by the recognizer.", "type": "array", "items": { "$ref": "SpeechRecognitionAlternative" } + }, + "channelTag": { + "description": "For multi-channel audio, this is the channel number corresponding to the\nrecognized result for the audio from that channel.\nFor audio_channel_count = N, its output values can range from '0' to 'N-1'.", + "format": "int32", + "type": "integer" } }, - "id": "SpeechRecognitionResult", - "description": "A speech recognition result corresponding to a portion of the audio.", - "type": "object" + "id": "SpeechRecognitionResult" }, "RecognitionAudio": { - "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).", - "type": "object", "properties": { "content": { "description": "The audio data bytes encoded as specified in\n`RecognitionConfig`. Note: as with all bytes fields, protobuffers use a\npure binary representation, whereas JSON representations use base64.", @@ -38,19 +361,21 @@ "type": "string" } }, - "id": "RecognitionAudio" + "id": "RecognitionAudio", + "description": "Contains audio data in the encoding specified in the `RecognitionConfig`.\nEither `content` or `uri` must be supplied. Supplying both or neither\nreturns google.rpc.Code.INVALID_ARGUMENT. See\n[audio limits](https://cloud.google.com/speech/limits#content).", + "type": "object" }, "LongRunningRecognizeRequest": { "description": "The top-level message sent by the client for the `LongRunningRecognize`\nmethod.", "type": "object", "properties": { "config": { - "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.", - "$ref": "RecognitionConfig" + "$ref": "RecognitionConfig", + "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request." }, "audio": { - "$ref": "RecognitionAudio", - "description": "*Required* The audio data to be recognized." + "description": "*Required* The audio data to be recognized.", + "$ref": "RecognitionAudio" } }, "id": "LongRunningRecognizeRequest" @@ -96,8 +421,8 @@ "type": "string" }, "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" }, "metadata": { "additionalProperties": { @@ -136,6 +461,13 @@ "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.", "type": "boolean" }, + "speechContexts": { + "description": "*Optional* A means to provide context to assist the speech recognition.", + "type": "array", + "items": { + "$ref": "SpeechContext" + } + }, "encoding": { "enumDescriptions": [ "Not specified.", @@ -159,20 +491,11 @@ ], "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.", "type": "string" - }, - "speechContexts": { - "description": "*Optional* A means to provide context to assist the speech recognition.", - "type": "array", - "items": { - "$ref": "SpeechContext" - } } }, "id": "RecognitionConfig" }, "WordInfo": { - "description": "Word-specific information for recognized words. Word information is only\nincluded in the response when certain request parameters are set, such\nas `enable_word_time_offsets`.", - "type": "object", "properties": { "startTime": { "description": "*Output-only* Time offset relative to the beginning of the audio,\nand corresponding to the start of the spoken word.\nThis field is only set if `enable_word_time_offsets=true` and only\nin the top hypothesis.\nThis is an experimental feature and the accuracy of the time offset can\nvary.", @@ -189,16 +512,14 @@ "type": "string" } }, - "id": "WordInfo" + "id": "WordInfo", + "description": "Word-specific information for recognized words. Word information is only\nincluded in the response when certain request parameters are set, such\nas `enable_word_time_offsets`.", + "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.", "type": "object", "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 is a common set of\nmessage types for APIs to use.", "type": "array", @@ -214,92 +535,26 @@ "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" } }, "id": "Status" }, "Empty": { - "properties": {}, - "id": "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 `{}`.", - "type": "object" - }, - "RecognizeRequest": { - "description": "The top-level message sent by the client for the `Recognize` method.", "type": "object", - "properties": { - "config": { - "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.", - "$ref": "RecognitionConfig" - }, - "audio": { - "$ref": "RecognitionAudio", - "description": "*Required* The audio data to be recognized." - } - }, - "id": "RecognizeRequest" - }, - "SpeechRecognitionAlternative": { - "description": "Alternative hypotheses (a.k.a. n-best list).", - "type": "object", - "properties": { - "confidence": { - "description": "*Output-only* The confidence estimate between 0.0 and 1.0. A higher number\nindicates an estimated greater likelihood that the recognized words are\ncorrect. This field is typically provided only for the top hypothesis, and\nonly for `is_final=true` results. Clients should not rely on the\n`confidence` field as it is not guaranteed to be accurate, or even set, in\nany of the results.\nThe default of 0.0 is a sentinel value indicating `confidence` was not set.", - "format": "float", - "type": "number" - }, - "transcript": { - "description": "*Output-only* Transcript text representing the words that the user spoke.", - "type": "string" - }, - "words": { - "description": "*Output-only* A list of word-specific information for each recognized word.", - "type": "array", - "items": { - "$ref": "WordInfo" - } - } - }, - "id": "SpeechRecognitionAlternative" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "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.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "id": "ListOperationsResponse" - }, - "SpeechContext": { - "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.", - "type": "object", - "properties": { - "phrases": { - "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "SpeechContext" + "properties": {}, + "id": "Empty" } }, - "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" - }, "protocol": "rest", + "icons": { + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" + }, "canonicalName": "Speech", "auth": { "oauth2": { @@ -315,260 +570,5 @@ "name": "speech", "batchPath": "batch", "title": "Google Cloud Speech API", - "ownerName": "Google", - "resources": { - "operations": { - "methods": { - "cancel": { - "id": "speech.operations.cancel", - "path": "v1/operations/{+name}:cancel", - "request": { - "$ref": "CancelOperationRequest" - }, - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations/{operationsId}:cancel" - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/operations/{operationsId}", - "path": "v1/operations/{+name}", - "id": "speech.operations.delete" - }, - "list": { - "path": "v1/operations", - "id": "speech.operations.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.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - }, - "filter": { - "location": "query", - "description": "The standard list filter.", - "type": "string" - }, - "name": { - "location": "query", - "description": "The name of the operation's parent resource.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - } - }, - "flatPath": "v1/operations" - }, - "get": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^[^/]+$", - "location": "path" - } - }, - "flatPath": "v1/operations/{operationsId}", - "path": "v1/operations/{+name}", - "id": "speech.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." - } - } - }, - "speech": { - "methods": { - "longrunningrecognize": { - "flatPath": "v1/speech:longrunningrecognize", - "id": "speech.speech.longrunningrecognize", - "path": "v1/speech:longrunningrecognize", - "request": { - "$ref": "LongRunningRecognizeRequest" - }, - "description": "Performs asynchronous speech recognition: receive results via the\ngoogle.longrunning.Operations interface. Returns either an\n`Operation.error` or an `Operation.response` which contains\na `LongRunningRecognizeResponse` message.", - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "Operation" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "recognize": { - "response": { - "$ref": "RecognizeResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/speech:recognize", - "path": "v1/speech:recognize", - "id": "speech.speech.recognize", - "request": { - "$ref": "RecognizeRequest" - }, - "description": "Performs synchronous speech recognition: receive results after all audio\nhas been sent and processed." - } - } - } - }, - "parameters": { - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - } - }, - "version": "v1", - "baseUrl": "https://speech.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Converts audio to text by applying powerful neural network models.", - "servicePath": "", - "basePath": "" + "ownerName": "Google" }
diff --git a/speech/v1beta1/speech-api.json b/speech/v1beta1/speech-api.json index d535250..2e4b5fd 100644 --- a/speech/v1beta1/speech-api.json +++ b/speech/v1beta1/speech-api.json
@@ -1,10 +1,153 @@ { - "revision": "20180102", - "documentationLink": "https://cloud.google.com/speech/", - "id": "speech:v1beta1", "discoveryVersion": "v1", "version_module": true, "schemas": { + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "properties": { + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "type": "string" + }, + "error": { + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "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" + } + }, + "id": "Operation" + }, + "RecognitionConfig": { + "description": "Provides information to the recognizer that specifies how to process the\nrequest.", + "type": "object", + "properties": { + "maxAlternatives": { + "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.", + "format": "int32", + "type": "integer" + }, + "sampleRate": { + "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).", + "format": "int32", + "type": "integer" + }, + "languageCode": { + "description": "*Optional* The language of the supplied audio as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.", + "type": "string" + }, + "profanityFilter": { + "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.", + "type": "boolean" + }, + "speechContext": { + "$ref": "SpeechContext", + "description": "*Optional* A means to provide context to assist the speech recognition." + }, + "encoding": { + "enumDescriptions": [ + "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.", + "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nThis is the only encoding that may be used by `AsyncRecognize`.", + "This is the recommended encoding for `SyncRecognize` and\n`StreamingRecognize` because it uses lossless compression; therefore\nrecognition accuracy is not compromised by a lossy codec.\n\nThe stream FLAC (Free Lossless Audio Codec) encoding is specified at:\nhttp://flac.sourceforge.net/documentation.html.\n16-bit and 24-bit samples are supported.\nNot all fields in STREAMINFO are supported.", + "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", + "Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.", + "Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz." + ], + "enum": [ + "ENCODING_UNSPECIFIED", + "LINEAR16", + "FLAC", + "MULAW", + "AMR", + "AMR_WB" + ], + "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.", + "type": "string" + } + }, + "id": "RecognitionConfig" + }, + "SyncRecognizeRequest": { + "description": "The top-level message sent by the client for the `SyncRecognize` method.", + "type": "object", + "properties": { + "config": { + "$ref": "RecognitionConfig", + "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request." + }, + "audio": { + "description": "*Required* The audio data to be recognized.", + "$ref": "RecognitionAudio" + } + }, + "id": "SyncRecognizeRequest" + }, + "SyncRecognizeResponse": { + "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.", + "type": "object", + "properties": { + "results": { + "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.", + "type": "array", + "items": { + "$ref": "SpeechRecognitionResult" + } + } + }, + "id": "SyncRecognizeResponse" + }, + "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.", + "type": "object", + "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" + }, + "details": { + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "type": "object" + } + } + }, + "id": "Status" + }, + "Empty": { + "properties": {}, + "id": "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 `{}`.", + "type": "object" + }, "ListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", @@ -24,6 +167,8 @@ "id": "ListOperationsResponse" }, "SpeechContext": { + "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.", + "type": "object", "properties": { "phrases": { "description": "*Optional* A list of strings containing words and phrases \"hints\" so that\nthe speech recognition is more likely to recognize them. This can be used\nto improve the accuracy for specific words and phrases, for example, if\nspecific commands are typically spoken by the user. This can also be used\nto add additional words to the vocabulary of the recognizer. See\n[usage limits](https://cloud.google.com/speech/limits#content).", @@ -33,9 +178,7 @@ } } }, - "id": "SpeechContext", - "description": "Provides \"hints\" to the speech recognizer to favor specific words and phrases\nin the results.", - "type": "object" + "id": "SpeechContext" }, "SpeechRecognitionAlternative": { "description": "Alternative hypotheses (a.k.a. n-best list).", @@ -97,152 +240,6 @@ } }, "id": "RecognitionAudio" - }, - "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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "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": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", - "type": "string" - } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object" - }, - "RecognitionConfig": { - "description": "Provides information to the recognizer that specifies how to process the\nrequest.", - "type": "object", - "properties": { - "maxAlternatives": { - "description": "*Optional* Maximum number of recognition hypotheses to be returned.\nSpecifically, the maximum number of `SpeechRecognitionAlternative` messages\nwithin each `SpeechRecognitionResult`.\nThe server may return fewer than `max_alternatives`.\nValid values are `0`-`30`. A value of `0` or `1` will return a maximum of\none. If omitted, will return a maximum of one.", - "format": "int32", - "type": "integer" - }, - "sampleRate": { - "description": "*Required* Sample rate in Hertz of the audio data sent in all\n`RecognitionAudio` messages. Valid values are: 8000-48000.\n16000 is optimal. For best results, set the sampling rate of the audio\nsource to 16000 Hz. If that's not possible, use the native sample rate of\nthe audio source (instead of re-sampling).", - "format": "int32", - "type": "integer" - }, - "languageCode": { - "description": "*Optional* The language of the supplied audio as a BCP-47 language tag.\nExample: \"en-GB\" https://www.rfc-editor.org/rfc/bcp/bcp47.txt\nIf omitted, defaults to \"en-US\". See\n[Language Support](https://cloud.google.com/speech/docs/languages)\nfor a list of the currently supported language codes.", - "type": "string" - }, - "profanityFilter": { - "description": "*Optional* If set to `true`, the server will attempt to filter out\nprofanities, replacing all but the initial character in each filtered word\nwith asterisks, e.g. \"f***\". If set to `false` or omitted, profanities\nwon't be filtered out.", - "type": "boolean" - }, - "speechContext": { - "$ref": "SpeechContext", - "description": "*Optional* A means to provide context to assist the speech recognition." - }, - "encoding": { - "enumDescriptions": [ - "Not specified. Will return result google.rpc.Code.INVALID_ARGUMENT.", - "Uncompressed 16-bit signed little-endian samples (Linear PCM).\nThis is the only encoding that may be used by `AsyncRecognize`.", - "This is the recommended encoding for `SyncRecognize` and\n`StreamingRecognize` because it uses lossless compression; therefore\nrecognition accuracy is not compromised by a lossy codec.\n\nThe stream FLAC (Free Lossless Audio Codec) encoding is specified at:\nhttp://flac.sourceforge.net/documentation.html.\n16-bit and 24-bit samples are supported.\nNot all fields in STREAMINFO are supported.", - "8-bit samples that compand 14-bit audio samples using G.711 PCMU/mu-law.", - "Adaptive Multi-Rate Narrowband codec. `sample_rate` must be 8000 Hz.", - "Adaptive Multi-Rate Wideband codec. `sample_rate` must be 16000 Hz." - ], - "enum": [ - "ENCODING_UNSPECIFIED", - "LINEAR16", - "FLAC", - "MULAW", - "AMR", - "AMR_WB" - ], - "description": "*Required* Encoding of audio data sent in all `RecognitionAudio` messages.", - "type": "string" - } - }, - "id": "RecognitionConfig" - }, - "SyncRecognizeRequest": { - "properties": { - "config": { - "description": "*Required* Provides information to the recognizer that specifies how to\nprocess the request.", - "$ref": "RecognitionConfig" - }, - "audio": { - "$ref": "RecognitionAudio", - "description": "*Required* The audio data to be recognized." - } - }, - "id": "SyncRecognizeRequest", - "description": "The top-level message sent by the client for the `SyncRecognize` method.", - "type": "object" - }, - "SyncRecognizeResponse": { - "description": "The only message returned to the client by `SyncRecognize`. method. It\ncontains the result as zero or more sequential `SpeechRecognitionResult`\nmessages.", - "type": "object", - "properties": { - "results": { - "description": "*Output-only* Sequential list of transcription results corresponding to\nsequential portions of audio.", - "type": "array", - "items": { - "$ref": "SpeechRecognitionResult" - } - } - }, - "id": "SyncRecognizeResponse" - }, - "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.", - "type": "object", - "properties": { - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - }, - "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" - } - }, - "id": "Status" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" } }, "icons": { @@ -267,122 +264,6 @@ "title": "Google Cloud Speech API", "ownerName": "Google", "resources": { - "operations": { - "methods": { - "cancel": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^[^/]+$" - } - }, - "flatPath": "v1beta1/operations/{operationsId}:cancel", - "path": "v1beta1/operations/{+name}:cancel", - "id": "speech.operations.cancel", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." - }, - "delete": { - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/operations/{operationsId}", - "path": "v1beta1/operations/{+name}", - "id": "speech.operations.delete" - }, - "list": { - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [], - "httpMethod": "GET", - "parameters": { - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - }, - "name": { - "description": "The name of the operation's parent resource.", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "The standard list page token.", - "type": "string", - "location": "query" - }, - "pageSize": { - "description": "The standard list page size.", - "format": "int32", - "type": "integer", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/operations", - "path": "v1beta1/operations", - "id": "speech.operations.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." - }, - "get": { - "httpMethod": "GET", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1beta1/operations/{operationsId}", - "id": "speech.operations.get", - "path": "v1beta1/operations/{+name}", - "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." - } - } - }, "speech": { "methods": { "asyncrecognize": { @@ -404,6 +285,8 @@ "flatPath": "v1beta1/speech:asyncrecognize" }, "syncrecognize": { + "path": "v1beta1/speech:syncrecognize", + "id": "speech.speech.syncrecognize", "request": { "$ref": "SyncRecognizeRequest" }, @@ -417,78 +300,133 @@ "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], - "flatPath": "v1beta1/speech:syncrecognize", - "path": "v1beta1/speech:syncrecognize", - "id": "speech.speech.syncrecognize" + "flatPath": "v1beta1/speech:syncrecognize" + } + } + }, + "operations": { + "methods": { + "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.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [], + "httpMethod": "GET", + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "type": "string", + "location": "query" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The standard list page size.", + "format": "int32", + "type": "integer" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/operations", + "path": "v1beta1/operations", + "id": "speech.operations.list" + }, + "get": { + "flatPath": "v1beta1/operations/{operationsId}", + "id": "speech.operations.get", + "path": "v1beta1/operations/{+name}", + "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", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the operation resource.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "cancel": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^[^/]+$", + "location": "path" + } + }, + "flatPath": "v1beta1/operations/{operationsId}:cancel", + "path": "v1beta1/operations/{+name}:cancel", + "id": "speech.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." + }, + "delete": { + "path": "v1beta1/operations/{+name}", + "id": "speech.operations.delete", + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "parameters": { + "name": { + "pattern": "^[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1beta1/operations/{operationsId}" } } } }, "parameters": { - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "$.xgafv": { - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "bearer_token": { "location": "query", @@ -506,9 +444,68 @@ "type": "string" }, "prettyPrint": { + "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", - "default": "true", + "default": "true" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "key": { + "location": "query", + "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.", + "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.", + "type": "string", "location": "query" } }, @@ -517,5 +514,8 @@ "servicePath": "", "description": "Converts audio to text by applying powerful neural network models.", "kind": "discovery#restDescription", - "basePath": "" + "basePath": "", + "revision": "20180102", + "documentationLink": "https://cloud.google.com/speech/", + "id": "speech:v1beta1" }
diff --git a/storage/v1beta1/storage-api.json b/storage/v1beta1/storage-api.json index 0749ed3..dd79eb8 100644 --- a/storage/v1beta1/storage-api.json +++ b/storage/v1beta1/storage-api.json
@@ -23,7 +23,7 @@ "basePath": "/storage/v1beta1/", "rootUrl": "https://www.googleapis.com/", "servicePath": "storage/v1beta1/", - "batchPath": "batch/storage/v1beta1", + "batchPath": "batch", "parameters": { "alt": { "type": "string",
diff --git a/storage/v1beta2/storage-api.json b/storage/v1beta2/storage-api.json index 756616b..ce75c97 100644 --- a/storage/v1beta2/storage-api.json +++ b/storage/v1beta2/storage-api.json
@@ -1,11 +1,11 @@ { "kind": "discovery#restDescription", - "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/-kx4VTo0WtGqkEZqxSfkCE_3vyg\"", + "etag": "\"YWOzh2SDasdU84ArJnpYek-OMdg/jNAmDp5ax698Gc_lJBs4IFA1034\"", "discoveryVersion": "v1", "id": "storage:v1beta2", "name": "storage", "version": "v1beta2", - "revision": "20170830", + "revision": "20171212", "title": "Cloud Storage JSON API", "description": "Lets you store and retrieve potentially-large, immutable data objects.", "ownerDomain": "google.com", @@ -23,7 +23,7 @@ "basePath": "/storage/v1beta2/", "rootUrl": "https://www.googleapis.com/", "servicePath": "storage/v1beta2/", - "batchPath": "batch", + "batchPath": "batch/storage/v1beta2", "parameters": { "alt": { "type": "string",
diff --git a/storagetransfer/v1/storagetransfer-api.json b/storagetransfer/v1/storagetransfer-api.json index 20b43dd..1b45f55 100644 --- a/storagetransfer/v1/storagetransfer-api.json +++ b/storagetransfer/v1/storagetransfer-api.json
@@ -1,8 +1,15 @@ { + "kind": "discovery#restDescription", + "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.", + "servicePath": "", + "rootUrl": "https://storagetransfer.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "storagetransfer", "batchPath": "batch", - "id": "storagetransfer:v1", + "revision": "20180104", "documentationLink": "https://cloud.google.com/storage/transfer", - "revision": "20171221", + "id": "storagetransfer:v1", "title": "Google Storage Transfer API", "discoveryVersion": "v1", "ownerName": "Google", @@ -15,48 +22,45 @@ "$ref": "UpdateTransferJobRequest" }, "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.", - "response": { - "$ref": "TransferJob" - }, + "httpMethod": "PATCH", "parameterOrder": [ "jobName" ], - "httpMethod": "PATCH", + "response": { + "$ref": "TransferJob" + }, "parameters": { "jobName": { + "location": "path", "description": "The name of job to update.\nRequired.", "required": true, "type": "string", - "pattern": "^transferJobs/.+$", - "location": "path" + "pattern": "^transferJobs/.+$" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/transferJobs/{transferJobsId}", - "path": "v1/{+jobName}", - "id": "storagetransfer.transferJobs.patch" + "id": "storagetransfer.transferJobs.patch", + "path": "v1/{+jobName}" }, "get": { - "flatPath": "v1/transferJobs/{transferJobsId}", - "id": "storagetransfer.transferJobs.get", - "path": "v1/{+jobName}", "description": "Gets a transfer job.", - "httpMethod": "GET", - "parameterOrder": [ - "jobName" - ], "response": { "$ref": "TransferJob" }, + "parameterOrder": [ + "jobName" + ], + "httpMethod": "GET", "parameters": { "jobName": { + "location": "path", "description": "The job to get.\nRequired.", "required": true, "type": "string", - "pattern": "^transferJobs/.+$", - "location": "path" + "pattern": "^transferJobs/.+$" }, "projectId": { "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.", @@ -66,116 +70,67 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1/transferJobs/{transferJobsId}", + "path": "v1/{+jobName}", + "id": "storagetransfer.transferJobs.get" }, "list": { + "description": "Lists transfer jobs.", + "httpMethod": "GET", + "parameterOrder": [], "response": { "$ref": "ListTransferJobsResponse" }, - "parameterOrder": [], - "httpMethod": "GET", "parameters": { - "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`.", - "type": "string", - "location": "query" - }, - "pageToken": { - "description": "The list page token.", - "type": "string", - "location": "query" - }, "pageSize": { "location": "query", "description": "The list page size. The max allowed value is 256.", "format": "int32", "type": "integer" + }, + "filter": { + "location": "query", + "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`.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The list page token.", + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1/transferJobs", - "path": "v1/transferJobs", "id": "storagetransfer.transferJobs.list", - "description": "Lists transfer jobs." + "path": "v1/transferJobs" }, "create": { - "flatPath": "v1/transferJobs", - "path": "v1/transferJobs", - "id": "storagetransfer.transferJobs.create", + "description": "Creates a transfer job that runs periodically.", "request": { "$ref": "TransferJob" }, - "description": "Creates a transfer job that runs periodically.", "response": { "$ref": "TransferJob" }, "parameterOrder": [], "httpMethod": "POST", - "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "parameters": {}, + "flatPath": "v1/transferJobs", + "path": "v1/transferJobs", + "id": "storagetransfer.transferJobs.create" } } }, "transferOperations": { "methods": { - "resume": { - "httpMethod": "POST", - "parameterOrder": [ - "name" - ], - "response": { - "$ref": "Empty" - }, - "parameters": { - "name": { - "location": "path", - "description": "The name of the transfer operation.\nRequired.", - "required": true, - "type": "string", - "pattern": "^transferOperations/.+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/transferOperations/{transferOperationsId}:resume", - "id": "storagetransfer.transferOperations.resume", - "path": "v1/{+name}:resume", - "request": { - "$ref": "ResumeTransferOperationRequest" - }, - "description": "Resumes a transfer operation that is paused." - }, - "cancel": { - "flatPath": "v1/transferOperations/{transferOperationsId}:cancel", - "path": "v1/{+name}:cancel", - "id": "storagetransfer.transferOperations.cancel", - "description": "Cancels a transfer. Use the get method to check whether the cancellation succeeded or whether the operation completed despite cancellation.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^transferOperations/.+$" - } - }, - "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.", "response": { "$ref": "Operation" }, @@ -197,14 +152,16 @@ ], "flatPath": "v1/transferOperations/{transferOperationsId}", "path": "v1/{+name}", - "id": "storagetransfer.transferOperations.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." + "id": "storagetransfer.transferOperations.get" }, "pause": { - "description": "Pauses a transfer operation.", + "flatPath": "v1/transferOperations/{transferOperationsId}:pause", + "path": "v1/{+name}:pause", + "id": "storagetransfer.transferOperations.pause", "request": { "$ref": "PauseTransferOperationRequest" }, + "description": "Pauses a transfer operation.", "response": { "$ref": "Empty" }, @@ -212,9 +169,6 @@ "name" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { "name": { "location": "path", @@ -224,25 +178,19 @@ "pattern": "^transferOperations/.+$" } }, - "flatPath": "v1/transferOperations/{transferOperationsId}:pause", - "path": "v1/{+name}:pause", - "id": "storagetransfer.transferOperations.pause" + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] }, "delete": { - "flatPath": "v1/transferOperations/{transferOperationsId}", - "path": "v1/{+name}", - "id": "storagetransfer.transferOperations.delete", "description": "This method is not supported and the server returns `UNIMPLEMENTED`.", - "response": { - "$ref": "Empty" - }, + "httpMethod": "DELETE", "parameterOrder": [ "name" ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], + "response": { + "$ref": "Empty" + }, "parameters": { "name": { "description": "The name of the operation resource to be deleted.", @@ -251,7 +199,13 @@ "pattern": "^transferOperations/.+$", "location": "path" } - } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/transferOperations/{transferOperationsId}", + "id": "storagetransfer.transferOperations.delete", + "path": "v1/{+name}" }, "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.", @@ -275,11 +229,11 @@ "type": "string" }, "name": { + "location": "path", "description": "The value `transferOperations`.", "required": true, "type": "string", - "pattern": "^transferOperations$", - "location": "path" + "pattern": "^transferOperations$" }, "pageToken": { "location": "query", @@ -293,12 +247,66 @@ "flatPath": "v1/transferOperations", "path": "v1/{+name}", "id": "storagetransfer.transferOperations.list" + }, + "resume": { + "flatPath": "v1/transferOperations/{transferOperationsId}:resume", + "path": "v1/{+name}:resume", + "id": "storagetransfer.transferOperations.resume", + "request": { + "$ref": "ResumeTransferOperationRequest" + }, + "description": "Resumes a transfer operation that is paused.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name of the transfer operation.\nRequired.", + "required": true, + "type": "string", + "pattern": "^transferOperations/.+$", + "location": "path" + } + }, + "scopes": [ + "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.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string", + "pattern": "^transferOperations/.+$", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1/transferOperations/{transferOperationsId}:cancel", + "path": "v1/{+name}:cancel", + "id": "storagetransfer.transferOperations.cancel" } } }, "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.", "response": { "$ref": "GoogleServiceAccount" }, @@ -311,31 +319,95 @@ ], "parameters": { "projectId": { + "location": "path", "description": "The ID of the Google Cloud Platform Console project that the Google service\naccount is associated with.\nRequired.", "required": true, - "type": "string", - "location": "path" + "type": "string" } }, "flatPath": "v1/googleServiceAccounts/{projectId}", "path": "v1/googleServiceAccounts/{projectId}", - "id": "storagetransfer.googleServiceAccounts.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." + "id": "storagetransfer.googleServiceAccounts.get" } } } }, "parameters": { - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "$.xgafv": { + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ] + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, "bearer_token": { "location": "query", "description": "OAuth bearer token.", "type": "string" }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, "upload_protocol": { "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string", @@ -346,74 +418,296 @@ "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" } }, "schemas": { + "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`.", + "type": "object", + "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" + } + }, + "id": "Date" + }, + "TransferOperation": { + "description": "A description of the execution of a transfer.", + "type": "object", + "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": { + "description": "Transfer specification.\nRequired.", + "$ref": "TransferSpec" + }, + "counters": { + "$ref": "TransferCounters", + "description": "Information about the progress of the transfer operation." + }, + "status": { + "description": "Status of the transfer operation.", + "type": "string", + "enumDescriptions": [ + "Zero is an illegal value.", + "In progress.", + "Paused.", + "Completed successfully.", + "Terminated due to an unrecoverable failure.", + "Aborted by the user." + ], + "enum": [ + "STATUS_UNSPECIFIED", + "IN_PROGRESS", + "PAUSED", + "SUCCESS", + "FAILED", + "ABORTED" + ] + }, + "errorBreakdowns": { + "description": "Summarizes errors encountered with sample error log entries.", + "type": "array", + "items": { + "$ref": "ErrorSummary" + } + }, + "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" + } + }, + "id": "TransferOperation" + }, + "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.", + "type": "object", + "properties": { + "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.", + "$ref": "AwsAccessKey" + }, + "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" + } + }, + "id": "AwsS3Data" + }, + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "AwsAccessKey": { + "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).", + "type": "object", + "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" + } + }, + "id": "AwsAccessKey" + }, + "PauseTransferOperationRequest": { + "description": "Request passed to PauseTransferOperation.", + "type": "object", + "properties": {}, + "id": "PauseTransferOperationRequest" + }, + "TransferCounters": { + "description": "A collection of counters that report the progress of a transfer operation.", + "type": "object", + "properties": { + "bytesFromSourceFailed": { + "description": "Bytes in the data source that failed during the transfer.", + "format": "int64", + "type": "string" + }, + "objectsCopiedToSink": { + "description": "Objects that are copied to the data sink.", + "format": "int64", + "type": "string" + }, + "objectsFromSourceFailed": { + "description": "Objects in the data source that failed during the transfer.", + "format": "int64", + "type": "string" + }, + "bytesFoundOnlyFromSink": { + "description": "Bytes found only in the data sink that are scheduled to be deleted.", + "format": "int64", + "type": "string" + }, + "objectsDeletedFromSource": { + "description": "Objects that are deleted from the data source.", + "format": "int64", + "type": "string" + }, + "bytesCopiedToSink": { + "description": "Bytes that are copied to the data sink.", + "format": "int64", + "type": "string" + }, + "bytesFoundFromSource": { + "description": "Bytes found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.", + "format": "int64", + "type": "string" + }, + "objectsFromSourceSkippedBySync": { + "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.", + "format": "int64", + "type": "string" + }, + "bytesDeletedFromSource": { + "description": "Bytes that are deleted from the data source.", + "format": "int64", + "type": "string" + }, + "objectsFoundFromSource": { + "description": "Objects found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.", + "format": "int64", + "type": "string" + }, + "objectsFailedToDeleteFromSink": { + "description": "Objects that failed to be 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" + }, + "objectsDeletedFromSink": { + "description": "Objects that are deleted from the data sink.", + "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", + "type": "string" + } + }, + "id": "TransferCounters" + }, + "ErrorSummary": { + "description": "A summary of errors by error code, plus a count and sample error log\nentries.", + "type": "object", + "properties": { + "errorCode": { + "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" + ], + "enum": [ + "OK", + "CANCELLED", + "UNKNOWN", + "INVALID_ARGUMENT", + "DEADLINE_EXCEEDED", + "NOT_FOUND", + "ALREADY_EXISTS", + "PERMISSION_DENIED", + "UNAUTHENTICATED", + "RESOURCE_EXHAUSTED", + "FAILED_PRECONDITION", + "ABORTED", + "OUT_OF_RANGE", + "UNIMPLEMENTED", + "INTERNAL", + "UNAVAILABLE", + "DATA_LOSS" + ], + "description": "Required.", + "type": "string" + }, + "errorCount": { + "description": "Count of this type of error.\nRequired.", + "format": "int64", + "type": "string" + }, + "errorLogEntries": { + "description": "Error samples.", + "type": "array", + "items": { + "$ref": "ErrorLogEntry" + } + } + }, + "id": "ErrorSummary" + }, + "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/create-url-list).\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/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\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.", + "type": "object", + "properties": { + "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" + } + }, + "id": "HttpData" + }, "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.", "type": "object", @@ -447,6 +741,10 @@ "description": "Request passed to UpdateTransferJob.", "type": "object", "properties": { + "transferJob": { + "$ref": "TransferJob", + "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired." + }, "projectId": { "description": "The ID of the Google Cloud Platform Console project that owns the job.\nRequired.", "type": "string" @@ -455,10 +753,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": { - "description": "The job to update. `transferJob` is expected to specify only three fields:\n`description`, `transferSpec`, and `status`. An UpdateTransferJobRequest\nthat specifies other fields will be rejected with an error\n`INVALID_ARGUMENT`.\nRequired.", - "$ref": "TransferJob" } }, "id": "UpdateTransferJobRequest" @@ -467,18 +761,6 @@ "description": "Conditions that determine which objects will be transferred.", "type": "object", "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.", - "type": "array", - "items": { - "type": "string" - } - }, "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", @@ -490,6 +772,18 @@ "items": { "type": "string" } + }, + "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.", + "type": "array", + "items": { + "type": "string" + } } }, "id": "ObjectConditions" @@ -499,8 +793,8 @@ "type": "object", "properties": { "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." + "description": "The error result of the operation in case of failure or cancellation.", + "$ref": "Status" }, "metadata": { "additionalProperties": { @@ -515,12 +809,12 @@ "type": "boolean" }, "response": { + "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", "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`.", @@ -552,29 +846,29 @@ "description": "Configuration for running a transfer.", "type": "object", "properties": { - "awsS3DataSource": { - "description": "An AWS S3 data source.", - "$ref": "AwsS3Data" - }, - "httpDataSource": { - "description": "An HTTP URL data source.", - "$ref": "HttpData" - }, - "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." }, "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." + "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.", + "$ref": "TransferOptions" + }, + "awsS3DataSource": { + "$ref": "AwsS3Data", + "description": "An AWS S3 data source." + }, + "httpDataSource": { + "$ref": "HttpData", + "description": "An HTTP URL data source." + }, + "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.", + "$ref": "ObjectConditions" + }, + "gcsDataSink": { + "$ref": "GcsData", + "description": "A Google Cloud Storage data sink." } }, "id": "TransferSpec" @@ -700,8 +994,8 @@ "type": "string" }, "transferSpec": { - "description": "Transfer specification.", - "$ref": "TransferSpec" + "$ref": "TransferSpec", + "description": "Transfer specification." }, "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.", @@ -753,309 +1047,22 @@ "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." + "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.", + "$ref": "TimeOfDay" }, "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." + "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.", + "$ref": "Date" } }, "id": "Schedule" - }, - "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`.", - "type": "object", - "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" - } - }, - "id": "Date" - }, - "TransferOperation": { - "description": "A description of the execution of a transfer.", - "type": "object", - "properties": { - "status": { - "description": "Status of the transfer operation.", - "type": "string", - "enumDescriptions": [ - "Zero is an illegal value.", - "In progress.", - "Paused.", - "Completed successfully.", - "Terminated due to an unrecoverable failure.", - "Aborted by the user." - ], - "enum": [ - "STATUS_UNSPECIFIED", - "IN_PROGRESS", - "PAUSED", - "SUCCESS", - "FAILED", - "ABORTED" - ] - }, - "counters": { - "description": "Information about the progress of the transfer operation.", - "$ref": "TransferCounters" - }, - "errorBreakdowns": { - "description": "Summarizes errors encountered with sample error log entries.", - "type": "array", - "items": { - "$ref": "ErrorSummary" - } - }, - "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": { - "description": "Transfer specification.\nRequired.", - "$ref": "TransferSpec" - } - }, - "id": "TransferOperation" - }, - "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.", - "type": "object", - "properties": { - "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." - }, - "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" - } - }, - "id": "AwsS3Data" - }, - "AwsAccessKey": { - "description": "AWS access key (see\n[AWS Security Credentials](http://docs.aws.amazon.com/general/latest/gr/aws-security-credentials.html)).", - "type": "object", - "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" - } - }, - "id": "AwsAccessKey" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "PauseTransferOperationRequest": { - "description": "Request passed to PauseTransferOperation.", - "type": "object", - "properties": {}, - "id": "PauseTransferOperationRequest" - }, - "TransferCounters": { - "description": "A collection of counters that report the progress of a transfer operation.", - "type": "object", - "properties": { - "bytesFoundFromSource": { - "description": "Bytes found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.", - "format": "int64", - "type": "string" - }, - "objectsFromSourceSkippedBySync": { - "description": "Objects in the data source that are not transferred because they already\nexist in the data sink.", - "format": "int64", - "type": "string" - }, - "bytesDeletedFromSource": { - "description": "Bytes that are deleted from the data source.", - "format": "int64", - "type": "string" - }, - "objectsFoundFromSource": { - "description": "Objects found in the data source that are scheduled to be transferred,\nexcluding any that are filtered based on object conditions or skipped due\nto sync.", - "format": "int64", - "type": "string" - }, - "objectsFailedToDeleteFromSink": { - "description": "Objects that failed to be 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" - }, - "objectsDeletedFromSink": { - "description": "Objects that are deleted from the data sink.", - "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", - "type": "string" - }, - "bytesFromSourceFailed": { - "description": "Bytes in the data source that failed during the transfer.", - "format": "int64", - "type": "string" - }, - "objectsCopiedToSink": { - "description": "Objects that are copied to the data sink.", - "format": "int64", - "type": "string" - }, - "objectsFromSourceFailed": { - "description": "Objects in the data source that failed during the transfer.", - "format": "int64", - "type": "string" - }, - "bytesFoundOnlyFromSink": { - "description": "Bytes found only in the data sink that are scheduled to be deleted.", - "format": "int64", - "type": "string" - }, - "objectsDeletedFromSource": { - "description": "Objects that are deleted from the data source.", - "format": "int64", - "type": "string" - }, - "bytesCopiedToSink": { - "description": "Bytes that are copied to the data sink.", - "format": "int64", - "type": "string" - } - }, - "id": "TransferCounters" - }, - "ErrorSummary": { - "description": "A summary of errors by error code, plus a count and sample error log\nentries.", - "type": "object", - "properties": { - "errorCode": { - "description": "Required.", - "type": "string", - "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" - ], - "enum": [ - "OK", - "CANCELLED", - "UNKNOWN", - "INVALID_ARGUMENT", - "DEADLINE_EXCEEDED", - "NOT_FOUND", - "ALREADY_EXISTS", - "PERMISSION_DENIED", - "UNAUTHENTICATED", - "RESOURCE_EXHAUSTED", - "FAILED_PRECONDITION", - "ABORTED", - "OUT_OF_RANGE", - "UNIMPLEMENTED", - "INTERNAL", - "UNAVAILABLE", - "DATA_LOSS" - ] - }, - "errorCount": { - "description": "Count of this type of error.\nRequired.", - "format": "int64", - "type": "string" - }, - "errorLogEntries": { - "description": "Error samples.", - "type": "array", - "items": { - "$ref": "ErrorLogEntry" - } - } - }, - "id": "ErrorSummary" - }, - "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/create-url-list).\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/\u003cURL-path\u003e` is transferred\nto a data sink, the name of the object at the data sink is\n`\u003chostname\u003e/\u003cURL-path\u003e`.\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.", - "type": "object", - "properties": { - "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" - } - }, - "id": "HttpData" } }, + "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "protocol": "rest", "version": "v1", "baseUrl": "https://storagetransfer.googleapis.com/", "auth": { @@ -1066,12 +1073,5 @@ } } } - }, - "kind": "discovery#restDescription", - "description": "Transfers data from external data sources to a Google Cloud Storage bucket or between Google Cloud Storage buckets.", - "servicePath": "", - "rootUrl": "https://storagetransfer.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "storagetransfer" + } }
diff --git a/streetviewpublish/v1/streetviewpublish-api.json b/streetviewpublish/v1/streetviewpublish-api.json index 92d0763..fbedf59 100644 --- a/streetviewpublish/v1/streetviewpublish-api.json +++ b/streetviewpublish/v1/streetviewpublish-api.json
@@ -1,8 +1,55 @@ { + "rootUrl": "https://streetviewpublish.googleapis.com/", + "ownerDomain": "google.com", + "name": "streetviewpublish", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Street View Publish API", "ownerName": "Google", "resources": { "photos": { "methods": { + "list": { + "description": "Lists all the Photos that belong to\nthe user.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Recently created photos that are still\nbeing indexed are not returned in the response.\u003c/aside\u003e", + "httpMethod": "GET", + "parameterOrder": [], + "response": { + "$ref": "ListPhotosResponse" + }, + "parameters": { + "filter": { + "location": "query", + "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.", + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.", + "type": "string" + }, + "pageSize": { + "location": "query", + "description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.", + "format": "int32", + "type": "integer" + }, + "view": { + "location": "query", + "enum": [ + "BASIC", + "INCLUDE_DOWNLOAD_URL" + ], + "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.", + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/streetviewpublish" + ], + "flatPath": "v1/photos", + "id": "streetviewpublish.photos.list", + "path": "v1/photos" + }, "batchUpdate": { "request": { "$ref": "BatchUpdatePhotosRequest" @@ -22,11 +69,6 @@ "id": "streetviewpublish.photos.batchUpdate" }, "batchDelete": { - "response": { - "$ref": "BatchDeletePhotosResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/streetviewpublish" @@ -37,103 +79,158 @@ "request": { "$ref": "BatchDeletePhotosRequest" }, - "description": "Deletes a list of Photos and their\nmetadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo." + "description": "Deletes a list of Photos and their\nmetadata.\n\nNote that if\nBatchDeletePhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchDeletePhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchDeletePhotosResponse.results.\nSee\nDeletePhoto\nfor specific failures that can occur per photo.", + "response": { + "$ref": "BatchDeletePhotosResponse" + }, + "parameterOrder": [], + "httpMethod": "POST" }, "batchGet": { + "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo.", "response": { "$ref": "BatchGetPhotosResponse" }, "parameterOrder": [], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/streetviewpublish" - ], "parameters": { - "view": { - "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.", - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "INCLUDE_DOWNLOAD_URL" - ] - }, "photoIds": { - "type": "string", "repeated": true, "location": "query", - "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`." - } - }, - "flatPath": "v1/photos:batchGet", - "path": "v1/photos:batchGet", - "id": "streetviewpublish.photos.batchGet", - "description": "Gets the metadata of the specified\nPhoto batch.\n\nNote that if\nBatchGetPhotos\nfails, either critical fields are missing or there was an authentication\nerror. Even if\nBatchGetPhotos\nsucceeds, there may have been failures for single photos in the batch.\nThese failures will be specified in each\nPhotoResponse.status\nin\nBatchGetPhotosResponse.results.\nSee\nGetPhoto\nfor specific failures that can occur per photo." - }, - "list": { - "description": "Lists all the Photos that belong to\nthe user.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Recently created photos that are still\nbeing indexed are not returned in the response.\u003c/aside\u003e", - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListPhotosResponse" - }, - "parameters": { - "pageToken": { - "description": "The\nnextPageToken\nvalue returned from a previous\nListPhotos\nrequest, if any.", - "type": "string", - "location": "query" - }, - "pageSize": { - "location": "query", - "description": "The maximum number of photos to return.\n`pageSize` must be non-negative. If `pageSize` is zero or is not provided,\nthe default page size of 100 will be used.\nThe number of photos returned in the response may be less than `pageSize`\nif the number of photos that belong to the user is less than `pageSize`.", - "format": "int32", - "type": "integer" + "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.", + "type": "string" }, "view": { + "type": "string", + "location": "query", "enum": [ "BASIC", "INCLUDE_DOWNLOAD_URL" ], - "description": "Specifies if a download URL for the photos bytes should be returned in the\nPhotos response.", - "type": "string", - "location": "query" - }, - "filter": { - "location": "query", - "description": "The filter expression. For example: `placeId=ChIJj61dQgK6j4AR4GeTYWZsKWw`.\n\nThe only filter supported at the moment is `placeId`.", - "type": "string" + "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response." } }, "scopes": [ "https://www.googleapis.com/auth/streetviewpublish" ], - "flatPath": "v1/photos", - "id": "streetviewpublish.photos.list", - "path": "v1/photos" + "flatPath": "v1/photos:batchGet", + "path": "v1/photos:batchGet", + "id": "streetviewpublish.photos.batchGet" } } }, "photo": { "methods": { + "get": { + "scopes": [ + "https://www.googleapis.com/auth/streetviewpublish" + ], + "parameters": { + "photoId": { + "description": "Required. ID of the Photo.", + "required": true, + "type": "string", + "location": "path" + }, + "view": { + "location": "query", + "enum": [ + "BASIC", + "INCLUDE_DOWNLOAD_URL" + ], + "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.", + "type": "string" + } + }, + "flatPath": "v1/photo/{photoId}", + "path": "v1/photo/{photoId}", + "id": "streetviewpublish.photo.get", + "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist.\n* google.rpc.Code.UNAVAILABLE if the requested\nPhoto is still being indexed.", + "response": { + "$ref": "Photo" + }, + "parameterOrder": [ + "photoId" + ], + "httpMethod": "GET" + }, + "update": { + "response": { + "$ref": "Photo" + }, + "parameterOrder": [ + "id" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/streetviewpublish" + ], + "parameters": { + "id": { + "required": true, + "type": "string", + "location": "path", + "description": "Required. A unique identifier for a photo." + }, + "updateMask": { + "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e", + "format": "google-fieldmask", + "type": "string", + "location": "query" + } + }, + "flatPath": "v1/photo/{id}", + "path": "v1/photo/{id}", + "id": "streetviewpublish.photo.update", + "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nOnly the fields specified in the\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist.\n* google.rpc.Code.UNAVAILABLE if the requested\nPhoto is still being indexed.", + "request": { + "$ref": "Photo" + } + }, + "create": { + "httpMethod": "POST", + "parameterOrder": [], + "response": { + "$ref": "Photo" + }, + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/streetviewpublish" + ], + "flatPath": "v1/photo", + "id": "streetviewpublish.photo.create", + "path": "v1/photo", + "request": { + "$ref": "Photo" + }, + "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nCurrently, the only way to set heading, pitch, and roll in CreatePhoto is\nthrough the [Photo Sphere XMP\nmetadata](https://developers.google.com/streetview/spherical-metadata) in\nthe photo bytes. The `pose.heading`, `pose.pitch`, `pose.roll`,\n`pose.altitude`, and `pose.level` fields in Pose are ignored for\nCreatePhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if\nthe uploaded photo is not a 360 photo.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit." + }, "startUpload": { + "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry.", + "request": { + "$ref": "Empty" + }, "response": { "$ref": "UploadRef" }, "parameterOrder": [], "httpMethod": "POST", - "parameters": {}, "scopes": [ "https://www.googleapis.com/auth/streetviewpublish" ], + "parameters": {}, "flatPath": "v1/photo:startUpload", "path": "v1/photo:startUpload", - "id": "streetviewpublish.photo.startUpload", - "request": { - "$ref": "Empty" - }, - "description": "Creates an upload session to start uploading photo bytes. The upload URL of\nthe returned UploadRef is used to\nupload the bytes for the Photo.\n\nIn addition to the photo requirements shown in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604,\nthe photo must also meet the following requirements:\n\n* Photo Sphere XMP metadata must be included in the photo medadata. See\nhttps://developers.google.com/streetview/spherical-metadata for the\nrequired fields.\n* The pixel size of the photo must meet the size requirements listed in\nhttps://support.google.com/maps/answer/7012050?hl=en&ref_topic=6275604, and\nthe photo must be a full 360 horizontally.\n\nAfter the upload is complete, the\nUploadRef is used with\nCreatePhoto\nto create the Photo object entry." + "id": "streetviewpublish.photo.startUpload" }, "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "photoId" + ], + "httpMethod": "DELETE", "scopes": [ "https://www.googleapis.com/auth/streetviewpublish" ], @@ -148,144 +245,32 @@ "flatPath": "v1/photo/{photoId}", "path": "v1/photo/{photoId}", "id": "streetviewpublish.photo.delete", - "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "photoId" - ], - "httpMethod": "DELETE" - }, - "get": { - "description": "Gets the metadata of the specified\nPhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested Photo.\n* google.rpc.Code.NOT_FOUND if the requested\nPhoto does not exist.\n* google.rpc.Code.UNAVAILABLE if the requested\nPhoto is still being indexed.", - "response": { - "$ref": "Photo" - }, - "parameterOrder": [ - "photoId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/streetviewpublish" - ], - "parameters": { - "photoId": { - "description": "Required. ID of the Photo.", - "required": true, - "type": "string", - "location": "path" - }, - "view": { - "description": "Specifies if a download URL for the photo bytes should be returned in the\nPhoto response.", - "type": "string", - "location": "query", - "enum": [ - "BASIC", - "INCLUDE_DOWNLOAD_URL" - ] - } - }, - "flatPath": "v1/photo/{photoId}", - "path": "v1/photo/{photoId}", - "id": "streetviewpublish.photo.get" - }, - "update": { - "response": { - "$ref": "Photo" - }, - "parameterOrder": [ - "id" - ], - "httpMethod": "PUT", - "parameters": { - "updateMask": { - "type": "string", - "location": "query", - "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e", - "format": "google-fieldmask" - }, - "id": { - "required": true, - "type": "string", - "location": "path", - "description": "Required. A unique identifier for a photo." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/streetviewpublish" - ], - "flatPath": "v1/photo/{id}", - "path": "v1/photo/{id}", - "id": "streetviewpublish.photo.update", - "request": { - "$ref": "Photo" - }, - "description": "Updates the metadata of a Photo, such\nas pose, place association, connections, etc. Changing the pixels of a\nphoto is not supported.\n\nOnly the fields specified in the\nupdateMask\nfield are used. If `updateMask` is not present, the update applies to all\nfields.\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e To update\nPose.altitude,\nPose.latLngPair has to be\nfilled as well. Otherwise, the request will fail.\u003c/aside\u003e\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed.\n* google.rpc.Code.NOT_FOUND if the requested photo does not exist.\n* google.rpc.Code.UNAVAILABLE if the requested\nPhoto is still being indexed." - }, - "create": { - "response": { - "$ref": "Photo" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/streetviewpublish" - ], - "parameters": {}, - "flatPath": "v1/photo", - "path": "v1/photo", - "id": "streetviewpublish.photo.create", - "description": "After the client finishes uploading the photo with the returned\nUploadRef,\nCreatePhoto\npublishes the uploaded Photo to\nStreet View on Google Maps.\n\nCurrently, the only way to set heading, pitch, and roll in CreatePhoto is\nthrough the [Photo Sphere XMP\nmetadata](https://developers.google.com/streetview/spherical-metadata) in\nthe photo bytes. The `pose.heading`, `pose.pitch`, `pose.roll`,\n`pose.altitude`, and `pose.level` fields in Pose are ignored for\nCreatePhoto.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.INVALID_ARGUMENT if the request is malformed or if\nthe uploaded photo is not a 360 photo.\n* google.rpc.Code.NOT_FOUND if the upload reference does not exist.\n* google.rpc.Code.RESOURCE_EXHAUSTED if the account has reached the\nstorage limit.", - "request": { - "$ref": "Photo" - } + "description": "Deletes a Photo and its metadata.\n\nThis method returns the following error codes:\n\n* google.rpc.Code.PERMISSION_DENIED if the requesting user did not\ncreate the requested photo.\n* google.rpc.Code.NOT_FOUND if the photo ID does not exist." } } } }, "parameters": { - "quotaUser": { + "upload_protocol": { "location": "query", - "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.", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, - "pp": { + "prettyPrint": { "location": "query", - "description": "Pretty-print response.", + "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true" }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string", - "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "fields": { - "description": "Selector specifying which fields to include in a partial response.", "type": "string", - "location": "query" + "location": "query", + "description": "Selector specifying which fields to include in a partial response." }, "$.xgafv": { "description": "V1 error format.", @@ -306,7 +291,6 @@ "type": "string" }, "alt": { - "default": "json", "enum": [ "json", "media", @@ -319,7 +303,8 @@ "Responses with Content-Type of application/x-protobuf" ], "location": "query", - "description": "Data format for response." + "description": "Data format for response.", + "default": "json" }, "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.", @@ -327,129 +312,62 @@ "location": "query" }, "access_token": { + "location": "query", "description": "OAuth access token.", + "type": "string" + }, + "quotaUser": { + "type": "string", + "location": "query", + "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." + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" + }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" } }, "version": "v1", "baseUrl": "https://streetviewpublish.googleapis.com/", - "servicePath": "", - "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n", "kind": "discovery#restDescription", + "description": "Publishes 360 photos to Google Maps, along with position, orientation, and connectivity metadata. Apps can offer an interface for positioning, connecting, and uploading user-generated Street View images.\n", + "servicePath": "", "basePath": "", + "revision": "20180106", "documentationLink": "https://developers.google.com/streetview/publish/", "id": "streetviewpublish:v1", - "revision": "20180104", "discoveryVersion": "v1", "version_module": true, "schemas": { - "Level": { - "id": "Level", - "description": "Level information containing level number and its corresponding name.", - "type": "object", - "properties": { - "name": { - "description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.", - "type": "string" - }, - "number": { - "description": "Floor number, used for ordering. 0 indicates the ground level, 1 indicates\nthe first level above ground level, -1 indicates the first level under\nground level. Non-integer values are OK.", - "format": "double", - "type": "number" - } - } - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "BatchGetPhotosResponse": { - "description": "Response to batch get of Photos.", - "type": "object", - "properties": { - "results": { - "type": "array", - "items": { - "$ref": "PhotoResponse" - }, - "description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos." - } - }, - "id": "BatchGetPhotosResponse" - }, - "Place": { - "type": "object", - "properties": { - "placeId": { - "description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id.", - "type": "string" - } - }, - "id": "Place", - "description": "Place metadata for an entity." - }, - "UploadRef": { - "id": "UploadRef", - "description": "Upload reference for media files.", - "type": "object", - "properties": { - "uploadUrl": { - "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"", - "type": "string" - } - } - }, - "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", - "type": "object", - "properties": { - "latitude": { - "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", - "format": "double", - "type": "number" - }, - "longitude": { - "type": "number", - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "format": "double" - } - }, - "id": "LatLng" - }, - "BatchDeletePhotosRequest": { - "description": "Request to delete multiple Photos.", - "type": "object", - "properties": { - "photoIds": { - "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "BatchDeletePhotosRequest" - }, "UpdatePhotoRequest": { "description": "Request to update the metadata of a\nPhoto. Updating the pixels of a photo\nis not supported.", "type": "object", "properties": { - "updateMask": { - "type": "string", - "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e", - "format": "google-fieldmask" - }, "photo": { "$ref": "Photo", "description": "Required. Photo object containing the\nnew metadata." + }, + "updateMask": { + "description": "Mask that identifies fields on the photo metadata to update.\nIf not present, the old Photo\nmetadata will be entirely replaced with the\nnew Photo metadata in this request.\nThe update fails if invalid fields are specified. Multiple fields can be\nspecified in a comma-delimited list.\n\nThe following fields are valid:\n\n* `pose.heading`\n* `pose.latLngPair`\n* `pose.pitch`\n* `pose.roll`\n* `pose.level`\n* `pose.altitude`\n* `connections`\n* `places`\n\n\n\u003caside class=\"note\"\u003e\u003cb\u003eNote:\u003c/b\u003e Repeated fields in\nupdateMask\nmean the entire set of repeated values will be replaced with the new\ncontents. For example, if\nupdateMask\ncontains `connections` and `UpdatePhotoRequest.photo.connections` is empty,\nall connections will be removed.\u003c/aside\u003e", + "format": "google-fieldmask", + "type": "string" } }, "id": "UpdatePhotoRequest" }, "PhotoId": { + "description": "Identifier for a Photo.", "type": "object", "properties": { "id": { @@ -457,22 +375,23 @@ "type": "string" } }, - "id": "PhotoId", - "description": "Identifier for a Photo." + "id": "PhotoId" }, "Pose": { - "description": "Raw pose measurement for an entity.", - "type": "object", "properties": { + "level": { + "description": "Level (the floor in a building) used to configure vertical navigation.", + "$ref": "Level" + }, "heading": { "description": "Compass heading, measured at the center of the photo in degrees clockwise\nfrom North. Value must be \u003e=0 and \u003c360.\nNaN indicates an unmeasured quantity.", "format": "double", "type": "number" }, "altitude": { + "type": "number", "description": "Altitude of the pose in meters above WGS84 ellipsoid.\nNaN indicates an unmeasured quantity.", - "format": "double", - "type": "number" + "format": "double" }, "pitch": { "description": "Pitch, measured at the center of the photo in degrees. Value must be \u003e=-90\nand \u003c= 90. A value of -90 means looking directly down, and a value of 90\nmeans looking directly up.\nNaN indicates an unmeasured quantity.", @@ -480,20 +399,18 @@ "type": "number" }, "latLngPair": { - "$ref": "LatLng", - "description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail." + "description": "Latitude and longitude pair of the pose, as explained here:\nhttps://cloud.google.com/datastore/docs/reference/rest/Shared.Types/LatLng\nWhen creating a Photo, if the\nlatitude and longitude pair are not provided here, the geolocation from the\nexif header will be used. If the latitude and longitude pair is not\nprovided and cannot be found in the exif header, the create photo process\nwill fail.", + "$ref": "LatLng" }, "roll": { "description": "Roll, measured in degrees. Value must be \u003e= 0 and \u003c360. A value of 0\nmeans level with the horizon.\nNaN indicates an unmeasured quantity.", "format": "double", "type": "number" - }, - "level": { - "description": "Level (the floor in a building) used to configure vertical navigation.", - "$ref": "Level" } }, - "id": "Pose" + "id": "Pose", + "description": "Raw pose measurement for an entity.", + "type": "object" }, "BatchUpdatePhotosRequest": { "description": "Request to update the metadata of photos.\nUpdating the pixels of photos is not supported.", @@ -528,7 +445,6 @@ "id": "ListPhotosResponse" }, "Photo": { - "description": "Photo is used to store 360 photos along with photo metadata.", "type": "object", "properties": { "downloadUrl": { @@ -549,40 +465,43 @@ "$ref": "Place" } }, - "uploadReference": { - "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to.", - "$ref": "UploadRef" + "pose": { + "$ref": "Pose", + "description": "Pose of the photo." }, "photoId": { "$ref": "PhotoId", "description": "Required when updating a photo. Output only when creating a photo.\nIdentifier for the photo, which is unique among all photos in\nGoogle." }, - "pose": { - "description": "Pose of the photo.", - "$ref": "Pose" + "uploadReference": { + "$ref": "UploadRef", + "description": "Required when creating a photo. Input only. The resource URL where the\nphoto bytes are uploaded to." }, "shareLink": { "description": "Output only. The share link for the photo.", "type": "string" }, + "thumbnailUrl": { + "description": "Output only. The thumbnail URL for showing a preview of the given photo.", + "type": "string" + }, "captureTime": { "description": "Absolute time when the photo was captured.\nWhen the photo has no exif timestamp, this is used to set a timestamp in\nthe photo metadata.", "format": "google-datetime", "type": "string" }, - "thumbnailUrl": { - "description": "Output only. The thumbnail URL for showing a preview of the given photo.", - "type": "string" - }, "viewCount": { "description": "Output only. View count of the photo.", "format": "int64", "type": "string" } }, - "id": "Photo" + "id": "Photo", + "description": "Photo is used to store 360 photos along with photo metadata." }, "Operation": { + "id": "Operation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", "type": "object", "properties": { "error": { @@ -590,35 +509,32 @@ "$ref": "Status" }, "metadata": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" - }, - "done": { - "type": "boolean", - "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." - }, - "response": { - "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", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } + }, + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any." + }, + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", "type": "string" } - }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." + } }, "PhotoResponse": { - "id": "PhotoResponse", "description": "Response payload for a single\nPhoto\nin batch operations including\nBatchGetPhotos\nand\nBatchUpdatePhotos.", "type": "object", "properties": { @@ -630,7 +546,8 @@ "description": "The Photo resource, if the request\nwas successful.", "$ref": "Photo" } - } + }, + "id": "PhotoResponse" }, "Connection": { "description": "A connection is the link from a source photo to a destination photo.", @@ -657,9 +574,29 @@ }, "id": "BatchUpdatePhotosResponse" }, - "Status": { + "BatchDeletePhotosResponse": { + "description": "Response to batch delete of one or more\nPhotos.", "type": "object", "properties": { + "status": { + "description": "The status for the operation to delete a single\nPhoto in the batch request.", + "type": "array", + "items": { + "$ref": "Status" + } + } + }, + "id": "BatchDeletePhotosResponse" + }, + "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.", + "type": "object", + "properties": { + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + }, "message": { "type": "string", "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." @@ -674,35 +611,104 @@ "type": "any" } } - }, - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" } }, - "id": "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" }, - "BatchDeletePhotosResponse": { + "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 `{}`.", + "type": "object", + "properties": {}, + "id": "Empty" + }, + "Level": { + "id": "Level", + "description": "Level information containing level number and its corresponding name.", "type": "object", "properties": { - "status": { - "description": "The status for the operation to delete a single\nPhoto in the batch request.", + "name": { + "description": "Required. A name assigned to this Level, restricted to 3 characters.\nConsider how the elevator buttons would be labeled for this level if there\nwas an elevator.", + "type": "string" + }, + "number": { + "description": "Floor number, used for ordering. 0 indicates the ground level, 1 indicates\nthe first level above ground level, -1 indicates the first level under\nground level. Non-integer values are OK.", + "format": "double", + "type": "number" + } + } + }, + "BatchGetPhotosResponse": { + "description": "Response to batch get of Photos.", + "type": "object", + "properties": { + "results": { + "description": "List of results for each individual\nPhoto requested, in the same order as\nthe requests in\nBatchGetPhotos.", "type": "array", "items": { - "$ref": "Status" + "$ref": "PhotoResponse" } } }, - "id": "BatchDeletePhotosResponse", - "description": "Response to batch delete of one or more\nPhotos." + "id": "BatchGetPhotosResponse" + }, + "UploadRef": { + "description": "Upload reference for media files.", + "type": "object", + "properties": { + "uploadUrl": { + "description": "Required. An upload reference should be unique for each user. It follows\nthe form:\n\"https://streetviewpublish.googleapis.com/media/user/{account_id}/photo/{upload_reference}\"", + "type": "string" + } + }, + "id": "UploadRef" + }, + "Place": { + "type": "object", + "properties": { + "placeId": { + "description": "Place identifier, as described in\nhttps://developers.google.com/places/place-id.", + "type": "string" + } + }, + "id": "Place", + "description": "Place metadata for an entity." + }, + "LatLng": { + "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", + "type": "object", + "properties": { + "latitude": { + "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", + "format": "double", + "type": "number" + }, + "longitude": { + "type": "number", + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double" + } + }, + "id": "LatLng" + }, + "BatchDeletePhotosRequest": { + "properties": { + "photoIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required. IDs of the Photos. For HTTP\nGET requests, the URL query parameter should be\n`photoIds=\u003cid1\u003e&photoIds=\u003cid2\u003e&...`." + } + }, + "id": "BatchDeletePhotosRequest", + "description": "Request to delete multiple Photos.", + "type": "object" } }, "protocol": "rest", "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "canonicalName": "Street View Publish", "auth": { @@ -713,11 +719,5 @@ } } } - }, - "rootUrl": "https://streetviewpublish.googleapis.com/", - "ownerDomain": "google.com", - "name": "streetviewpublish", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Street View Publish API" + } }
diff --git a/testing/v1/testing-api.json b/testing/v1/testing-api.json index e4e0ae0..a520afb 100644 --- a/testing/v1/testing-api.json +++ b/testing/v1/testing-api.json
@@ -1,14 +1,37 @@ { - "id": "testing:v1", + "version": "v1", + "baseUrl": "https://testing.googleapis.com/", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-platform.read-only": { + "description": "View your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "kind": "discovery#restDescription", + "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.", + "servicePath": "", + "rootUrl": "https://testing.googleapis.com/", + "basePath": "", + "ownerDomain": "google.com", + "name": "testing", + "batchPath": "batch", + "revision": "20180105", "documentationLink": "https://developers.google.com/cloud-test-lab/", - "revision": "20171220", + "id": "testing:v1", "title": "Google Cloud Testing API", - "ownerName": "Google", "discoveryVersion": "v1", + "ownerName": "Google", "resources": { "testEnvironmentCatalog": { "methods": { "get": { + "description": "Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred", "response": { "$ref": "TestEnvironmentCatalog" }, @@ -16,10 +39,6 @@ "environmentType" ], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], "parameters": { "projectId": { "location": "query", @@ -27,21 +46,24 @@ "type": "string" }, "environmentType": { - "description": "The type of environment that should be listed.\nRequired", - "required": true, - "type": "string", "location": "path", "enum": [ "ENVIRONMENT_TYPE_UNSPECIFIED", "ANDROID", "NETWORK_CONFIGURATION" - ] + ], + "description": "The type of environment that should be listed.\nRequired", + "required": true, + "type": "string" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "flatPath": "v1/testEnvironmentCatalog/{environmentType}", "path": "v1/testEnvironmentCatalog/{environmentType}", - "id": "testing.testEnvironmentCatalog.get", - "description": "Get the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred" + "id": "testing.testEnvironmentCatalog.get" } } }, @@ -50,44 +72,38 @@ "testMatrices": { "methods": { "get": { + "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}", + "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}", + "id": "testing.projects.testMatrices.get", "description": "Check the status of a test matrix.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist", - "httpMethod": "GET", + "response": { + "$ref": "TestMatrix" + }, "parameterOrder": [ "projectId", "testMatrixId" ], - "response": { - "$ref": "TestMatrix" - }, + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-platform.read-only" + ], "parameters": { - "testMatrixId": { - "location": "path", - "description": "Unique test matrix id which was assigned by the service.", - "required": true, - "type": "string" - }, "projectId": { "location": "path", "description": "Cloud project that owns the test matrix.", "required": true, "type": "string" + }, + "testMatrixId": { + "description": "Unique test matrix id which was assigned by the service.", + "required": true, + "type": "string", + "location": "path" } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-platform.read-only" - ], - "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}", - "id": "testing.projects.testMatrices.get", - "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}" + } }, "create": { - "path": "v1/projects/{projectId}/testMatrices", - "id": "testing.projects.testMatrices.create", - "request": { - "$ref": "TestMatrix" - }, - "description": "Request to run a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions", "response": { "$ref": "TestMatrix" }, @@ -95,26 +111,31 @@ "projectId" ], "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "parameters": { - "requestId": { - "description": "A string id used to detect duplicated requests.\nIds are automatically scoped to a project, so\nusers should ensure the ID is unique per-project.\nA UUID is recommended.\n\nOptional, but strongly recommended.", - "type": "string", - "location": "query" - }, "projectId": { "location": "path", "description": "The GCE project under which this job will run.", "required": true, "type": "string" + }, + "requestId": { + "location": "query", + "description": "A string id used to detect duplicated requests.\nIds are automatically scoped to a project, so\nusers should ensure the ID is unique per-project.\nA UUID is recommended.\n\nOptional, but strongly recommended.", + "type": "string" } }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectId}/testMatrices" + "flatPath": "v1/projects/{projectId}/testMatrices", + "path": "v1/projects/{projectId}/testMatrices", + "id": "testing.projects.testMatrices.create", + "description": "Request to run a matrix of tests according to the given specifications.\nUnsupported environments will be returned in the state UNSUPPORTED.\nMatrices are limited to at most 200 supported executions.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to write to project\n- INVALID_ARGUMENT - if the request is malformed or if the matrix expands\n to more than 200 supported executions", + "request": { + "$ref": "TestMatrix" + } }, "cancel": { - "description": "Cancels unfinished test executions in a test matrix.\nThis call returns immediately and cancellation proceeds asychronously.\nIf the matrix is already final, this operation will have no effect.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist", "response": { "$ref": "CancelTestMatrixResponse" }, @@ -123,26 +144,27 @@ "testMatrixId" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], "parameters": { + "projectId": { + "required": true, + "type": "string", + "location": "path", + "description": "Cloud project that owns the test." + }, "testMatrixId": { "location": "path", "description": "Test matrix that will be canceled.", "required": true, "type": "string" - }, - "projectId": { - "description": "Cloud project that owns the test.", - "required": true, - "type": "string", - "location": "path" } }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel", "path": "v1/projects/{projectId}/testMatrices/{testMatrixId}:cancel", - "id": "testing.projects.testMatrices.cancel" + "id": "testing.projects.testMatrices.cancel", + "description": "Cancels unfinished test executions in a test matrix.\nThis call returns immediately and cancellation proceeds asychronously.\nIf the matrix is already final, this operation will have no effect.\n\nMay return any of the following canonical error codes:\n\n- PERMISSION_DENIED - if the user is not authorized to read project\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the Test Matrix does not exist" } } } @@ -150,29 +172,55 @@ } }, "parameters": { - "upload_protocol": { + "access_token": { + "type": "string", "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "description": "OAuth access token." + }, + "key": { + "type": "string", + "location": "query", + "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." + }, + "quotaUser": { + "location": "query", + "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.", "type": "string" }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, "prettyPrint": { "location": "query", "description": "Returns response with indentations and line breaks.", "type": "boolean", "default": "true" }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, - "callback": { - "description": "JSONP", + "fields": { + "description": "Selector specifying which fields to include in a partial response.", "type": "string", "location": "query" }, @@ -189,9 +237,12 @@ "description": "V1 error format.", "type": "string" }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, "alt": { - "description": "Data format for response.", - "default": "json", "enum": [ "json", "media", @@ -203,188 +254,94 @@ "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ], - "location": "query" - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, - "key": { "location": "query", - "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.", - "type": "string" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" + "description": "Data format for response.", + "default": "json" } }, "schemas": { - "Orientation": { + "DeviceFile": { "properties": { - "name": { - "description": "A human-friendly name for this orientation.\nExample: \"portrait\"\n@OutputOnly", - "type": "string" - }, - "id": { - "description": "The id for this orientation.\nExample: \"portrait\"\n@OutputOnly", - "type": "string" - }, - "tags": { - "description": "Tags for this dimension.\nExamples: \"default\"", - "type": "array", - "items": { - "type": "string" - } + "obbFile": { + "description": "A reference to an opaque binary blob file", + "$ref": "ObbFile" } }, - "id": "Orientation", - "description": "Screen orientation of the device.", + "id": "DeviceFile", + "description": "A single device file description.", "type": "object" }, - "NetworkConfigurationCatalog": { + "ClientInfoDetail": { + "description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}", + "type": "object", "properties": { - "configurations": { - "type": "array", - "items": { - "$ref": "NetworkConfiguration" - } - } - }, - "id": "NetworkConfigurationCatalog", - "type": "object" - }, - "AndroidTestLoop": { - "properties": { - "scenarios": { - "description": "The list of scenarios that should be run during the test.\nOptional, default is all test loops, derived from the application's\nmanifest.", - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } + "key": { + "type": "string", + "description": "The key of detailed client information.\nRequired" }, - "scenarioLabels": { - "description": "The list of scenario labels that should be run during the test.\nThe scenario labels should map to labels defined in the application's\nmanifest. For example, player_experience and\ncom.google.test.loops.player_experience add all of the loops labeled in the\nmanifest with the com.google.test.loops.player_experience name to the\nexecution.\nOptional. Scenarios can also be specified in the scenarios field.", - "type": "array", - "items": { - "type": "string" - } - }, - "appApk": { - "$ref": "FileReference", - "description": "The APK for the application under test.\nRequired" - }, - "appPackageId": { - "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.", + "value": { + "description": "The value of detailed client information.\nRequired", "type": "string" } }, - "id": "AndroidTestLoop", - "description": "A test of an Android Application with a Test Loop.\nThe intent \u003cintent-name\u003e will be implicitly added, since Games is the only\nuser of this api, for the time being.", - "type": "object" + "id": "ClientInfoDetail" }, - "GoogleAuto": { - "properties": {}, - "id": "GoogleAuto", - "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and add\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities.", - "type": "object" - }, - "AndroidDeviceCatalog": { - "description": "The currently supported Android devices.", + "EnvironmentVariable": { + "id": "EnvironmentVariable", + "description": "A key-value pair passed as an environment variable to the test", "type": "object", "properties": { - "models": { - "description": "The set of supported Android device models.\n@OutputOnly", - "type": "array", - "items": { - "$ref": "AndroidModel" - } + "key": { + "type": "string", + "description": "Key for the environment variable" }, - "versions": { - "description": "The set of supported Android OS versions.\n@OutputOnly", - "type": "array", - "items": { - "$ref": "AndroidVersion" - } - }, - "runtimeConfiguration": { - "description": "The set of supported runtime configurations.\n@OutputOnly", - "$ref": "AndroidRuntimeConfiguration" - } - }, - "id": "AndroidDeviceCatalog" - }, - "AndroidDeviceList": { - "description": "A list of Android device configurations in which the test is to be executed.", - "type": "object", - "properties": { - "androidDevices": { - "description": "A list of Android devices\nRequired", - "type": "array", - "items": { - "$ref": "AndroidDevice" - } - } - }, - "id": "AndroidDeviceList" - }, - "ClientInfo": { - "properties": { - "clientInfoDetails": { - "description": "The list of detailed information about client.", - "type": "array", - "items": { - "$ref": "ClientInfoDetail" - } - }, - "name": { - "description": "Client name, such as gcloud.\nRequired", + "value": { + "description": "Value for the environment variable", "type": "string" } - }, - "id": "ClientInfo", - "description": "Information about the client which invoked the test.", - "type": "object" + } }, - "EnvironmentMatrix": { - "description": "The matrix of environments in which the test is to be executed.", - "type": "object", + "Environment": { "properties": { - "androidDeviceList": { - "$ref": "AndroidDeviceList", - "description": "A list of Android devices; the test will be run only on the specified\ndevices." - }, - "androidMatrix": { - "$ref": "AndroidMatrix", - "description": "A matrix of Android devices." + "androidDevice": { + "$ref": "AndroidDevice", + "description": "An Android device which must be used with an Android test." } }, - "id": "EnvironmentMatrix" + "id": "Environment", + "description": "The environment in which the test is run.", + "type": "object" }, - "CancelTestMatrixResponse": { - "description": "Response containing the current state of the specified test matrix.", + "TestExecution": { + "description": "Specifies a single test to be executed in a single environment.", "type": "object", "properties": { - "testState": { + "matrixId": { + "description": "Id of the containing TestMatrix.\n@OutputOnly", + "type": "string" + }, + "testDetails": { + "description": "Additional details about the running test.\n@OutputOnly", + "$ref": "TestDetails" + }, + "environment": { + "description": "How the host machine(s) are configured.\n@OutputOnly", + "$ref": "Environment" + }, + "state": { + "enumDescriptions": [ + "Do not use. For proto versioning only.", + "The execution or matrix is being validated.", + "The execution or matrix is waiting for resources to become available.", + "The execution is currently being processed.\n\nCan only be set on an execution.", + "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", + "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", + "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", + "The user cancelled the execution.\n\nCan only be set on an execution.", + "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" + ], "enum": [ "TEST_STATE_UNSPECIFIED", "VALIDATING", @@ -398,370 +355,21 @@ "CANCELLED", "INVALID" ], - "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect.", - "type": "string", - "enumDescriptions": [ - "Do not use. For proto versioning only.", - "The execution or matrix is being validated.", - "The execution or matrix is waiting for resources to become available.", - "The execution is currently being processed.\n\nCan only be set on an execution.", - "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", - "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", - "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", - "The user cancelled the execution.\n\nCan only be set on an execution.", - "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" - ] - } - }, - "id": "CancelTestMatrixResponse" - }, - "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" - } - }, - "id": "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`.", - "type": "object" - }, - "RoboStartingIntent": { - "properties": { - "startActivity": { - "$ref": "StartActivityIntent" - }, - "launcherActivity": { - "$ref": "LauncherActivityIntent" - } - }, - "id": "RoboStartingIntent", - "description": "Message for specifying the start activities to crawl", - "type": "object" - }, - "StartActivityIntent": { - "description": "A starting intent specified by an action, uri, and categories.", - "type": "object", - "properties": { - "uri": { - "description": "URI for the action.\nOptional.", + "description": "Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly", "type": "string" }, - "categories": { - "description": "Intent categories to set on the intent.\nOptional.", - "type": "array", - "items": { - "type": "string" - } - }, - "action": { - "description": "Action name.\nRequired for START_ACTIVITY.", - "type": "string" - } - }, - "id": "StartActivityIntent" - }, - "Locale": { - "description": "A location/region designation for language.", - "type": "object", - "properties": { - "id": { - "description": "The id for this locale.\nExample: \"en_US\"\n@OutputOnly", - "type": "string" - }, - "tags": { - "description": "Tags for this dimension.\nExamples: \"default\"", - "type": "array", - "items": { - "type": "string" - } - }, - "region": { - "description": "A human-friendly string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly", - "type": "string" - }, - "name": { - "description": "A human-friendly name for this language/locale.\nExample: \"English\"\n@OutputOnly", - "type": "string" - } - }, - "id": "Locale" - }, - "TestEnvironmentCatalog": { - "description": "A description of a test environment.", - "type": "object", - "properties": { - "androidDeviceCatalog": { - "$ref": "AndroidDeviceCatalog", - "description": "Android devices suitable for running Android Instrumentation Tests." - }, - "networkConfigurationCatalog": { - "$ref": "NetworkConfigurationCatalog", - "description": "Supported network configurations" - } - }, - "id": "TestEnvironmentCatalog" - }, - "Account": { - "description": "Identifies an account and how to log into it", - "type": "object", - "properties": { - "googleAuto": { - "description": "An automatic google login account", - "$ref": "GoogleAuto" - } - }, - "id": "Account" - }, - "ObbFile": { - "description": "An opaque binary blob file to install on the device before the test starts", - "type": "object", - "properties": { - "obbFileName": { - "description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired", - "type": "string" - }, - "obb": { - "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired", - "$ref": "FileReference" - } - }, - "id": "ObbFile" - }, - "AndroidRuntimeConfiguration": { - "properties": { - "orientations": { - "description": "The set of available orientations.\n@OutputOnly", - "type": "array", - "items": { - "$ref": "Orientation" - } - }, - "locales": { - "description": "The set of available locales.\n@OutputOnly", - "type": "array", - "items": { - "$ref": "Locale" - } - } - }, - "id": "AndroidRuntimeConfiguration", - "description": "Configuration that can be selected at the time a test is run.", - "type": "object" - }, - "AndroidDevice": { - "description": "A single Android device.", - "type": "object", - "properties": { - "androidModelId": { - "description": "The id of the Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", - "type": "string" - }, - "androidVersionId": { - "description": "The id of the Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", - "type": "string" - }, - "orientation": { - "description": "How the device is oriented during the test.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", - "type": "string" - }, - "locale": { - "description": "The locale the test device used for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", - "type": "string" - } - }, - "id": "AndroidDevice" - }, - "NetworkConfiguration": { - "type": "object", - "properties": { - "id": { - "description": "The unique opaque id for this network traffic configuration\n@OutputOnly", - "type": "string" - }, - "upRule": { - "description": "The emulation rule applying to the upload traffic", - "$ref": "TrafficRule" - }, - "downRule": { - "$ref": "TrafficRule", - "description": "The emulation rule applying to the download traffic" - } - }, - "id": "NetworkConfiguration" - }, - "ToolResultsStep": { - "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution.", - "type": "object", - "properties": { - "executionId": { - "description": "A tool results execution ID.\n@OutputOnly", - "type": "string" - }, - "stepId": { - "description": "A tool results step ID.\n@OutputOnly", - "type": "string" + "toolResultsStep": { + "$ref": "ToolResultsStep", + "description": "Where the results for this execution are written.\n@OutputOnly" }, "projectId": { - "description": "The cloud project that owns the tool results step.\n@OutputOnly", + "description": "The cloud project that owns the test execution.\n@OutputOnly", "type": "string" }, - "historyId": { - "description": "A tool results history ID.\n@OutputOnly", - "type": "string" - } - }, - "id": "ToolResultsStep" - }, - "TrafficRule": { - "description": "Network emulation parameters", - "type": "object", - "properties": { - "packetLossRatio": { - "description": "Packet loss ratio (0.0 - 1.0)", - "format": "float", - "type": "number" + "testSpecification": { + "$ref": "TestSpecification", + "description": "How to run the test.\n@OutputOnly" }, - "burst": { - "description": "Burst size in kbits", - "format": "float", - "type": "number" - }, - "bandwidth": { - "description": "Bandwidth in kbits/second", - "format": "float", - "type": "number" - }, - "packetDuplicationRatio": { - "description": "Packet duplication ratio (0.0 - 1.0)", - "format": "float", - "type": "number" - }, - "delay": { - "description": "Packet delay, must be \u003e= 0", - "format": "google-duration", - "type": "string" - } - }, - "id": "TrafficRule" - }, - "AndroidInstrumentationTest": { - "properties": { - "testApk": { - "$ref": "FileReference", - "description": "The APK containing the test code to be executed.\nRequired" - }, - "testRunnerClass": { - "description": "The InstrumentationTestRunner class.\nOptional, default is determined by examining the application's manifest.", - "type": "string" - }, - "testPackageId": { - "description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.", - "type": "string" - }, - "appApk": { - "$ref": "FileReference", - "description": "The APK for the application under test.\nRequired" - }, - "appPackageId": { - "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.", - "type": "string" - }, - "orchestratorOption": { - "enumDescriptions": [ - "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.", - "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.", - "Run test without using orchestrator." - ], - "enum": [ - "ORCHESTRATOR_OPTION_UNSPECIFIED", - "USE_ORCHESTRATOR", - "DO_NOT_USE_ORCHESTRATOR" - ], - "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.", - "type": "string" - }, - "testTargets": { - "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.", - "type": "array", - "items": { - "type": "string" - } - } - }, - "id": "AndroidInstrumentationTest", - "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.", - "type": "object" - }, - "DeviceFile": { - "description": "A single device file description.", - "type": "object", - "properties": { - "obbFile": { - "description": "A reference to an opaque binary blob file", - "$ref": "ObbFile" - } - }, - "id": "DeviceFile" - }, - "ClientInfoDetail": { - "description": "Key-value pair of detailed information about the client which invoked the\ntest. For example {'Version', '1.0'}, {'Release Track', 'BETA'}", - "type": "object", - "properties": { - "value": { - "description": "The value of detailed client information.\nRequired", - "type": "string" - }, - "key": { - "description": "The key of detailed client information.\nRequired", - "type": "string" - } - }, - "id": "ClientInfoDetail" - }, - "EnvironmentVariable": { - "description": "A key-value pair passed as an environment variable to the test", - "type": "object", - "properties": { - "key": { - "description": "Key for the environment variable", - "type": "string" - }, - "value": { - "description": "Value for the environment variable", - "type": "string" - } - }, - "id": "EnvironmentVariable" - }, - "Environment": { - "description": "The environment in which the test is run.", - "type": "object", - "properties": { - "androidDevice": { - "$ref": "AndroidDevice", - "description": "An Android device which must be used with an Android test." - } - }, - "id": "Environment" - }, - "TestExecution": { - "description": "Specifies a single test to be executed in a single environment.", - "type": "object", - "properties": { "id": { "description": "Unique id set by the backend.\n@OutputOnly", "type": "string" @@ -770,65 +378,12 @@ "description": "The time this test execution was initially created.\n@OutputOnly", "format": "google-datetime", "type": "string" - }, - "testDetails": { - "description": "Additional details about the running test.\n@OutputOnly", - "$ref": "TestDetails" - }, - "matrixId": { - "description": "Id of the containing TestMatrix.\n@OutputOnly", - "type": "string" - }, - "environment": { - "$ref": "Environment", - "description": "How the host machine(s) are configured.\n@OutputOnly" - }, - "state": { - "description": "Indicates the current progress of the test execution (e.g., FINISHED).\n@OutputOnly", - "type": "string", - "enumDescriptions": [ - "Do not use. For proto versioning only.", - "The execution or matrix is being validated.", - "The execution or matrix is waiting for resources to become available.", - "The execution is currently being processed.\n\nCan only be set on an execution.", - "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", - "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", - "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", - "The user cancelled the execution.\n\nCan only be set on an execution.", - "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" - ], - "enum": [ - "TEST_STATE_UNSPECIFIED", - "VALIDATING", - "PENDING", - "RUNNING", - "FINISHED", - "ERROR", - "UNSUPPORTED_ENVIRONMENT", - "INCOMPATIBLE_ENVIRONMENT", - "INCOMPATIBLE_ARCHITECTURE", - "CANCELLED", - "INVALID" - ] - }, - "toolResultsStep": { - "description": "Where the results for this execution are written.\n@OutputOnly", - "$ref": "ToolResultsStep" - }, - "testSpecification": { - "description": "How to run the test.\n@OutputOnly", - "$ref": "TestSpecification" - }, - "projectId": { - "description": "The cloud project that owns the test execution.\n@OutputOnly", - "type": "string" } }, "id": "TestExecution" }, "GoogleCloudStorage": { + "id": "GoogleCloudStorage", "description": "A storage location within Google cloud storage (GCS).", "type": "object", "properties": { @@ -836,16 +391,11 @@ "description": "The path to a directory in GCS that will\neventually contain the results for this test.\nThe requesting user must have write access on the bucket in the supplied\npath.\nRequired", "type": "string" } - }, - "id": "GoogleCloudStorage" + } }, "RoboDirective": { - "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.", - "type": "object", "properties": { "actionType": { - "description": "The type of action that Robo should perform on the specified element.\nRequired.", - "type": "string", "enumDescriptions": [ "DO NOT USE. For proto versioning only.", "Direct Robo to click on the specified element. No-op if specified element\nis not clickable.", @@ -855,35 +405,27 @@ "ACTION_TYPE_UNSPECIFIED", "SINGLE_CLICK", "ENTER_TEXT" - ] + ], + "description": "The type of action that Robo should perform on the specified element.\nRequired.", + "type": "string" }, "resourceName": { - "description": "The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired", - "type": "string" + "type": "string", + "description": "The android resource name of the target UI element\nFor example,\n in Java: R.string.foo\n in xml: @string/foo\nOnly the “foo” part is needed.\nReference doc:\nhttps://developer.android.com/guide/topics/resources/accessing-resources.html\nRequired" }, "inputText": { "description": "The text that Robo is directed to set. If left empty, the directive will be\ntreated as a CLICK on the element matching the resource_name.\nOptional", "type": "string" } }, - "id": "RoboDirective" + "id": "RoboDirective", + "description": "Directs Robo to interact with a specific UI element if it is encountered\nduring the crawl. Currently, Robo can perform text entry or element click.", + "type": "object" }, "AndroidMatrix": { + "description": "A set of Android device configuration permutations is defined by the\nthe cross-product of the given axes. Internally, the given AndroidMatrix\nwill be expanded into a set of AndroidDevices.\n\nOnly supported permutations will be instantiated. Invalid permutations\n(e.g., incompatible models/versions) are ignored.", + "type": "object", "properties": { - "androidModelIds": { - "description": "The ids of the set of Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", - "type": "array", - "items": { - "type": "string" - } - }, - "orientations": { - "description": "The set of orientations to test with.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", - "type": "array", - "items": { - "type": "string" - } - }, "androidVersionIds": { "description": "The ids of the set of Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", "type": "array", @@ -897,49 +439,29 @@ "items": { "type": "string" } + }, + "androidModelIds": { + "description": "The ids of the set of Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", + "type": "array", + "items": { + "type": "string" + } + }, + "orientations": { + "description": "The set of orientations to test with.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", + "type": "array", + "items": { + "type": "string" + } } }, - "id": "AndroidMatrix", - "description": "A set of Android device configuration permutations is defined by the\nthe cross-product of the given axes. Internally, the given AndroidMatrix\nwill be expanded into a set of AndroidDevices.\n\nOnly supported permutations will be instantiated. Invalid permutations\n(e.g., incompatible models/versions) are ignored.", - "type": "object" + "id": "AndroidMatrix" }, "AndroidModel": { + "id": "AndroidModel", "description": "A description of an Android device tests may be run on.", "type": "object", "properties": { - "form": { - "description": "Whether this device is virtual or physical.\n@OutputOnly", - "type": "string", - "enumDescriptions": [ - "Do not use. For proto versioning only.", - "A software stack that simulates the device", - "Actual hardware" - ], - "enum": [ - "DEVICE_FORM_UNSPECIFIED", - "VIRTUAL", - "PHYSICAL" - ] - }, - "screenDensity": { - "description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly", - "format": "int32", - "type": "integer" - }, - "supportedVersionIds": { - "description": "The set of Android versions this device supports.\n@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, - "supportedAbis": { - "description": "The list of supported ABIs for this device.\nThis corresponds to either android.os.Build.SUPPORTED_ABIS (for API level\n21 and above) or android.os.Build.CPU_ABI/CPU_ABI2.\nThe most preferred ABI is the first element in the list.\n\nElements are optionally prefixed by \"version_id:\" (where version_id is\nthe id of an AndroidVersion), denoting an ABI that is supported only on\na particular version.\n@OutputOnly", - "type": "array", - "items": { - "type": "string" - } - }, "name": { "description": "The human-readable marketing name for this device model.\nExamples: \"Nexus 5\", \"Galaxy S5\"\n@OutputOnly", "type": "string" @@ -976,28 +498,46 @@ "description": "Screen size in the vertical (Y) dimension measured in pixels.\n@OutputOnly", "format": "int32", "type": "integer" - } - }, - "id": "AndroidModel" - }, - "TestSetup": { - "description": "A description of how to set up the device prior to running the test", - "type": "object", - "properties": { - "directoriesToPull": { - "description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.\n\nOptional", + }, + "form": { + "description": "Whether this device is virtual or physical.\n@OutputOnly", + "type": "string", + "enumDescriptions": [ + "Do not use. For proto versioning only.", + "A software stack that simulates the device", + "Actual hardware" + ], + "enum": [ + "DEVICE_FORM_UNSPECIFIED", + "VIRTUAL", + "PHYSICAL" + ] + }, + "screenDensity": { + "description": "Screen density in DPI.\nThis corresponds to ro.sf.lcd_density\n@OutputOnly", + "format": "int32", + "type": "integer" + }, + "supportedVersionIds": { + "description": "The set of Android versions this device supports.\n@OutputOnly", "type": "array", "items": { "type": "string" } }, - "filesToPush": { - "description": "List of files to push to the device before starting the test.\n\nOptional", + "supportedAbis": { + "description": "The list of supported ABIs for this device.\nThis corresponds to either android.os.Build.SUPPORTED_ABIS (for API level\n21 and above) or android.os.Build.CPU_ABI/CPU_ABI2.\nThe most preferred ABI is the first element in the list.\n\nElements are optionally prefixed by \"version_id:\" (where version_id is\nthe id of an AndroidVersion), denoting an ABI that is supported only on\na particular version.\n@OutputOnly", "type": "array", "items": { - "$ref": "DeviceFile" + "type": "string" } - }, + } + } + }, + "TestSetup": { + "description": "A description of how to set up the device prior to running the test", + "type": "object", + "properties": { "networkProfile": { "description": "The network traffic profile used for running the test.\nOptional", "type": "string" @@ -1012,14 +552,30 @@ "account": { "$ref": "Account", "description": "The device will be logged in on this account for the duration of the test.\nOptional" + }, + "directoriesToPull": { + "description": "List of directories on the device to upload to GCS at the end of the test;\nthey must be absolute paths under /sdcard or /data/local/tmp.\nPath names are restricted to characters a-z A-Z 0-9 _ - . + and /\n\nNote: The paths /sdcard and /data will be made available and treated as\nimplicit path substitutions. E.g. if /sdcard on a particular device does\nnot map to external storage, the system will replace it with the external\nstorage path prefix for that device.\n\nOptional", + "type": "array", + "items": { + "type": "string" + } + }, + "filesToPush": { + "description": "List of files to push to the device before starting the test.\n\nOptional", + "type": "array", + "items": { + "$ref": "DeviceFile" + } } }, "id": "TestSetup" }, "TestSpecification": { - "description": "A description of how to run the test.", - "type": "object", "properties": { + "disableVideoRecording": { + "description": "Disables video recording; may reduce test latency.", + "type": "boolean" + }, "testTimeout": { "description": "Max time a test execution is allowed to run before it is\nautomatically cancelled.\nOptional, default is 5 min.", "format": "google-duration", @@ -1029,10 +585,6 @@ "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and\nadd it to the device, before executing the test. Note that test accounts\nmight be reused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated\naccounts allows testing more functionalities.\nDefault is false.\nOptional", "type": "boolean" }, - "androidTestLoop": { - "$ref": "AndroidTestLoop", - "description": "An Android Application with a Test Loop" - }, "testSetup": { "$ref": "TestSetup", "description": "Test setup requirements e.g. files to install, bootstrap scripts\nOptional" @@ -1041,6 +593,10 @@ "$ref": "AndroidRoboTest", "description": "An Android robo test." }, + "androidTestLoop": { + "description": "An Android Application with a Test Loop", + "$ref": "AndroidTestLoop" + }, "androidInstrumentationTest": { "description": "An Android instrumentation test.", "$ref": "AndroidInstrumentationTest" @@ -1048,19 +604,76 @@ "disablePerformanceMetrics": { "description": "Disables performance metrics recording; may reduce test latency.", "type": "boolean" - }, - "disableVideoRecording": { - "description": "Disables video recording; may reduce test latency.", - "type": "boolean" } }, - "id": "TestSpecification" + "id": "TestSpecification", + "description": "A description of how to run the test.", + "type": "object" + }, + "ResultStorage": { + "description": "Locations where the results of running the test are stored.", + "type": "object", + "properties": { + "toolResultsHistory": { + "$ref": "ToolResultsHistory", + "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value." + }, + "googleCloudStorage": { + "$ref": "GoogleCloudStorage", + "description": "Required." + }, + "toolResultsExecution": { + "$ref": "ToolResultsExecution", + "description": "The tool results execution that results are written to.\n@OutputOnly" + } + }, + "id": "ResultStorage" }, "TestMatrix": { + "description": "A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.", + "type": "object", "properties": { + "state": { + "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly", + "type": "string", + "enumDescriptions": [ + "Do not use. For proto versioning only.", + "The execution or matrix is being validated.", + "The execution or matrix is waiting for resources to become available.", + "The execution is currently being processed.\n\nCan only be set on an execution.", + "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", + "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", + "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", + "The user cancelled the execution.\n\nCan only be set on an execution.", + "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" + ], + "enum": [ + "TEST_STATE_UNSPECIFIED", + "VALIDATING", + "PENDING", + "RUNNING", + "FINISHED", + "ERROR", + "UNSUPPORTED_ENVIRONMENT", + "INCOMPATIBLE_ENVIRONMENT", + "INCOMPATIBLE_ARCHITECTURE", + "CANCELLED", + "INVALID" + ] + }, + "projectId": { + "description": "The cloud project that owns the test matrix.\n@OutputOnly", + "type": "string" + }, + "testSpecification": { + "$ref": "TestSpecification", + "description": "How to run the test.\nRequired" + }, "clientInfo": { - "description": "Information about the client which invoked the test.\nOptional", - "$ref": "ClientInfo" + "$ref": "ClientInfo", + "description": "Information about the client which invoked the test.\nOptional" }, "testExecutions": { "description": "The list of test executions that the service creates for this matrix.\n@OutputOnly", @@ -1083,8 +696,8 @@ "type": "string" }, "resultStorage": { - "$ref": "ResultStorage", - "description": "Where the results for the matrix are written.\nRequired" + "description": "Where the results for the matrix are written.\nRequired", + "$ref": "ResultStorage" }, "invalidMatrixDetails": { "enumDescriptions": [ @@ -1107,7 +720,8 @@ "There was an error when parsing a label's value.", "The request contains a scenario number that was not declared in the\nmanifest.", "Device administrator applications are not allowed.", - "The APK is marked as \"testOnly\"." + "The APK is marked as \"testOnly\".", + "The input IPA could not be parsed." ], "enum": [ "INVALID_MATRIX_DETAILS_UNSPECIFIED", @@ -1129,83 +743,14 @@ "SCENARIO_LABEL_MALFORMED", "SCENARIO_NOT_DECLARED", "DEVICE_ADMIN_RECEIVER", - "TEST_ONLY_APK" + "TEST_ONLY_APK", + "MALFORMED_IPA" ], "description": "Describes why the matrix is considered invalid.\nOnly useful for matrices in the INVALID state.\n@OutputOnly", "type": "string" - }, - "state": { - "enum": [ - "TEST_STATE_UNSPECIFIED", - "VALIDATING", - "PENDING", - "RUNNING", - "FINISHED", - "ERROR", - "UNSUPPORTED_ENVIRONMENT", - "INCOMPATIBLE_ENVIRONMENT", - "INCOMPATIBLE_ARCHITECTURE", - "CANCELLED", - "INVALID" - ], - "description": "Indicates the current progress of the test matrix (e.g., FINISHED)\n@OutputOnly", - "type": "string", - "enumDescriptions": [ - "Do not use. For proto versioning only.", - "The execution or matrix is being validated.", - "The execution or matrix is waiting for resources to become available.", - "The execution is currently being processed.\n\nCan only be set on an execution.", - "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", - "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", - "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", - "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", - "The user cancelled the execution.\n\nCan only be set on an execution.", - "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" - ] - }, - "projectId": { - "description": "The cloud project that owns the test matrix.\n@OutputOnly", - "type": "string" - }, - "testSpecification": { - "$ref": "TestSpecification", - "description": "How to run the test.\nRequired" } }, - "id": "TestMatrix", - "description": "A group of one or more TestExecutions, built by taking a\nproduct of values over a pre-defined set of axes.", - "type": "object" - }, - "ResultStorage": { - "description": "Locations where the results of running the test are stored.", - "type": "object", - "properties": { - "toolResultsHistory": { - "description": "The tool results history that contains the tool results execution that\nresults are written to.\n\nOptional, if not provided the service will choose an appropriate value.", - "$ref": "ToolResultsHistory" - }, - "googleCloudStorage": { - "description": "Required.", - "$ref": "GoogleCloudStorage" - }, - "toolResultsExecution": { - "description": "The tool results execution that results are written to.\n@OutputOnly", - "$ref": "ToolResultsExecution" - } - }, - "id": "ResultStorage" - }, - "FileReference": { - "description": "A reference to a file, used for user inputs.", - "type": "object", - "properties": { - "gcsPath": { - "description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app-debug-unaligned.apk", - "type": "string" - } - }, - "id": "FileReference" + "id": "TestMatrix" }, "AndroidVersion": { "description": "A version of the Android OS", @@ -1228,12 +773,12 @@ } }, "id": { - "description": "An opaque id for this Android version.\nUse this id to invoke the TestExecutionService.\n@OutputOnly", - "type": "string" + "type": "string", + "description": "An opaque id for this Android version.\nUse this id to invoke the TestExecutionService.\n@OutputOnly" }, "releaseDate": { - "$ref": "Date", - "description": "The date this Android version became available in the market.\n@OutputOnly" + "description": "The date this Android version became available in the market.\n@OutputOnly", + "$ref": "Date" }, "versionString": { "description": "A string representing this version of the Android OS.\nExamples: \"4.3\", \"4.4\"\n@OutputOnly", @@ -1246,11 +791,22 @@ }, "id": "AndroidVersion" }, + "FileReference": { + "description": "A reference to a file, used for user inputs.", + "type": "object", + "properties": { + "gcsPath": { + "description": "A path to a file in Google Cloud Storage.\nExample: gs://build-app-1414623860166/app-debug-unaligned.apk", + "type": "string" + } + }, + "id": "FileReference" + }, "LauncherActivityIntent": { - "description": "Specifies an intent that starts the main launcher activity.", "type": "object", "properties": {}, - "id": "LauncherActivityIntent" + "id": "LauncherActivityIntent", + "description": "Specifies an intent that starts the main launcher activity." }, "TestDetails": { "description": "Additional details about the progress of the running test.", @@ -1279,8 +835,8 @@ "type": "string" }, "projectId": { - "description": "The cloud project that owns the tool results execution.\n@OutputOnly", - "type": "string" + "type": "string", + "description": "The cloud project that owns the tool results execution.\n@OutputOnly" }, "historyId": { "description": "A tool results history ID.\n@OutputOnly", @@ -1290,8 +846,6 @@ "id": "ToolResultsExecution" }, "ToolResultsHistory": { - "description": "Represents a tool results history resource.", - "type": "object", "properties": { "projectId": { "description": "The cloud project that owns the tool results history.\nRequired", @@ -1302,12 +856,25 @@ "type": "string" } }, - "id": "ToolResultsHistory" + "id": "ToolResultsHistory", + "description": "Represents a tool results history resource.", + "type": "object" }, "AndroidRoboTest": { - "description": "A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes.", "type": "object", "properties": { + "roboDirectives": { + "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional", + "type": "array", + "items": { + "$ref": "RoboDirective" + } + }, + "maxDepth": { + "description": "The max depth of the traversal stack Robo can explore. Needs to be at least\n2 to make Robo explore the app beyond the first activity.\nDefault is 50.\nOptional", + "format": "int32", + "type": "integer" + }, "appApk": { "$ref": "FileReference", "description": "The APK for the application under test.\nRequired" @@ -1323,73 +890,508 @@ "$ref": "RoboStartingIntent" } }, - "appInitialActivity": { - "description": "The initial activity that should be used to start the app.\nOptional", - "type": "string" - }, "maxSteps": { "description": "The max number of steps Robo can execute.\nDefault is no limit.\nOptional", "format": "int32", "type": "integer" }, - "roboDirectives": { - "description": "A set of directives Robo should apply during the crawl.\nThis allows users to customize the crawl. For example, the username and\npassword for a test account can be provided.\nOptional", - "type": "array", - "items": { - "$ref": "RoboDirective" - } - }, - "maxDepth": { - "description": "The max depth of the traversal stack Robo can explore. Needs to be at least\n2 to make Robo explore the app beyond the first activity.\nDefault is 50.\nOptional", - "format": "int32", - "type": "integer" + "appInitialActivity": { + "description": "The initial activity that should be used to start the app.\nOptional", + "type": "string" } }, - "id": "AndroidRoboTest" + "id": "AndroidRoboTest", + "description": "A test of an android application that explores the application on a virtual\nor physical Android Device, finding culprits and crashes as it goes." }, "Distribution": { + "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.", + "type": "object", "properties": { - "marketShare": { - "description": "The estimated fraction (0-1) of the total market with this configuration.\n@OutputOnly", - "format": "double", - "type": "number" - }, "measurementTime": { "description": "The time this distribution was measured.\n@OutputOnly", "format": "google-datetime", "type": "string" + }, + "marketShare": { + "description": "The estimated fraction (0-1) of the total market with this configuration.\n@OutputOnly", + "format": "double", + "type": "number" } }, - "id": "Distribution", - "description": "Data about the relative number of devices running a\ngiven configuration of the Android platform.", + "id": "Distribution" + }, + "Orientation": { + "description": "Screen orientation of the device.", + "type": "object", + "properties": { + "id": { + "description": "The id for this orientation.\nExample: \"portrait\"\n@OutputOnly", + "type": "string" + }, + "tags": { + "description": "Tags for this dimension.\nExamples: \"default\"", + "type": "array", + "items": { + "type": "string" + } + }, + "name": { + "description": "A human-friendly name for this orientation.\nExample: \"portrait\"\n@OutputOnly", + "type": "string" + } + }, + "id": "Orientation" + }, + "NetworkConfigurationCatalog": { + "type": "object", + "properties": { + "configurations": { + "type": "array", + "items": { + "$ref": "NetworkConfiguration" + } + } + }, + "id": "NetworkConfigurationCatalog" + }, + "AndroidTestLoop": { + "type": "object", + "properties": { + "scenarios": { + "type": "array", + "items": { + "format": "int32", + "type": "integer" + }, + "description": "The list of scenarios that should be run during the test.\nOptional, default is all test loops, derived from the application's\nmanifest." + }, + "scenarioLabels": { + "description": "The list of scenario labels that should be run during the test.\nThe scenario labels should map to labels defined in the application's\nmanifest. For example, player_experience and\ncom.google.test.loops.player_experience add all of the loops labeled in the\nmanifest with the com.google.test.loops.player_experience name to the\nexecution.\nOptional. Scenarios can also be specified in the scenarios field.", + "type": "array", + "items": { + "type": "string" + } + }, + "appApk": { + "$ref": "FileReference", + "description": "The APK for the application under test.\nRequired" + }, + "appPackageId": { + "type": "string", + "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest." + } + }, + "id": "AndroidTestLoop", + "description": "A test of an Android Application with a Test Loop.\nThe intent \u003cintent-name\u003e will be implicitly added, since Games is the only\nuser of this api, for the time being." + }, + "GoogleAuto": { + "description": "Enables automatic Google account login.\nIf set, the service will automatically generate a Google test account and add\nit to the device, before executing the test. Note that test accounts might be\nreused.\nMany applications show their full set of functionalities when an account is\npresent on the device. Logging into the device with these generated accounts\nallows testing more functionalities.", + "type": "object", + "properties": {}, + "id": "GoogleAuto" + }, + "AndroidDeviceCatalog": { + "description": "The currently supported Android devices.", + "type": "object", + "properties": { + "models": { + "description": "The set of supported Android device models.\n@OutputOnly", + "type": "array", + "items": { + "$ref": "AndroidModel" + } + }, + "versions": { + "description": "The set of supported Android OS versions.\n@OutputOnly", + "type": "array", + "items": { + "$ref": "AndroidVersion" + } + }, + "runtimeConfiguration": { + "$ref": "AndroidRuntimeConfiguration", + "description": "The set of supported runtime configurations.\n@OutputOnly" + } + }, + "id": "AndroidDeviceCatalog" + }, + "AndroidDeviceList": { + "description": "A list of Android device configurations in which the test is to be executed.", + "type": "object", + "properties": { + "androidDevices": { + "description": "A list of Android devices\nRequired", + "type": "array", + "items": { + "$ref": "AndroidDevice" + } + } + }, + "id": "AndroidDeviceList" + }, + "ClientInfo": { + "description": "Information about the client which invoked the test.", + "type": "object", + "properties": { + "clientInfoDetails": { + "description": "The list of detailed information about client.", + "type": "array", + "items": { + "$ref": "ClientInfoDetail" + } + }, + "name": { + "description": "Client name, such as gcloud.\nRequired", + "type": "string" + } + }, + "id": "ClientInfo" + }, + "EnvironmentMatrix": { + "id": "EnvironmentMatrix", + "description": "The matrix of environments in which the test is to be executed.", + "type": "object", + "properties": { + "androidDeviceList": { + "description": "A list of Android devices; the test will be run only on the specified\ndevices.", + "$ref": "AndroidDeviceList" + }, + "androidMatrix": { + "$ref": "AndroidMatrix", + "description": "A matrix of Android devices." + } + } + }, + "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`.", + "type": "object", + "properties": { + "year": { + "type": "integer", + "description": "Year of date. Must be from 1 to 9999, or 0 if specifying a date without\na year.", + "format": "int32" + }, + "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" + } + }, + "id": "Date" + }, + "CancelTestMatrixResponse": { + "properties": { + "testState": { + "type": "string", + "enumDescriptions": [ + "Do not use. For proto versioning only.", + "The execution or matrix is being validated.", + "The execution or matrix is waiting for resources to become available.", + "The execution is currently being processed.\n\nCan only be set on an execution.", + "The execution or matrix has terminated normally.\n\nOn a matrix this means that the matrix level processing completed normally,\nbut individual executions may be in an ERROR state.", + "The execution or matrix has stopped because it encountered an\ninfrastructure failure.", + "The execution was not run because it corresponds to a unsupported\nenvironment.\n\nCan only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with\nthe requested environment.\n\nExample: requested AndroidVersion is lower than APK's minSdkVersion\n\nCan only be set on an execution.", + "The execution was not run because the provided inputs are incompatible with\nthe requested architecture.\n\nExample: requested device does not support running the native code in\nthe supplied APK\n\nCan only be set on an execution.", + "The user cancelled the execution.\n\nCan only be set on an execution.", + "The execution or matrix was not run because the provided inputs are not\nvalid.\n\nExamples: input file is not of the expected type, is malformed/corrupt, or\nwas flagged as malware" + ], + "enum": [ + "TEST_STATE_UNSPECIFIED", + "VALIDATING", + "PENDING", + "RUNNING", + "FINISHED", + "ERROR", + "UNSUPPORTED_ENVIRONMENT", + "INCOMPATIBLE_ENVIRONMENT", + "INCOMPATIBLE_ARCHITECTURE", + "CANCELLED", + "INVALID" + ], + "description": "The current rolled-up state of the test matrix.\nIf this state is already final, then the cancelation request will\nhave no effect." + } + }, + "id": "CancelTestMatrixResponse", + "description": "Response containing the current state of the specified test matrix.", "type": "object" + }, + "RoboStartingIntent": { + "description": "Message for specifying the start activities to crawl", + "type": "object", + "properties": { + "startActivity": { + "$ref": "StartActivityIntent" + }, + "launcherActivity": { + "$ref": "LauncherActivityIntent" + } + }, + "id": "RoboStartingIntent" + }, + "StartActivityIntent": { + "description": "A starting intent specified by an action, uri, and categories.", + "type": "object", + "properties": { + "uri": { + "description": "URI for the action.\nOptional.", + "type": "string" + }, + "categories": { + "description": "Intent categories to set on the intent.\nOptional.", + "type": "array", + "items": { + "type": "string" + } + }, + "action": { + "type": "string", + "description": "Action name.\nRequired for START_ACTIVITY." + } + }, + "id": "StartActivityIntent" + }, + "Account": { + "id": "Account", + "description": "Identifies an account and how to log into it", + "type": "object", + "properties": { + "googleAuto": { + "$ref": "GoogleAuto", + "description": "An automatic google login account" + } + } + }, + "TestEnvironmentCatalog": { + "description": "A description of a test environment.", + "type": "object", + "properties": { + "androidDeviceCatalog": { + "$ref": "AndroidDeviceCatalog", + "description": "Android devices suitable for running Android Instrumentation Tests." + }, + "networkConfigurationCatalog": { + "$ref": "NetworkConfigurationCatalog", + "description": "Supported network configurations" + } + }, + "id": "TestEnvironmentCatalog" + }, + "Locale": { + "id": "Locale", + "description": "A location/region designation for language.", + "type": "object", + "properties": { + "name": { + "description": "A human-friendly name for this language/locale.\nExample: \"English\"\n@OutputOnly", + "type": "string" + }, + "id": { + "description": "The id for this locale.\nExample: \"en_US\"\n@OutputOnly", + "type": "string" + }, + "tags": { + "description": "Tags for this dimension.\nExamples: \"default\"", + "type": "array", + "items": { + "type": "string" + } + }, + "region": { + "description": "A human-friendly string representing the region for this locale.\nExample: \"United States\"\nNot present for every locale.\n@OutputOnly", + "type": "string" + } + } + }, + "ObbFile": { + "properties": { + "obbFileName": { + "description": "OBB file name which must conform to the format as specified by\nAndroid\ne.g. [main|patch].0300110.com.example.android.obb\nwhich will be installed into\n \u003cshared-storage\u003e/Android/obb/\u003cpackage-name\u003e/\non the device\nRequired", + "type": "string" + }, + "obb": { + "description": "Opaque Binary Blob (OBB) file(s) to install on the device\nRequired", + "$ref": "FileReference" + } + }, + "id": "ObbFile", + "description": "An opaque binary blob file to install on the device before the test starts", + "type": "object" + }, + "AndroidRuntimeConfiguration": { + "type": "object", + "properties": { + "orientations": { + "description": "The set of available orientations.\n@OutputOnly", + "type": "array", + "items": { + "$ref": "Orientation" + } + }, + "locales": { + "description": "The set of available locales.\n@OutputOnly", + "type": "array", + "items": { + "$ref": "Locale" + } + } + }, + "id": "AndroidRuntimeConfiguration", + "description": "Configuration that can be selected at the time a test is run." + }, + "AndroidDevice": { + "id": "AndroidDevice", + "description": "A single Android device.", + "type": "object", + "properties": { + "androidModelId": { + "description": "The id of the Android device to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", + "type": "string" + }, + "androidVersionId": { + "description": "The id of the Android OS version to be used.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", + "type": "string" + }, + "orientation": { + "description": "How the device is oriented during the test.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", + "type": "string" + }, + "locale": { + "description": "The locale the test device used for testing.\nUse the EnvironmentDiscoveryService to get supported options.\nRequired", + "type": "string" + } + } + }, + "NetworkConfiguration": { + "type": "object", + "properties": { + "id": { + "description": "The unique opaque id for this network traffic configuration\n@OutputOnly", + "type": "string" + }, + "upRule": { + "$ref": "TrafficRule", + "description": "The emulation rule applying to the upload traffic" + }, + "downRule": { + "description": "The emulation rule applying to the download traffic", + "$ref": "TrafficRule" + } + }, + "id": "NetworkConfiguration" + }, + "ToolResultsStep": { + "type": "object", + "properties": { + "executionId": { + "description": "A tool results execution ID.\n@OutputOnly", + "type": "string" + }, + "stepId": { + "description": "A tool results step ID.\n@OutputOnly", + "type": "string" + }, + "projectId": { + "description": "The cloud project that owns the tool results step.\n@OutputOnly", + "type": "string" + }, + "historyId": { + "description": "A tool results history ID.\n@OutputOnly", + "type": "string" + } + }, + "id": "ToolResultsStep", + "description": "Represents a tool results step resource.\n\nThis has the results of a TestExecution." + }, + "TrafficRule": { + "description": "Network emulation parameters", + "type": "object", + "properties": { + "packetDuplicationRatio": { + "description": "Packet duplication ratio (0.0 - 1.0)", + "format": "float", + "type": "number" + }, + "delay": { + "type": "string", + "description": "Packet delay, must be \u003e= 0", + "format": "google-duration" + }, + "packetLossRatio": { + "description": "Packet loss ratio (0.0 - 1.0)", + "format": "float", + "type": "number" + }, + "burst": { + "description": "Burst size in kbits", + "format": "float", + "type": "number" + }, + "bandwidth": { + "description": "Bandwidth in kbits/second", + "format": "float", + "type": "number" + } + }, + "id": "TrafficRule" + }, + "AndroidInstrumentationTest": { + "description": "A test of an Android application that can control an Android component\nindependently of its normal lifecycle.\nAndroid instrumentation tests run an application APK and test APK inside the\nsame process on a virtual or physical AndroidDevice. They also specify\na test runner class, such as com.google.GoogleTestRunner, which can vary\non the specific instrumentation framework chosen.\n\nSee \u003chttp://developer.android.com/tools/testing/testing_android.html\u003e for\nmore information on types of Android tests.", + "type": "object", + "properties": { + "testApk": { + "$ref": "FileReference", + "description": "The APK containing the test code to be executed.\nRequired" + }, + "testRunnerClass": { + "type": "string", + "description": "The InstrumentationTestRunner class.\nOptional, default is determined by examining the application's manifest." + }, + "testPackageId": { + "description": "The java package for the test to be executed.\nOptional, default is determined by examining the application's manifest.", + "type": "string" + }, + "appPackageId": { + "description": "The java package for the application under test.\nOptional, default is determined by examining the application's manifest.", + "type": "string" + }, + "appApk": { + "$ref": "FileReference", + "description": "The APK for the application under test.\nRequired" + }, + "orchestratorOption": { + "description": "The option of whether running each test within its own invocation of\ninstrumentation with Android Test Orchestrator or not.\n** Orchestrator is only compatible with AndroidJUnitRunner version 1.0 or\nhigher! **\nOrchestrator offers the following benefits:\n - No shared state\n - Crashes are isolated\n - Logs are scoped per test\n\nSee\n\u003chttps://developer.android.com/training/testing/junit-runner.html#using-android-test-orchestrator\u003e\nfor more information about Android Test Orchestrator.\n\nOptional, if empty, test will be run without orchestrator.", + "type": "string", + "enumDescriptions": [ + "This means that the server should choose the mode. And test will be run\nwithout orchestrator.\nUsing orchestrator is highly encouraged because of all the benefits it\noffers. And in the future, all instrumentation tests will be run with\norchestrator by default if preference unspecified.", + "Run test using orchestrator.\n** Only compatible with AndroidJUnitRunner version 1.0 or higher! **\nRecommended.", + "Run test without using orchestrator." + ], + "enum": [ + "ORCHESTRATOR_OPTION_UNSPECIFIED", + "USE_ORCHESTRATOR", + "DO_NOT_USE_ORCHESTRATOR" + ] + }, + "testTargets": { + "description": "Each target must be fully qualified with the package name or class name,\nin one of these formats:\n - \"package package_name\"\n - \"class package_name.class_name\"\n - \"class package_name.class_name#method_name\"\n\nOptional, if empty, all targets in the module will be run.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "id": "AndroidInstrumentationTest" } }, + "protocol": "rest", "icons": { "x32": "http://www.google.com/images/icons/product/search-32.gif", "x16": "http://www.google.com/images/icons/product/search-16.gif" - }, - "protocol": "rest", - "version": "v1", - "baseUrl": "https://testing.googleapis.com/", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" - }, - "https://www.googleapis.com/auth/cloud-platform.read-only": { - "description": "View your data across Google Cloud Platform services" - } - } - } - }, - "kind": "discovery#restDescription", - "description": "Allows developers to run automated tests for their mobile applications on Google infrastructure.", - "servicePath": "", - "rootUrl": "https://testing.googleapis.com/", - "basePath": "", - "ownerDomain": "google.com", - "name": "testing", - "batchPath": "batch" + } }
diff --git a/testing/v1/testing-gen.go b/testing/v1/testing-gen.go index 1eed8b8..f413512 100644 --- a/testing/v1/testing-gen.go +++ b/testing/v1/testing-gen.go
@@ -1828,6 +1828,7 @@ // "DEVICE_ADMIN_RECEIVER" - Device administrator applications are not // allowed. // "TEST_ONLY_APK" - The APK is marked as "testOnly". + // "MALFORMED_IPA" - The input IPA could not be parsed. InvalidMatrixDetails string `json:"invalidMatrixDetails,omitempty"` // ProjectId: The cloud project that owns the test matrix.
diff --git a/tpu/v1alpha1/tpu-api.json b/tpu/v1alpha1/tpu-api.json index 1a4c24c..514367f 100644 --- a/tpu/v1alpha1/tpu-api.json +++ b/tpu/v1alpha1/tpu-api.json
@@ -1,215 +1,7 @@ { - "version": "v1alpha1", - "baseUrl": "https://tpu.googleapis.com/", - "kind": "discovery#restDescription", - "description": "TPU API provides customers with access to Google TPU technology.", - "servicePath": "", - "basePath": "", - "id": "tpu:v1alpha1", - "documentationLink": "https://cloud.google.com/tpu/", - "revision": "20171218", - "discoveryVersion": "v1", - "version_module": true, "schemas": { - "NetworkEndpoint": { - "description": "A network endpoint over which a TPU worker can be reached.", - "type": "object", - "properties": { - "ipAddress": { - "description": "The IP address of this network endpoint.", - "type": "string" - }, - "port": { - "description": "The port of this network endpoint.", - "format": "int32", - "type": "integer" - } - }, - "id": "NetworkEndpoint" - }, - "Operation": { - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object", - "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": { - "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", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", - "type": "object" - } - }, - "id": "Operation" - }, - "ListNodesResponse": { - "description": "Response for ListNodes.", - "type": "object", - "properties": { - "nodes": { - "description": "The listed nodes.", - "type": "array", - "items": { - "$ref": "Node" - } - }, - "nextPageToken": { - "description": "The next page token or empty if none.", - "type": "string" - } - }, - "id": "ListNodesResponse" - }, - "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.", - "type": "object", - "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" - }, - "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", - "type": "array", - "items": { - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "type": "object" - } - } - }, - "id": "Status" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "ReimageNodeRequest": { - "description": "Request for ReimageNode.", - "type": "object", - "properties": { - "tensorflowVersion": { - "description": "The version for reimage to create.", - "type": "string" - } - }, - "id": "ReimageNodeRequest" - }, - "Location": { - "description": "A resource that represents Google Cloud Platform location.", - "type": "object", - "properties": { - "labels": { - "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", - "type": "object", - "additionalProperties": { - "type": "string" - } - }, - "name": { - "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", - "type": "string" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", - "type": "string" - }, - "metadata": { - "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - } - } - }, - "id": "Location" - }, - "ListOperationsResponse": { - "description": "The response message for Operations.ListOperations.", - "type": "object", - "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.", - "type": "array", - "items": { - "$ref": "Operation" - } - } - }, - "id": "ListOperationsResponse" - }, - "OperationMetadata": { - "description": "Represents the metadata of the long-running operation.", - "type": "object", - "properties": { - "createTime": { - "description": "[Output only] The time the operation was created.", - "format": "google-datetime", - "type": "string" - }, - "statusDetail": { - "description": "[Output only] Human-readable status of the operation, if any.", - "type": "string" - }, - "apiVersion": { - "description": "[Output only] API version used to start the operation.", - "type": "string" - }, - "target": { - "description": "[Output only] Server-defined resource path for the target of the operation.", - "type": "string" - }, - "endTime": { - "description": "[Output only] The time the operation finished running.", - "format": "google-datetime", - "type": "string" - }, - "cancelRequested": { - "description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", - "type": "boolean" - }, - "verb": { - "description": "[Output only] Name of the verb executed by the operation.", - "type": "string" - } - }, - "id": "OperationMetadata" - }, "ListLocationsResponse": { + "id": "ListLocationsResponse", "description": "The response message for Locations.ListLocations.", "type": "object", "properties": { @@ -224,8 +16,7 @@ "$ref": "Location" } } - }, - "id": "ListLocationsResponse" + } }, "ResetNodeRequest": { "description": "Request for ResetNode.", @@ -234,11 +25,44 @@ "id": "ResetNodeRequest" }, "Node": { + "id": "Node", "description": "A TPU instance.", "type": "object", "properties": { - "cidrBlock": { - "description": "The CIDR block that the TPU node will use when selecting //an IP address.\nThis CIDR block must be a /29 block; the GCE networks API forbids a smaller\nblock, and using a larger block would be wasteful (a node can only consume\none IP address). Errors will occur if the CIDR block has already been used\nfor a currently existing TPU node, the CIDR block conflicts with any\nsubnetworks in the user's provided network, or the provided network is\npeered with another network that is using that CIDR block.\nRequired.", + "port": { + "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network port for the TPU Node as visible to GCE instances.", + "type": "string" + }, + "serviceAccount": { + "description": "Output only.\nThe service account used to run the tensor flow services within the node.\nTo share resources, including Google Cloud Storage data, with the\nTensorflow job running in the Node, this account must have permissions to\nthat data.", + "type": "string" + }, + "network": { + "description": "The name of a network they wish to peer the TPU node to. It must be a\npreexisting GCE network inside of the project on which this API has been\nactivated. If none is provided, \"default\" will be used.", + "type": "string" + }, + "healthDescription": { + "description": "Output only.\nIf this field is populated, it contains a description of why the TPU Node\nis unhealthy.", + "type": "string" + }, + "health": { + "description": "The health status of the TPU node.", + "type": "string", + "enumDescriptions": [ + "Health status is unknown: not initialized or failed to retrieve.", + "The resource is healthy.", + "The resource is unhealthy.", + "The resource is unresponsive." + ], + "enum": [ + "HEALTH_UNSPECIFIED", + "HEALTHY", + "UNHEALTHY", + "TIMEOUT" + ] + }, + "ipAddress": { + "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to GCE instances.", "type": "string" }, "createTime": { @@ -246,6 +70,10 @@ "format": "google-datetime", "type": "string" }, + "cidrBlock": { + "description": "The CIDR block that the TPU node will use when selecting //an IP address.\nThis CIDR block must be a /29 block; the GCE networks API forbids a smaller\nblock, and using a larger block would be wasteful (a node can only consume\none IP address). Errors will occur if the CIDR block has already been used\nfor a currently existing TPU node, the CIDR block conflicts with any\nsubnetworks in the user's provided network, or the provided network is\npeered with another network that is using that CIDR block.\nRequired.", + "type": "string" + }, "tensorflowVersion": { "description": "The version of Tensorflow running in the Node.\nRequired.", "type": "string" @@ -283,52 +111,213 @@ "description": "Output only.\nThe current state for the TPU Node.", "type": "string" }, - "acceleratorType": { - "description": "The type of hardware accelerators associated with this node.\nRequired.", - "type": "string" - }, "name": { "description": "Output only.\nThe immutable name of the TPU", "type": "string" }, - "port": { - "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network port for the TPU Node as visible to GCE instances.", + "acceleratorType": { + "description": "The type of hardware accelerators associated with this node.\nRequired.", "type": "string" - }, - "serviceAccount": { - "description": "Output only.\nThe service account used to run the tensor flow services within the node.\nTo share resources, including Google Cloud Storage data, with the\nTensorflow job running in the Node, this account must have permissions to\nthat data.", - "type": "string" - }, - "healthDescription": { - "description": "Output only.\nIf this field is populated, it contains a description of why the TPU Node\nis unhealthy.", - "type": "string" - }, - "network": { - "description": "The name of a network they wish to peer the TPU node to. It must be a\npreexisting GCE network inside of the project on which this API has been\nactivated. If none is provided, \"default\" will be used.", - "type": "string" - }, - "health": { - "description": "The health status of the TPU node.", - "type": "string", - "enumDescriptions": [ - "Health status is unknown: not initialized or failed to retrieve.", - "The resource is healthy.", - "The resource is unhealthy.", - "The resource is unresponsive." - ], - "enum": [ - "HEALTH_UNSPECIFIED", - "HEALTHY", - "UNHEALTHY", - "TIMEOUT" - ] - }, + } + } + }, + "NetworkEndpoint": { + "description": "A network endpoint over which a TPU worker can be reached.", + "type": "object", + "properties": { "ipAddress": { - "description": "Output only.\nDEPRECATED! Use network_endpoints instead.\nThe network address for the TPU Node as visible to GCE instances.", + "description": "The IP address of this network endpoint.", + "type": "string" + }, + "port": { + "description": "The port of this network endpoint.", + "format": "int32", + "type": "integer" + } + }, + "id": "NetworkEndpoint" + }, + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", + "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.", + "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\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/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": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object" + } + }, + "id": "Operation" + }, + "ListNodesResponse": { + "id": "ListNodesResponse", + "description": "Response for ListNodes.", + "type": "object", + "properties": { + "nodes": { + "description": "The listed nodes.", + "type": "array", + "items": { + "$ref": "Node" + } + }, + "nextPageToken": { + "description": "The next page token or empty if none.", + "type": "string" + } + } + }, + "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.", + "type": "object", + "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 is a common set of\nmessage types for APIs to use.", + "type": "array", + "items": { + "type": "object", + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + } + } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" + } + }, + "id": "Status" + }, + "Empty": { + "id": "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 `{}`.", + "type": "object", + "properties": {} + }, + "ReimageNodeRequest": { + "description": "Request for ReimageNode.", + "type": "object", + "properties": { + "tensorflowVersion": { + "description": "The version for reimage to create.", "type": "string" } }, - "id": "Node" + "id": "ReimageNodeRequest" + }, + "Location": { + "id": "Location", + "description": "A resource that represents Google Cloud Platform location.", + "type": "object", + "properties": { + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" + }, + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "type": "string" + }, + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", + "type": "object" + } + } + }, + "ListOperationsResponse": { + "id": "ListOperationsResponse", + "description": "The response message for Operations.ListOperations.", + "type": "object", + "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.", + "type": "array", + "items": { + "$ref": "Operation" + } + } + } + }, + "OperationMetadata": { + "id": "OperationMetadata", + "description": "Represents the metadata of the long-running operation.", + "type": "object", + "properties": { + "verb": { + "description": "[Output only] Name of the verb executed by the operation.", + "type": "string" + }, + "createTime": { + "description": "[Output only] The time the operation was created.", + "format": "google-datetime", + "type": "string" + }, + "statusDetail": { + "description": "[Output only] Human-readable status of the operation, if any.", + "type": "string" + }, + "apiVersion": { + "description": "[Output only] API version used to start the operation.", + "type": "string" + }, + "target": { + "description": "[Output only] Server-defined resource path for the target of the operation.", + "type": "string" + }, + "endTime": { + "description": "[Output only] The time the operation finished running.", + "format": "google-datetime", + "type": "string" + }, + "cancelRequested": { + "description": "[Output only] Identifies whether the user has requested cancellation\nof the operation. Operations that have successfully been cancelled\nhave Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "type": "boolean" + } + } } }, "protocol": "rest", @@ -359,15 +348,26 @@ "locations": { "methods": { "list": { - "description": "Lists information about the supported locations for this service.", - "httpMethod": "GET", "response": { "$ref": "ListLocationsResponse" }, "parameterOrder": [ "name" ], + "httpMethod": "GET", "parameters": { + "name": { + "description": "The resource that owns the locations collection, if applicable.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, "pageSize": { "description": "The standard list page size.", "format": "int32", @@ -375,19 +375,7 @@ "location": "query" }, "filter": { - "location": "query", "description": "The standard list filter.", - "type": "string" - }, - "name": { - "location": "path", - "description": "The resource that owns the locations collection, if applicable.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "pageToken": { - "description": "The standard list page token.", "type": "string", "location": "query" } @@ -396,162 +384,40 @@ "https://www.googleapis.com/auth/cloud-platform" ], "flatPath": "v1alpha1/projects/{projectsId}/locations", + "path": "v1alpha1/{+name}/locations", "id": "tpu.projects.locations.list", - "path": "v1alpha1/{+name}/locations" + "description": "Lists information about the supported locations for this service." }, "get": { + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "Resource name for the location.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}", "id": "tpu.projects.locations.get", "path": "v1alpha1/{+name}", "description": "Get information about a location.", "httpMethod": "GET", - "response": { - "$ref": "Location" - }, "parameterOrder": [ "name" ], - "parameters": { - "name": { - "description": "Resource name for the location.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "response": { + "$ref": "Location" + } } }, "resources": { - "operations": { - "methods": { - "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.", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageSize": { - "location": "query", - "description": "The standard list page size.", - "format": "int32", - "type": "integer" - }, - "filter": { - "description": "The standard list filter.", - "type": "string", - "location": "query" - }, - "name": { - "description": "The name of the operation's parent resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - } - }, - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations", - "path": "v1alpha1/{+name}/operations", - "id": "tpu.projects.locations.operations.list" - }, - "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.", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" - } - }, - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "path": "v1alpha1/{+name}", - "id": "tpu.projects.locations.operations.get" - }, - "cancel": { - "httpMethod": "POST", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "description": "The name of the operation resource to be cancelled.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", - "id": "tpu.projects.locations.operations.cancel", - "path": "v1alpha1/{+name}:cancel", - "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`." - }, - "delete": { - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "DELETE", - "parameters": { - "name": { - "location": "path", - "description": "The name of the operation resource to be deleted.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", - "path": "v1alpha1/{+name}", - "id": "tpu.projects.locations.operations.delete", - "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`." - } - } - }, "nodes": { "methods": { "delete": { - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", - "path": "v1alpha1/{+name}", - "id": "tpu.projects.locations.nodes.delete", "description": "Deletes a node.", "response": { "$ref": "Operation" @@ -562,21 +428,21 @@ "httpMethod": "DELETE", "parameters": { "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", + "location": "path", "description": "The resource name.", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", - "location": "path" + "type": "string" } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", + "path": "v1alpha1/{+name}", + "id": "tpu.projects.locations.nodes.delete" }, "reset": { - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reset", - "path": "v1alpha1/{+name}:reset", - "id": "tpu.projects.locations.nodes.reset", "description": "Resets a node, which stops and starts the VM.", "request": { "$ref": "ResetNodeRequest" @@ -593,40 +459,36 @@ ], "parameters": { "name": { - "location": "path", "description": "The resource name.", "required": true, "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$" + "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", + "location": "path" } - } + }, + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reset", + "path": "v1alpha1/{+name}:reset", + "id": "tpu.projects.locations.nodes.reset" }, "list": { - "response": { - "$ref": "ListNodesResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", "parameters": { + "parent": { + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path", + "description": "The parent resource name.", + "required": true, + "type": "string" + }, + "pageToken": { + "location": "query", + "description": "The next_page_token value returned from a previous List request, if any.", + "type": "string" + }, "pageSize": { "location": "query", "description": "The maximum number of items to return.", "format": "int32", "type": "integer" - }, - "parent": { - "location": "path", - "description": "The parent resource name.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - }, - "pageToken": { - "description": "The next_page_token value returned from a previous List request, if any.", - "type": "string", - "location": "query" } }, "scopes": [ @@ -635,49 +497,22 @@ "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes", "path": "v1alpha1/{+parent}/nodes", "id": "tpu.projects.locations.nodes.list", - "description": "Lists nodes." - }, - "create": { - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes", - "id": "tpu.projects.locations.nodes.create", - "path": "v1alpha1/{+parent}/nodes", - "request": { - "$ref": "Node" + "description": "Lists nodes.", + "response": { + "$ref": "ListNodesResponse" }, - "description": "Creates a node.", - "httpMethod": "POST", "parameterOrder": [ "parent" ], - "response": { - "$ref": "Operation" - }, - "parameters": { - "parent": { - "location": "path", - "description": "The parent resource name.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - }, - "nodeId": { - "description": "The unqualified resource name.", - "type": "string", - "location": "query" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] + "httpMethod": "GET" }, "reimage": { - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage", "path": "v1alpha1/{+name}:reimage", "id": "tpu.projects.locations.nodes.reimage", - "description": "Reimage a node's OS.", "request": { "$ref": "ReimageNodeRequest" }, + "description": "Reimage a node's OS.", "response": { "$ref": "Operation" }, @@ -685,31 +520,6 @@ "name" ], "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The resource name.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$" - } - } - }, - "get": { - "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", - "path": "v1alpha1/{+name}", - "id": "tpu.projects.locations.nodes.get", - "description": "Gets the details of a node.", - "response": { - "$ref": "Node" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", "parameters": { "name": { "description": "The resource name.", @@ -721,7 +531,186 @@ }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ] + ], + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}:reimage" + }, + "create": { + "httpMethod": "POST", + "parameterOrder": [ + "parent" + ], + "response": { + "$ref": "Operation" + }, + "parameters": { + "parent": { + "description": "The parent resource name.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" + }, + "nodeId": { + "description": "The unqualified resource name.", + "type": "string", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes", + "id": "tpu.projects.locations.nodes.create", + "path": "v1alpha1/{+parent}/nodes", + "request": { + "$ref": "Node" + }, + "description": "Creates a node." + }, + "get": { + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/nodes/[^/]+$", + "location": "path", + "description": "The resource name.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/nodes/{nodesId}", + "path": "v1alpha1/{+name}", + "id": "tpu.projects.locations.nodes.get", + "description": "Gets the details of a node.", + "response": { + "$ref": "Node" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET" + } + } + }, + "operations": { + "methods": { + "cancel": { + "path": "v1alpha1/{+name}:cancel", + "id": "tpu.projects.locations.operations.cancel", + "description": "Starts asynchronous cancellation on a long-running operation. The server\nmakes a best effort to cancel the operation, but success is not\nguaranteed. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`. Clients can use\nOperations.GetOperation or\nother methods to check whether the cancellation succeeded or whether the\noperation completed despite cancellation. On successful cancellation,\nthe operation is not deleted; instead, it becomes an operation with\nan Operation.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be cancelled.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel" + }, + "delete": { + "description": "Deletes a long-running operation. This method indicates that the client is\nno longer interested in the operation result. It does not cancel the\noperation. If the server doesn't support this method, it returns\n`google.rpc.Code.UNIMPLEMENTED`.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource to be deleted.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "path": "v1alpha1/{+name}", + "id": "tpu.projects.locations.operations.delete" + }, + "list": { + "path": "v1alpha1/{+name}/operations", + "id": "tpu.projects.locations.operations.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.", + "response": { + "$ref": "ListOperationsResponse" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET", + "parameters": { + "filter": { + "location": "query", + "description": "The standard list filter.", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "required": true, + "type": "string", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "location": "path" + }, + "pageToken": { + "description": "The standard list page token.", + "type": "string", + "location": "query" + }, + "pageSize": { + "description": "The standard list page size.", + "format": "int32", + "type": "integer", + "location": "query" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations" + }, + "get": { + "parameters": { + "name": { + "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", + "location": "path", + "description": "The name of the operation resource.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ], + "flatPath": "v1alpha1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", + "path": "v1alpha1/{+name}", + "id": "tpu.projects.locations.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.", + "response": { + "$ref": "Operation" + }, + "parameterOrder": [ + "name" + ], + "httpMethod": "GET" } } } @@ -731,35 +720,38 @@ } }, "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, + "bearer_token": { + "location": "query", + "description": "OAuth bearer token.", + "type": "string" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, "uploadType": { "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string" }, - "callback": { + "fields": { "location": "query", - "description": "JSONP", + "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, "$.xgafv": { - "description": "V1 error format.", - "type": "string", "enumDescriptions": [ "v1 error format", "v2 error format" @@ -768,9 +760,22 @@ "enum": [ "1", "2" - ] + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" }, "alt": { + "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", "description": "Data format for response.", "default": "json", "enum": [ @@ -778,18 +783,12 @@ "media", "proto" ], - "type": "string", - "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": { + "location": "query", "description": "OAuth access token.", - "type": "string", - "location": "query" + "type": "string" }, "key": { "location": "query", @@ -797,25 +796,26 @@ "type": "string" }, "quotaUser": { - "location": "query", "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.", - "type": "string" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", + "type": "string", "location": "query" }, - "bearer_token": { + "pp": { "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" } - } + }, + "version": "v1alpha1", + "baseUrl": "https://tpu.googleapis.com/", + "servicePath": "", + "description": "TPU API provides customers with access to Google TPU technology.", + "kind": "discovery#restDescription", + "basePath": "", + "documentationLink": "https://cloud.google.com/tpu/", + "id": "tpu:v1alpha1", + "revision": "20171218", + "discoveryVersion": "v1", + "version_module": true }
diff --git a/translate/v2/translate-api.json b/translate/v2/translate-api.json index 13e8b02..a611fc0 100644 --- a/translate/v2/translate-api.json +++ b/translate/v2/translate-api.json
@@ -1,35 +1,29 @@ { - "basePath": "/language/translate/", - "id": "translate:v2", "revision": "20170525", "documentationLink": "https://code.google.com/apis/language/translate/v2/getting_started.html", + "id": "translate:v2", "discoveryVersion": "v1", "schemas": { - "GetSupportedLanguagesRequest": { - "description": "The request message for discovering supported languages.", + "TranslationsResource": { "type": "object", "properties": { - "target": { - "description": "The language to use to return localized, human readable names of supported\nlanguages.", + "detectedSourceLanguage": { + "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.", + "type": "string" + }, + "model": { + "description": "The `model` type used for this translation. Valid values are\nlisted in public documentation. Can be different from requested `model`.\nPresent only if specific model type was explicitly requested.", + "type": "string" + }, + "translatedText": { + "description": "Text translated into the target language.", "type": "string" } }, - "id": "GetSupportedLanguagesRequest" - }, - "LanguagesListResponse": { - "type": "object", - "properties": { - "languages": { - "description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.", - "type": "array", - "items": { - "$ref": "LanguagesResource" - } - } - }, - "id": "LanguagesListResponse" + "id": "TranslationsResource" }, "DetectionsResource": { + "id": "DetectionsResource", "description": "An array of languages which we detect for the given text The most likely language list first.", "type": "array", "items": { @@ -49,30 +43,9 @@ "type": "string" } } - }, - "id": "DetectionsResource" - }, - "TranslationsResource": { - "type": "object", - "properties": { - "translatedText": { - "description": "Text translated into the target language.", - "type": "string" - }, - "detectedSourceLanguage": { - "description": "The source language of the initial request, detected automatically, if\nno source language was passed within the initial request. If the\nsource language was passed, auto-detection of the language will not\noccur and this field will be empty.", - "type": "string" - }, - "model": { - "description": "The `model` type used for this translation. Valid values are\nlisted in public documentation. Can be different from requested `model`.\nPresent only if specific model type was explicitly requested.", - "type": "string" - } - }, - "id": "TranslationsResource" + } }, "TranslationsListResponse": { - "description": "The main language translation response message.", - "type": "object", "properties": { "translations": { "description": "Translations contains list of translation results of given text", @@ -82,12 +55,20 @@ } } }, - "id": "TranslationsListResponse" + "id": "TranslationsListResponse", + "description": "The main language translation response message.", + "type": "object" }, "TranslateTextRequest": { - "description": "The main translation request message for the Cloud Translation API.", - "type": "object", "properties": { + "model": { + "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.", + "type": "string" + }, + "target": { + "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.", + "type": "string" + }, "q": { "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.", "type": "array", @@ -102,21 +83,13 @@ "source": { "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.", "type": "string" - }, - "model": { - "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.", - "type": "string" - }, - "target": { - "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.", - "type": "string" } }, - "id": "TranslateTextRequest" + "id": "TranslateTextRequest", + "description": "The main translation request message for the Cloud Translation API.", + "type": "object" }, "DetectLanguageRequest": { - "description": "The request message for language detection.", - "type": "object", "properties": { "q": { "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.", @@ -126,7 +99,9 @@ } } }, - "id": "DetectLanguageRequest" + "id": "DetectLanguageRequest", + "description": "The request message for language detection.", + "type": "object" }, "LanguagesResource": { "type": "object", @@ -154,22 +129,46 @@ } }, "id": "DetectionsListResponse" + }, + "GetSupportedLanguagesRequest": { + "description": "The request message for discovering supported languages.", + "type": "object", + "properties": { + "target": { + "description": "The language to use to return localized, human readable names of supported\nlanguages.", + "type": "string" + } + }, + "id": "GetSupportedLanguagesRequest" + }, + "LanguagesListResponse": { + "properties": { + "languages": { + "description": "List of source/target languages supported by the translation API. If target parameter is unspecified, the list is sorted by the ASCII code point order of the language code. If target parameter is specified, the list is sorted by the collation order of the language name in the target language.", + "type": "array", + "items": { + "$ref": "LanguagesResource" + } + } + }, + "id": "LanguagesListResponse", + "type": "object" } }, "icons": { - "x32": "https://www.google.com/images/icons/product/translate-32.png", - "x16": "https://www.google.com/images/icons/product/translate-16.png" + "x16": "https://www.google.com/images/icons/product/translate-16.png", + "x32": "https://www.google.com/images/icons/product/translate-32.png" }, "protocol": "rest", "canonicalName": "Translate", "auth": { "oauth2": { "scopes": { - "https://www.googleapis.com/auth/cloud-translation": { - "description": "Translate text from one language to another using Google Translate" - }, "https://www.googleapis.com/auth/cloud-platform": { "description": "View and manage your data across Google Cloud Platform services" + }, + "https://www.googleapis.com/auth/cloud-translation": { + "description": "Translate text from one language to another using Google Translate" } } } @@ -184,98 +183,8 @@ ], "ownerName": "Google", "resources": { - "languages": { - "methods": { - "list": { - "path": "v2/languages", - "id": "language.languages.list", - "description": "Returns a list of supported languages for translation.", - "response": { - "$ref": "LanguagesListResponse" - }, - "httpMethod": "GET", - "parameters": { - "target": { - "description": "The language to use to return localized, human readable names of supported\nlanguages.", - "type": "string", - "location": "query" - }, - "model": { - "location": "query", - "description": "The model type for which supported languages should be returned.", - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-translation", - "https://www.googleapis.com/auth/cloud-platform" - ] - } - } - }, "translations": { "methods": { - "list": { - "response": { - "$ref": "TranslationsListResponse" - }, - "parameterOrder": [ - "q", - "target" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-translation", - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "format": { - "enumDescriptions": [ - "Specifies the input is in HTML", - "Specifies the input is in plain textual format" - ], - "location": "query", - "enum": [ - "html", - "text" - ], - "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.", - "type": "string" - }, - "model": { - "location": "query", - "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.", - "type": "string" - }, - "q": { - "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.", - "type": "string", - "required": true, - "repeated": true, - "location": "query" - }, - "source": { - "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.", - "type": "string", - "location": "query" - }, - "cid": { - "description": "The customization id for translate", - "type": "string", - "repeated": true, - "location": "query" - }, - "target": { - "location": "query", - "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.", - "type": "string", - "required": true - } - }, - "path": "v2", - "id": "language.translations.list", - "description": "Translates input text, returning translated text." - }, "translate": { "id": "language.translations.translate", "path": "v2", @@ -293,20 +202,15 @@ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": {} - } - } - }, - "detections": { - "methods": { + }, "list": { - "path": "v2/detect", - "id": "language.detections.list", - "description": "Detects the language of text within a request.", + "description": "Translates input text, returning translated text.", "response": { - "$ref": "DetectionsListResponse" + "$ref": "TranslationsListResponse" }, "parameterOrder": [ - "q" + "q", + "target" ], "httpMethod": "GET", "scopes": [ @@ -315,111 +219,141 @@ ], "parameters": { "q": { - "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.", - "type": "string", - "required": true, "repeated": true, + "location": "query", + "description": "The input text to translate. Repeat this parameter to perform translation\noperations on multiple text inputs.", + "type": "string", + "required": true + }, + "source": { + "description": "The language of the source text, set to one of the language codes listed in\nLanguage Support. If the source language is not specified, the API will\nattempt to identify the source language automatically and return it within\nthe response.", + "type": "string", + "location": "query" + }, + "cid": { + "repeated": true, + "location": "query", + "description": "The customization id for translate", + "type": "string" + }, + "target": { + "location": "query", + "description": "The language to use for translation of the input text, set to one of the\nlanguage codes listed in Language Support.", + "type": "string", + "required": true + }, + "format": { + "enumDescriptions": [ + "Specifies the input is in HTML", + "Specifies the input is in plain textual format" + ], + "location": "query", + "enum": [ + "html", + "text" + ], + "description": "The format of the source text, in either HTML (default) or plain-text. A\nvalue of \"html\" indicates HTML and a value of \"text\" indicates plain-text.", + "type": "string" + }, + "model": { + "description": "The `model` type requested for this translation. Valid values are\nlisted in public documentation.", + "type": "string", "location": "query" } - } + }, + "path": "v2", + "id": "language.translations.list" + } + } + }, + "detections": { + "methods": { + "list": { + "response": { + "$ref": "DetectionsListResponse" + }, + "parameterOrder": [ + "q" + ], + "httpMethod": "GET", + "parameters": { + "q": { + "repeated": true, + "location": "query", + "description": "The input text upon which to perform language detection. Repeat this\nparameter to perform language detection on multiple text inputs.", + "type": "string", + "required": true + } + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-translation", + "https://www.googleapis.com/auth/cloud-platform" + ], + "path": "v2/detect", + "id": "language.detections.list", + "description": "Detects the language of text within a request." }, "detect": { "path": "v2/detect", "id": "language.detections.detect", + "description": "Detects the language of text within a request.", "request": { "$ref": "DetectLanguageRequest" }, - "description": "Detects the language of text within a request.", "response": { "$ref": "DetectionsListResponse" }, "parameterOrder": [], "httpMethod": "POST", + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/cloud-translation", + "https://www.googleapis.com/auth/cloud-platform" + ] + } + } + }, + "languages": { + "methods": { + "list": { + "response": { + "$ref": "LanguagesListResponse" + }, + "httpMethod": "GET", + "parameters": { + "target": { + "description": "The language to use to return localized, human readable names of supported\nlanguages.", + "type": "string", + "location": "query" + }, + "model": { + "description": "The model type for which supported languages should be returned.", + "type": "string", + "location": "query" + } + }, "scopes": [ "https://www.googleapis.com/auth/cloud-translation", "https://www.googleapis.com/auth/cloud-platform" ], - "parameters": {} + "path": "v2/languages", + "id": "language.languages.list", + "description": "Returns a list of supported languages for translation." } } } }, "parameters": { - "bearer_token": { - "description": "OAuth bearer token.", - "type": "string", - "location": "query" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "location": "query", - "description": "Selector specifying which fields to include in a partial response.", - "type": "string" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "type": "string", - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "access_token": { - "description": "OAuth access token.", - "type": "string", - "location": "query" - }, "key": { "location": "query", "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.", "type": "string" }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, "quotaUser": { "location": "query", "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. Overrides userIp if both are provided.", @@ -430,11 +364,77 @@ "type": "boolean", "default": "true", "location": "query" + }, + "oauth_token": { + "location": "query", + "description": "OAuth 2.0 token for the current user.", + "type": "string" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" } }, "version": "v2", "baseUrl": "https://translation.googleapis.com/language/translate/", - "kind": "discovery#restDescription", + "servicePath": "language/translate/", "description": "The Google Cloud Translation API lets websites and programs integrate with\n Google Translate programmatically.", - "servicePath": "language/translate/" + "kind": "discovery#restDescription", + "basePath": "/language/translate/" }
diff --git a/vault/v1/vault-api.json b/vault/v1/vault-api.json index 43d1287..80ae01a 100644 --- a/vault/v1/vault-api.json +++ b/vault/v1/vault-api.json
@@ -1,4 +1,667 @@ { + "resources": { + "matters": { + "methods": { + "close": { + "response": { + "$ref": "CloseMatterResponse" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/matters/{matterId}:close", + "path": "v1/matters/{matterId}:close", + "id": "vault.matters.close", + "description": "Closes the specified matter. Returns matter with updated state.", + "request": { + "$ref": "CloseMatterRequest" + } + }, + "undelete": { + "flatPath": "v1/matters/{matterId}:undelete", + "path": "v1/matters/{matterId}:undelete", + "id": "vault.matters.undelete", + "description": "Undeletes the specified matter. Returns matter with updated state.", + "request": { + "$ref": "UndeleteMatterRequest" + }, + "response": { + "$ref": "Matter" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + } + } + }, + "get": { + "id": "vault.matters.get", + "path": "v1/matters/{matterId}", + "description": "Gets the specified matter.", + "httpMethod": "GET", + "response": { + "$ref": "Matter" + }, + "parameterOrder": [ + "matterId" + ], + "parameters": { + "view": { + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "description": "Specifies which parts of the Matter to return in the response.", + "type": "string", + "location": "query" + }, + "matterId": { + "required": true, + "type": "string", + "location": "path", + "description": "The matter ID." + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ], + "flatPath": "v1/matters/{matterId}" + }, + "update": { + "flatPath": "v1/matters/{matterId}", + "path": "v1/matters/{matterId}", + "id": "vault.matters.update", + "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.", + "request": { + "$ref": "Matter" + }, + "response": { + "$ref": "Matter" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "PUT", + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "parameters": { + "matterId": { + "required": true, + "type": "string", + "location": "path", + "description": "The matter ID." + } + } + }, + "delete": { + "httpMethod": "DELETE", + "response": { + "$ref": "Matter" + }, + "parameterOrder": [ + "matterId" + ], + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters/{matterId}", + "id": "vault.matters.delete", + "path": "v1/matters/{matterId}", + "description": "Deletes the specified matter. Returns matter with updated state." + }, + "addPermissions": { + "flatPath": "v1/matters/{matterId}:addPermissions", + "path": "v1/matters/{matterId}:addPermissions", + "id": "vault.matters.addPermissions", + "request": { + "$ref": "AddMatterPermissionsRequest" + }, + "description": "Adds an account as a matter collaborator.", + "response": { + "$ref": "MatterPermission" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "POST", + "parameters": { + "matterId": { + "description": "The matter ID.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ] + }, + "list": { + "httpMethod": "GET", + "parameterOrder": [], + "response": { + "$ref": "ListMattersResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ], + "parameters": { + "pageToken": { + "description": "The pagination token as returned in the response.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The number of matters to return in the response.\nDefault and maximum are 100.", + "format": "int32", + "type": "integer" + }, + "view": { + "enum": [ + "VIEW_UNSPECIFIED", + "BASIC", + "FULL" + ], + "description": "Specifies which parts of the matter to return in response.", + "type": "string", + "location": "query" + }, + "state": { + "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.", + "type": "string", + "location": "query", + "enum": [ + "STATE_UNSPECIFIED", + "OPEN", + "CLOSED", + "DELETED" + ] + } + }, + "flatPath": "v1/matters", + "id": "vault.matters.list", + "path": "v1/matters", + "description": "Lists matters the user has access to." + }, + "create": { + "parameters": {}, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters", + "path": "v1/matters", + "id": "vault.matters.create", + "request": { + "$ref": "Matter" + }, + "description": "Creates a new matter with the given name and description. The initial state\nis open, and the owner is the method caller. Returns the created matter\nwith default view.", + "response": { + "$ref": "Matter" + }, + "parameterOrder": [], + "httpMethod": "POST" + }, + "reopen": { + "request": { + "$ref": "ReopenMatterRequest" + }, + "description": "Reopens the specified matter. Returns matter with updated state.", + "response": { + "$ref": "ReopenMatterResponse" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "POST", + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters/{matterId}:reopen", + "path": "v1/matters/{matterId}:reopen", + "id": "vault.matters.reopen" + }, + "removePermissions": { + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters/{matterId}:removePermissions", + "path": "v1/matters/{matterId}:removePermissions", + "id": "vault.matters.removePermissions", + "request": { + "$ref": "RemoveMatterPermissionsRequest" + }, + "description": "Removes an account as a matter collaborator.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "POST" + } + }, + "resources": { + "holds": { + "methods": { + "update": { + "flatPath": "v1/matters/{matterId}/holds/{holdId}", + "id": "vault.matters.holds.update", + "path": "v1/matters/{matterId}/holds/{holdId}", + "request": { + "$ref": "Hold" + }, + "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.", + "httpMethod": "PUT", + "parameterOrder": [ + "matterId", + "holdId" + ], + "response": { + "$ref": "Hold" + }, + "parameters": { + "matterId": { + "description": "The matter ID.", + "required": true, + "type": "string", + "location": "path" + }, + "holdId": { + "description": "The ID of the hold.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ] + }, + "create": { + "request": { + "$ref": "Hold" + }, + "description": "Creates a hold in the given matter.", + "response": { + "$ref": "Hold" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "POST", + "parameters": { + "matterId": { + "description": "The matter ID.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters/{matterId}/holds", + "path": "v1/matters/{matterId}/holds", + "id": "vault.matters.holds.create" + }, + "delete": { + "parameters": { + "holdId": { + "required": true, + "type": "string", + "location": "path", + "description": "The hold ID." + }, + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters/{matterId}/holds/{holdId}", + "path": "v1/matters/{matterId}/holds/{holdId}", + "id": "vault.matters.holds.delete", + "description": "Removes a hold by ID. This will release any HeldAccounts on this Hold.", + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "matterId", + "holdId" + ], + "httpMethod": "DELETE" + }, + "get": { + "flatPath": "v1/matters/{matterId}/holds/{holdId}", + "id": "vault.matters.holds.get", + "path": "v1/matters/{matterId}/holds/{holdId}", + "description": "Gets a hold by ID.", + "httpMethod": "GET", + "parameterOrder": [ + "matterId", + "holdId" + ], + "response": { + "$ref": "Hold" + }, + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + }, + "holdId": { + "location": "path", + "description": "The hold ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ] + }, + "list": { + "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list.", + "response": { + "$ref": "ListHoldsResponse" + }, + "parameterOrder": [ + "matterId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ], + "parameters": { + "matterId": { + "description": "The matter ID.", + "required": true, + "type": "string", + "location": "path" + }, + "pageToken": { + "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning.", + "type": "string", + "location": "query" + }, + "pageSize": { + "location": "query", + "description": "The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.", + "format": "int32", + "type": "integer" + } + }, + "flatPath": "v1/matters/{matterId}/holds", + "path": "v1/matters/{matterId}/holds", + "id": "vault.matters.holds.list" + } + }, + "resources": { + "accounts": { + "methods": { + "delete": { + "response": { + "$ref": "Empty" + }, + "parameterOrder": [ + "matterId", + "holdId", + "accountId" + ], + "httpMethod": "DELETE", + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "parameters": { + "holdId": { + "location": "path", + "description": "The hold ID.", + "required": true, + "type": "string" + }, + "accountId": { + "description": "The ID of the account to remove from the hold.", + "required": true, + "type": "string", + "location": "path" + }, + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + } + }, + "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", + "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", + "id": "vault.matters.holds.accounts.delete", + "description": "Removes a HeldAccount from a hold. If this request leaves the hold with\nno held accounts, the hold will not apply to any accounts." + }, + "list": { + "response": { + "$ref": "ListHeldAccountsResponse" + }, + "parameterOrder": [ + "matterId", + "holdId" + ], + "httpMethod": "GET", + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + }, + "holdId": { + "description": "The hold ID.", + "required": true, + "type": "string", + "location": "path" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery", + "https://www.googleapis.com/auth/ediscovery.readonly" + ], + "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", + "path": "v1/matters/{matterId}/holds/{holdId}/accounts", + "id": "vault.matters.holds.accounts.list", + "description": "Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members." + }, + "create": { + "httpMethod": "POST", + "parameterOrder": [ + "matterId", + "holdId" + ], + "response": { + "$ref": "HeldAccount" + }, + "parameters": { + "matterId": { + "location": "path", + "description": "The matter ID.", + "required": true, + "type": "string" + }, + "holdId": { + "location": "path", + "description": "The hold ID.", + "required": true, + "type": "string" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/ediscovery" + ], + "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", + "id": "vault.matters.holds.accounts.create", + "path": "v1/matters/{matterId}/holds/{holdId}/accounts", + "request": { + "$ref": "HeldAccount" + }, + "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error." + } + } + } + } + } + } + } + }, + "parameters": { + "upload_protocol": { + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string", + "location": "query" + }, + "prettyPrint": { + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true", + "location": "query" + }, + "uploadType": { + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string", + "location": "query" + }, + "fields": { + "description": "Selector specifying which fields to include in a partial response.", + "type": "string", + "location": "query" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" + }, + "alt": { + "type": "string", + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + } + }, + "version": "v1", + "baseUrl": "https://vault.googleapis.com/", + "kind": "discovery#restDescription", + "description": "Archiving and eDiscovery for G Suite.", + "servicePath": "", "basePath": "", "revision": "20171026", "documentationLink": "https://developers.google.com/vault", @@ -7,7 +670,6 @@ "version_module": true, "schemas": { "RemoveMatterPermissionsRequest": { - "description": "Remove an account as a matter collaborator.", "type": "object", "properties": { "accountId": { @@ -15,15 +677,13 @@ "type": "string" } }, - "id": "RemoveMatterPermissionsRequest" + "id": "RemoveMatterPermissionsRequest", + "description": "Remove an account as a matter collaborator." }, "MatterPermission": { + "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist.", "type": "object", "properties": { - "accountId": { - "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.", - "type": "string" - }, "role": { "description": "The user's role in this matter.", "type": "string", @@ -37,13 +697,15 @@ "COLLABORATOR", "OWNER" ] + }, + "accountId": { + "description": "The account id, as provided by \u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.", + "type": "string" } }, - "id": "MatterPermission", - "description": "Currently each matter only has one owner, and all others are collaborators.\nWhen an account is purged, its corresponding MatterPermission resources\ncease to exist." + "id": "MatterPermission" }, "ListMattersResponse": { - "id": "ListMattersResponse", "description": "Provides the list of matters.", "type": "object", "properties": { @@ -58,12 +720,18 @@ "$ref": "Matter" } } - } + }, + "id": "ListMattersResponse" }, "HeldMailQuery": { "description": "Query options for mail holds.", "type": "object", "properties": { + "startTime": { + "description": "The start time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.", + "format": "google-datetime", + "type": "string" + }, "terms": { "description": "The search terms for the hold.", "type": "string" @@ -72,78 +740,76 @@ "description": "The end time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.", "format": "google-datetime", "type": "string" - }, - "startTime": { - "description": "The start time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.", - "format": "google-datetime", - "type": "string" } }, "id": "HeldMailQuery" }, "CloseMatterResponse": { + "id": "CloseMatterResponse", "description": "Response to a CloseMatterRequest.", "type": "object", "properties": { "matter": { - "description": "The updated matter, with state CLOSED.", - "$ref": "Matter" + "$ref": "Matter", + "description": "The updated matter, with state CLOSED." } - }, - "id": "CloseMatterResponse" + } }, "HeldDriveQuery": { - "id": "HeldDriveQuery", "description": "Query options for drive holds.", "type": "object", "properties": { "includeTeamDriveFiles": { - "type": "boolean", - "description": "If true, include files in Team Drives in the hold." + "description": "If true, include files in Team Drives in the hold.", + "type": "boolean" } - } + }, + "id": "HeldDriveQuery" }, "HeldGroupsQuery": { - "id": "HeldGroupsQuery", - "description": "Query options for group holds.", "type": "object", "properties": { + "terms": { + "description": "The search terms for the hold.", + "type": "string" + }, "endTime": { "description": "The end time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.", "format": "google-datetime", "type": "string" }, "startTime": { + "type": "string", "description": "The start time range for the search query. These timestamps are in GMT and\nrounded down to the start of the given date.", - "format": "google-datetime", + "format": "google-datetime" + } + }, + "id": "HeldGroupsQuery", + "description": "Query options for group holds." + }, + "HeldOrgUnit": { + "id": "HeldOrgUnit", + "description": "A organizational unit being held in a particular hold.\nThis structure is immutable.", + "type": "object", + "properties": { + "orgUnitId": { + "description": "The org unit's immutable ID as provided by the admin SDK.", "type": "string" }, - "terms": { - "description": "The search terms for the hold.", - "type": "string" + "holdTime": { + "type": "string", + "description": "When the org unit was put on hold. This property is immutable.", + "format": "google-datetime" } } }, - "HeldOrgUnit": { - "type": "object", - "properties": { - "holdTime": { - "description": "When the org unit was put on hold. This property is immutable.", - "format": "google-datetime", - "type": "string" - }, - "orgUnitId": { - "type": "string", - "description": "The org unit's immutable ID as provided by the admin SDK." - } - }, - "id": "HeldOrgUnit", - "description": "A organizational unit being held in a particular hold.\nThis structure is immutable." - }, "AddMatterPermissionsRequest": { - "description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten.", "type": "object", "properties": { + "ccMe": { + "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor.", + "type": "boolean" + }, "sendEmails": { "description": "True to send notification email to the added account.\nFalse to not send notification email.", "type": "boolean" @@ -151,13 +817,10 @@ "matterPermission": { "$ref": "MatterPermission", "description": "The MatterPermission to add." - }, - "ccMe": { - "type": "boolean", - "description": "Only relevant if send_emails is true.\nTrue to CC requestor in the email message.\nFalse to not CC requestor." } }, - "id": "AddMatterPermissionsRequest" + "id": "AddMatterPermissionsRequest", + "description": "Add an account with the permission specified. The role cannot be owner.\nIf an account already has a role in the matter, it will be\noverwritten." }, "Matter": { "id": "Matter", @@ -169,8 +832,6 @@ "type": "string" }, "state": { - "description": "The state of the matter.", - "type": "string", "enumDescriptions": [ "The matter has no specified state.", "This matter is open.", @@ -182,11 +843,13 @@ "OPEN", "CLOSED", "DELETED" - ] + ], + "description": "The state of the matter.", + "type": "string" }, "name": { - "type": "string", - "description": "The name of the matter." + "description": "The name of the matter.", + "type": "string" }, "matterPermissions": { "description": "List of users and access to the matter. Currently there is no programmer\ndefined limit on the number of permissions a matter can have.", @@ -196,56 +859,56 @@ } }, "description": { - "description": "The description of the matter.", - "type": "string" + "type": "string", + "description": "The description of the matter." } } }, "HeldAccount": { - "id": "HeldAccount", "description": "An account being held in a particular hold. This structure is immutable.\nThis can be either a single user or a google group, depending on the corpus.", "type": "object", "properties": { - "holdTime": { - "type": "string", - "description": "When the account was put on hold.", - "format": "google-datetime" - }, "accountId": { - "type": "string", - "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e." + "description": "The account's ID as provided by the\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e.", + "type": "string" + }, + "holdTime": { + "description": "When the account was put on hold.", + "format": "google-datetime", + "type": "string" } - } + }, + "id": "HeldAccount" }, "ReopenMatterResponse": { "description": "Response to a ReopenMatterRequest.", "type": "object", "properties": { "matter": { - "description": "The updated matter, with state OPEN.", - "$ref": "Matter" + "$ref": "Matter", + "description": "The updated matter, with state OPEN." } }, "id": "ReopenMatterResponse" }, "CorpusQuery": { - "id": "CorpusQuery", "description": "Corpus specific queries.", "type": "object", "properties": { + "driveQuery": { + "$ref": "HeldDriveQuery", + "description": "Details pertaining to Drive holds. If set, corpus must be Drive." + }, "mailQuery": { "$ref": "HeldMailQuery", "description": "Details pertaining to mail holds. If set, corpus must be mail." }, "groupsQuery": { - "description": "Details pertaining to Groups holds. If set, corpus must be Groups.", - "$ref": "HeldGroupsQuery" - }, - "driveQuery": { - "description": "Details pertaining to Drive holds. If set, corpus must be Drive.", - "$ref": "HeldDriveQuery" + "$ref": "HeldGroupsQuery", + "description": "Details pertaining to Groups holds. If set, corpus must be Groups." } - } + }, + "id": "CorpusQuery" }, "Hold": { "description": "Represents a hold within Vault. A hold restricts purging of\nartifacts based on the combination of the query and accounts restrictions.\nA hold can be configured to either apply to an explicitly configured set\nof accounts, or can be applied to all members of an organizational unit.", @@ -259,20 +922,14 @@ } }, "query": { - "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype.", - "$ref": "CorpusQuery" + "$ref": "CorpusQuery", + "description": "The corpus-specific query. If set, the corpusQuery must match corpus\ntype." }, "orgUnit": { "$ref": "HeldOrgUnit", "description": "If set, the hold applies to all members of the organizational unit and\naccounts must be empty. This property is mutable. For groups holds,\nset the accounts field." }, "corpus": { - "enum": [ - "CORPUS_TYPE_UNSPECIFIED", - "DRIVE", - "MAIL", - "GROUPS" - ], "description": "The corpus to be searched.", "type": "string", "enumDescriptions": [ @@ -280,6 +937,12 @@ "Drive.", "Mail.", "Groups." + ], + "enum": [ + "CORPUS_TYPE_UNSPECIFIED", + "DRIVE", + "MAIL", + "GROUPS" ] }, "updateTime": { @@ -321,44 +984,44 @@ "type": "object", "properties": { "accounts": { - "description": "The held accounts on a hold.", "type": "array", "items": { "$ref": "HeldAccount" - } + }, + "description": "The held accounts on a hold." } }, "id": "ListHeldAccountsResponse" }, "UndeleteMatterRequest": { + "id": "UndeleteMatterRequest", "description": "Undelete a matter by ID.", "type": "object", - "properties": {}, - "id": "UndeleteMatterRequest" + "properties": {} }, "Empty": { - "type": "object", - "properties": {}, "id": "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 `{}`." - }, - "CloseMatterRequest": { - "type": "object", - "properties": {}, - "id": "CloseMatterRequest", - "description": "Close a matter by ID." - }, - "ReopenMatterRequest": { - "id": "ReopenMatterRequest", - "description": "Reopen a matter by ID.", + "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 `{}`.", "type": "object", "properties": {} + }, + "CloseMatterRequest": { + "description": "Close a matter by ID.", + "type": "object", + "properties": {}, + "id": "CloseMatterRequest" + }, + "ReopenMatterRequest": { + "description": "Reopen a matter by ID.", + "type": "object", + "properties": {}, + "id": "ReopenMatterRequest" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Vault", "auth": { @@ -379,668 +1042,5 @@ "batchPath": "batch", "fullyEncodeReservedExpansion": true, "title": "Google Vault API", - "ownerName": "Google", - "resources": { - "matters": { - "methods": { - "delete": { - "description": "Deletes the specified matter. Returns matter with updated state.", - "httpMethod": "DELETE", - "response": { - "$ref": "Matter" - }, - "parameterOrder": [ - "matterId" - ], - "parameters": { - "matterId": { - "location": "path", - "description": "The matter ID", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}", - "id": "vault.matters.delete", - "path": "v1/matters/{matterId}" - }, - "addPermissions": { - "response": { - "$ref": "MatterPermission" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "POST", - "parameters": { - "matterId": { - "description": "The matter ID.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}:addPermissions", - "path": "v1/matters/{matterId}:addPermissions", - "id": "vault.matters.addPermissions", - "request": { - "$ref": "AddMatterPermissionsRequest" - }, - "description": "Adds an account as a matter collaborator." - }, - "list": { - "httpMethod": "GET", - "parameterOrder": [], - "response": { - "$ref": "ListMattersResponse" - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery", - "https://www.googleapis.com/auth/ediscovery.readonly" - ], - "parameters": { - "state": { - "location": "query", - "enum": [ - "STATE_UNSPECIFIED", - "OPEN", - "CLOSED", - "DELETED" - ], - "description": "If set, list only matters with that specific state. The default is listing\nmatters of all states.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The pagination token as returned in the response.", - "type": "string" - }, - "pageSize": { - "description": "The number of matters to return in the response.\nDefault and maximum are 100.", - "format": "int32", - "type": "integer", - "location": "query" - }, - "view": { - "location": "query", - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "description": "Specifies which parts of the matter to return in response.", - "type": "string" - } - }, - "flatPath": "v1/matters", - "id": "vault.matters.list", - "path": "v1/matters", - "description": "Lists matters the user has access to." - }, - "create": { - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters", - "path": "v1/matters", - "id": "vault.matters.create", - "request": { - "$ref": "Matter" - }, - "description": "Creates a new matter with the given name and description. The initial state\nis open, and the owner is the method caller. Returns the created matter\nwith default view.", - "response": { - "$ref": "Matter" - }, - "parameterOrder": [], - "httpMethod": "POST" - }, - "reopen": { - "response": { - "$ref": "ReopenMatterResponse" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "POST", - "parameters": { - "matterId": { - "description": "The matter ID.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}:reopen", - "path": "v1/matters/{matterId}:reopen", - "id": "vault.matters.reopen", - "request": { - "$ref": "ReopenMatterRequest" - }, - "description": "Reopens the specified matter. Returns matter with updated state." - }, - "removePermissions": { - "path": "v1/matters/{matterId}:removePermissions", - "id": "vault.matters.removePermissions", - "request": { - "$ref": "RemoveMatterPermissionsRequest" - }, - "description": "Removes an account as a matter collaborator.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "POST", - "parameters": { - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}:removePermissions" - }, - "close": { - "description": "Closes the specified matter. Returns matter with updated state.", - "request": { - "$ref": "CloseMatterRequest" - }, - "response": { - "$ref": "CloseMatterResponse" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "parameters": { - "matterId": { - "description": "The matter ID.", - "required": true, - "type": "string", - "location": "path" - } - }, - "flatPath": "v1/matters/{matterId}:close", - "path": "v1/matters/{matterId}:close", - "id": "vault.matters.close" - }, - "undelete": { - "response": { - "$ref": "Matter" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "parameters": { - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/matters/{matterId}:undelete", - "path": "v1/matters/{matterId}:undelete", - "id": "vault.matters.undelete", - "description": "Undeletes the specified matter. Returns matter with updated state.", - "request": { - "$ref": "UndeleteMatterRequest" - } - }, - "get": { - "httpMethod": "GET", - "response": { - "$ref": "Matter" - }, - "parameterOrder": [ - "matterId" - ], - "parameters": { - "view": { - "location": "query", - "enum": [ - "VIEW_UNSPECIFIED", - "BASIC", - "FULL" - ], - "description": "Specifies which parts of the Matter to return in the response.", - "type": "string" - }, - "matterId": { - "required": true, - "type": "string", - "location": "path", - "description": "The matter ID." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery", - "https://www.googleapis.com/auth/ediscovery.readonly" - ], - "flatPath": "v1/matters/{matterId}", - "id": "vault.matters.get", - "path": "v1/matters/{matterId}", - "description": "Gets the specified matter." - }, - "update": { - "description": "Updates the specified matter.\nThis updates only the name and description of the matter, identified by\nmatter id. Changes to any other fields are ignored.\nReturns the default view of the matter.", - "request": { - "$ref": "Matter" - }, - "response": { - "$ref": "Matter" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "PUT", - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "parameters": { - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/matters/{matterId}", - "path": "v1/matters/{matterId}", - "id": "vault.matters.update" - } - }, - "resources": { - "holds": { - "resources": { - "accounts": { - "methods": { - "delete": { - "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", - "path": "v1/matters/{matterId}/holds/{holdId}/accounts/{accountId}", - "id": "vault.matters.holds.accounts.delete", - "description": "Removes a HeldAccount from a hold. If this request leaves the hold with\nno held accounts, the hold will not apply to any accounts.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "matterId", - "holdId", - "accountId" - ], - "httpMethod": "DELETE", - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "parameters": { - "matterId": { - "description": "The matter ID.", - "required": true, - "type": "string", - "location": "path" - }, - "holdId": { - "description": "The hold ID.", - "required": true, - "type": "string", - "location": "path" - }, - "accountId": { - "description": "The ID of the account to remove from the hold.", - "required": true, - "type": "string", - "location": "path" - } - } - }, - "list": { - "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts", - "path": "v1/matters/{matterId}/holds/{holdId}/accounts", - "id": "vault.matters.holds.accounts.list", - "description": "Lists HeldAccounts for a hold. This will only list individually specified\nheld accounts. If the hold is on an OU, then use\n\u003ca href=\"https://developers.google.com/admin-sdk/\"\u003eAdmin SDK\u003c/a\u003e\nto enumerate its members.", - "response": { - "$ref": "ListHeldAccountsResponse" - }, - "parameterOrder": [ - "matterId", - "holdId" - ], - "httpMethod": "GET", - "parameters": { - "holdId": { - "location": "path", - "description": "The hold ID.", - "required": true, - "type": "string" - }, - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery", - "https://www.googleapis.com/auth/ediscovery.readonly" - ] - }, - "create": { - "id": "vault.matters.holds.accounts.create", - "path": "v1/matters/{matterId}/holds/{holdId}/accounts", - "request": { - "$ref": "HeldAccount" - }, - "description": "Adds a HeldAccount to a hold. Accounts can only be added to a hold that\nhas no held_org_unit set. Attempting to add an account to an OU-based\nhold will result in an error.", - "httpMethod": "POST", - "parameterOrder": [ - "matterId", - "holdId" - ], - "response": { - "$ref": "HeldAccount" - }, - "parameters": { - "holdId": { - "location": "path", - "description": "The hold ID.", - "required": true, - "type": "string" - }, - "matterId": { - "description": "The matter ID.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}/holds/{holdId}/accounts" - } - } - } - }, - "methods": { - "delete": { - "path": "v1/matters/{matterId}/holds/{holdId}", - "id": "vault.matters.holds.delete", - "description": "Removes a hold by ID. This will release any HeldAccounts on this Hold.", - "response": { - "$ref": "Empty" - }, - "parameterOrder": [ - "matterId", - "holdId" - ], - "httpMethod": "DELETE", - "parameters": { - "holdId": { - "location": "path", - "description": "The hold ID.", - "required": true, - "type": "string" - }, - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}/holds/{holdId}" - }, - "get": { - "parameters": { - "matterId": { - "description": "The matter ID.", - "required": true, - "type": "string", - "location": "path" - }, - "holdId": { - "location": "path", - "description": "The hold ID.", - "required": true, - "type": "string" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery", - "https://www.googleapis.com/auth/ediscovery.readonly" - ], - "flatPath": "v1/matters/{matterId}/holds/{holdId}", - "id": "vault.matters.holds.get", - "path": "v1/matters/{matterId}/holds/{holdId}", - "description": "Gets a hold by ID.", - "httpMethod": "GET", - "parameterOrder": [ - "matterId", - "holdId" - ], - "response": { - "$ref": "Hold" - } - }, - "list": { - "response": { - "$ref": "ListHoldsResponse" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/ediscovery", - "https://www.googleapis.com/auth/ediscovery.readonly" - ], - "parameters": { - "pageToken": { - "type": "string", - "location": "query", - "description": "The pagination token as returned in the response.\nAn empty token means start from the beginning." - }, - "pageSize": { - "location": "query", - "description": "The number of holds to return in the response, between 0 and 100 inclusive.\nLeaving this empty, or as 0, is the same as page_size = 100.", - "format": "int32", - "type": "integer" - }, - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - } - }, - "flatPath": "v1/matters/{matterId}/holds", - "path": "v1/matters/{matterId}/holds", - "id": "vault.matters.holds.list", - "description": "Lists holds within a matter. An empty page token in ListHoldsResponse\ndenotes no more holds to list." - }, - "update": { - "id": "vault.matters.holds.update", - "path": "v1/matters/{matterId}/holds/{holdId}", - "request": { - "$ref": "Hold" - }, - "description": "Updates the OU and/or query parameters of a hold. You cannot add accounts\nto a hold that covers an OU, nor can you add OUs to a hold that covers\nindividual accounts. Accounts listed in the hold will be ignored.", - "httpMethod": "PUT", - "parameterOrder": [ - "matterId", - "holdId" - ], - "response": { - "$ref": "Hold" - }, - "parameters": { - "matterId": { - "location": "path", - "description": "The matter ID.", - "required": true, - "type": "string" - }, - "holdId": { - "description": "The ID of the hold.", - "required": true, - "type": "string", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ], - "flatPath": "v1/matters/{matterId}/holds/{holdId}" - }, - "create": { - "flatPath": "v1/matters/{matterId}/holds", - "path": "v1/matters/{matterId}/holds", - "id": "vault.matters.holds.create", - "request": { - "$ref": "Hold" - }, - "description": "Creates a hold in the given matter.", - "response": { - "$ref": "Hold" - }, - "parameterOrder": [ - "matterId" - ], - "httpMethod": "POST", - "parameters": { - "matterId": { - "required": true, - "type": "string", - "location": "path", - "description": "The matter ID." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/ediscovery" - ] - } - } - } - } - } - }, - "parameters": { - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "type": "string", - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ] - }, - "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.", - "type": "string", - "location": "query" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "type": "string", - "location": "query", - "description": "OAuth bearer token." - } - }, - "version": "v1", - "baseUrl": "https://vault.googleapis.com/", - "kind": "discovery#restDescription", - "description": "Archiving and eDiscovery for G Suite.", - "servicePath": "" + "ownerName": "Google" }
diff --git a/videointelligence/v1beta1/videointelligence-api.json b/videointelligence/v1beta1/videointelligence-api.json index d6f3115..0d495bf 100644 --- a/videointelligence/v1beta1/videointelligence-api.json +++ b/videointelligence/v1beta1/videointelligence-api.json
@@ -1,218 +1,58 @@ { - "servicePath": "", "kind": "discovery#restDescription", "description": "Cloud Video Intelligence API.", + "servicePath": "", "basePath": "", - "revision": "20180103", - "documentationLink": "https://cloud.google.com/video-intelligence/docs/", "id": "videointelligence:v1beta1", + "documentationLink": "https://cloud.google.com/video-intelligence/docs/", + "revision": "20180103", "discoveryVersion": "v1", "version_module": true, "schemas": { - "GoogleCloudVideointelligenceV1beta2_LabelAnnotation": { - "description": "Label annotation.", - "type": "object", - "properties": { - "entity": { - "description": "Detected entity.", - "$ref": "GoogleCloudVideointelligenceV1beta2_Entity" - }, - "frames": { - "description": "All video frames where a label was detected.", - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1beta2_LabelFrame" - } - }, - "segments": { - "description": "All video segments where a label was detected.", - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1beta2_LabelSegment" - } - }, - "categoryEntities": { - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1beta2_Entity" - }, - "description": "Common categories for the detected entity.\nE.g. when the label is `Terrier` the category is likely `dog`. And in some\ncases there might be more than one categories e.g. `Terrier` could also be\na `pet`." - } - }, - "id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation" - }, - "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": { - "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame. If only some types of unsafe content\nhave been detected in a frame, the likelihood is set to `UNKNOWN`\nfor all other types of unsafe content.", - "type": "object", - "properties": { - "racy": { - "description": "Likelihood of racy content.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "Very unlikely.", - "Unlikely.", - "Possible.", - "Likely.", - "Very likely." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ] - }, - "timeOffset": { - "description": "Video time offset in microseconds.", - "format": "int64", - "type": "string" - }, - "spoof": { - "enumDescriptions": [ - "Unknown likelihood.", - "Very unlikely.", - "Unlikely.", - "Possible.", - "Likely.", - "Very likely." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive.", - "type": "string" - }, - "violent": { - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Likelihood of violent content.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "Very unlikely.", - "Unlikely.", - "Possible.", - "Likely.", - "Very likely." - ] - }, - "medical": { - "enumDescriptions": [ - "Unknown likelihood.", - "Very unlikely.", - "Unlikely.", - "Possible.", - "Likely.", - "Very likely." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Likelihood of medical content.", - "type": "string" - }, - "adult": { - "enumDescriptions": [ - "Unknown likelihood.", - "Very unlikely.", - "Unlikely.", - "Possible.", - "Likely.", - "Very likely." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Likelihood of adult content.", - "type": "string" - } - }, - "id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation" - }, - "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": { - "type": "object", - "properties": { - "annotationProgress": { - "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.", - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress" - } - } - }, - "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress", - "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service." - }, "GoogleCloudVideointelligenceV1_Entity": { + "properties": { + "entityId": { + "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", + "type": "string" + }, + "description": { + "description": "Textual description, e.g. `Fixed-gear bicycle`.", + "type": "string" + }, + "languageCode": { + "description": "Language code for `description` in BCP-47 format.", + "type": "string" + } + }, "id": "GoogleCloudVideointelligenceV1_Entity", "description": "Detected entity from video analysis.", - "type": "object", - "properties": { - "languageCode": { - "description": "Language code for `description` in BCP-47 format.", - "type": "string" - }, - "entityId": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", - "type": "string" - }, - "description": { - "description": "Textual description, e.g. `Fixed-gear bicycle`.", - "type": "string" - } - } + "type": "object" }, "GoogleCloudVideointelligenceV1beta2_Entity": { - "id": "GoogleCloudVideointelligenceV1beta2_Entity", "description": "Detected entity from video analysis.", "type": "object", "properties": { - "languageCode": { - "description": "Language code for `description` in BCP-47 format.", - "type": "string" - }, "entityId": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", - "type": "string" + "type": "string", + "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/)." }, "description": { "description": "Textual description, e.g. `Fixed-gear bicycle`.", "type": "string" + }, + "languageCode": { + "description": "Language code for `description` in BCP-47 format.", + "type": "string" } - } + }, + "id": "GoogleCloudVideointelligenceV1beta2_Entity" }, "GoogleCloudVideointelligenceV1beta2_VideoSegment": { - "description": "Video segment.", - "type": "object", "properties": { "endTimeOffset": { - "type": "string", "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive).", - "format": "google-duration" + "format": "google-duration", + "type": "string" }, "startTimeOffset": { "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the start of the segment (inclusive).", @@ -220,12 +60,30 @@ "type": "string" } }, - "id": "GoogleCloudVideointelligenceV1beta2_VideoSegment" + "id": "GoogleCloudVideointelligenceV1beta2_VideoSegment", + "description": "Video segment.", + "type": "object" }, "GoogleCloudVideointelligenceV1_VideoAnnotationResults": { + "id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults", "description": "Annotation results for a single video.", "type": "object", "properties": { + "inputUri": { + "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).", + "type": "string" + }, + "explicitAnnotation": { + "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation", + "description": "Explicit content annotation." + }, + "segmentLabelAnnotations": { + "description": "Label annotations on video level or user specified segment level.\nThere is exactly one element for each unique label.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation" + } + }, "shotAnnotations": { "description": "Shot annotations. Each shot is represented as a video segment.", "type": "array", @@ -245,31 +103,17 @@ "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail." }, "frameLabelAnnotations": { - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation" - }, - "description": "Label annotations on frame level.\nThere is exactly one element for each unique label." - }, - "inputUri": { - "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).", - "type": "string" - }, - "explicitAnnotation": { - "$ref": "GoogleCloudVideointelligenceV1_ExplicitContentAnnotation", - "description": "Explicit content annotation." - }, - "segmentLabelAnnotations": { - "description": "Label annotations on video level or user specified segment level.\nThere is exactly one element for each unique label.", + "description": "Label annotations on frame level.\nThere is exactly one element for each unique label.", "type": "array", "items": { "$ref": "GoogleCloudVideointelligenceV1_LabelAnnotation" } } - }, - "id": "GoogleCloudVideointelligenceV1_VideoAnnotationResults" + } }, "GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse": { + "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse", + "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.", "type": "object", "properties": { "annotationResults": { @@ -279,12 +123,17 @@ "$ref": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults" } } - }, - "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoResponse", - "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service." + } }, "GoogleCloudVideointelligenceV1beta1_LabelAnnotation": { + "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation", + "description": "Label annotation.", + "type": "object", "properties": { + "description": { + "description": "Textual description, e.g. `Fixed-gear bicycle`.", + "type": "string" + }, "locations": { "description": "Where the label was detected and with what confidence.", "type": "array", @@ -293,22 +142,38 @@ } }, "languageCode": { - "description": "Language code for `description` in BCP-47 format.", - "type": "string" - }, - "description": { - "description": "Textual description, e.g. `Fixed-gear bicycle`.", - "type": "string" + "type": "string", + "description": "Language code for `description` in BCP-47 format." } - }, - "id": "GoogleCloudVideointelligenceV1beta1_LabelAnnotation", - "description": "Label annotation.", - "type": "object" + } }, "GoogleCloudVideointelligenceV1beta1_VideoContext": { - "description": "Video context and/or feature-specific parameters.", "type": "object", "properties": { + "shotChangeDetectionModel": { + "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).", + "type": "string" + }, + "stationaryCamera": { + "description": "Whether the video has been shot from a stationary (i.e. non-moving) camera.\nWhen set to true, might improve detection accuracy for moving objects.", + "type": "boolean" + }, + "labelDetectionMode": { + "enumDescriptions": [ + "Unspecified.", + "Detect shot-level labels.", + "Detect frame-level labels.", + "Detect both shot-level and frame-level labels." + ], + "enum": [ + "LABEL_DETECTION_MODE_UNSPECIFIED", + "SHOT_MODE", + "FRAME_MODE", + "SHOT_AND_FRAME_MODE" + ], + "description": "If label detection has been requested, what labels should be detected\nin addition to video-level labels or segment-level labels. If unspecified,\ndefaults to `SHOT_MODE`.", + "type": "string" + }, "safeSearchDetectionModel": { "description": "Model to use for safe search detection.\nSupported values: \"latest\" and \"stable\" (the default).", "type": "string" @@ -323,33 +188,10 @@ "labelDetectionModel": { "description": "Model to use for label detection.\nSupported values: \"latest\" and \"stable\" (the default).", "type": "string" - }, - "shotChangeDetectionModel": { - "description": "Model to use for shot change detection.\nSupported values: \"latest\" and \"stable\" (the default).", - "type": "string" - }, - "labelDetectionMode": { - "description": "If label detection has been requested, what labels should be detected\nin addition to video-level labels or segment-level labels. If unspecified,\ndefaults to `SHOT_MODE`.", - "type": "string", - "enumDescriptions": [ - "Unspecified.", - "Detect shot-level labels.", - "Detect frame-level labels.", - "Detect both shot-level and frame-level labels." - ], - "enum": [ - "LABEL_DETECTION_MODE_UNSPECIFIED", - "SHOT_MODE", - "FRAME_MODE", - "SHOT_AND_FRAME_MODE" - ] - }, - "stationaryCamera": { - "description": "Whether the video has been shot from a stationary (i.e. non-moving) camera.\nWhen set to true, might improve detection accuracy for moving objects.", - "type": "boolean" } }, - "id": "GoogleCloudVideointelligenceV1beta1_VideoContext" + "id": "GoogleCloudVideointelligenceV1beta1_VideoContext", + "description": "Video context and/or feature-specific parameters." }, "GoogleCloudVideointelligenceV1_LabelAnnotation": { "description": "Label annotation.", @@ -384,13 +226,10 @@ "id": "GoogleCloudVideointelligenceV1_LabelAnnotation" }, "GoogleRpc_Status": { + "id": "GoogleRpc_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.", "type": "object", "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" @@ -405,22 +244,25 @@ "type": "any" } } + }, + "code": { + "description": "The status code, which should be an enum value of google.rpc.Code.", + "format": "int32", + "type": "integer" } - }, - "id": "GoogleRpc_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." + } }, "GoogleCloudVideointelligenceV1_VideoSegment": { "description": "Video segment.", "type": "object", "properties": { - "startTimeOffset": { - "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the start of the segment (inclusive).", + "endTimeOffset": { + "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive).", "format": "google-duration", "type": "string" }, - "endTimeOffset": { - "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the end of the segment (inclusive).", + "startTimeOffset": { + "description": "Time-offset, relative to the beginning of the video,\ncorresponding to the start of the segment (inclusive).", "format": "google-duration", "type": "string" } @@ -435,9 +277,9 @@ "type": "number" }, "timeOffset": { + "type": "string", "description": "Time-offset, relative to the beginning of the video, corresponding to the\nvideo frame for this location.", - "format": "google-duration", - "type": "string" + "format": "google-duration" } }, "id": "GoogleCloudVideointelligenceV1_LabelFrame", @@ -447,16 +289,9 @@ "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults": { "type": "object", "properties": { - "shotLabelAnnotations": { - "description": "Label annotations on shot level.\nThere is exactly one element for each unique label.", - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation" - } - }, "error": { - "$ref": "GoogleRpc_Status", - "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail." + "description": "If set, indicates an error. Note that for a single `AnnotateVideoRequest`\nsome videos may succeed and some may fail.", + "$ref": "GoogleRpc_Status" }, "frameLabelAnnotations": { "description": "Label annotations on frame level.\nThere is exactly one element for each unique label.", @@ -486,27 +321,19 @@ "items": { "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment" } + }, + "shotLabelAnnotations": { + "description": "Label annotations on shot level.\nThere is exactly one element for each unique label.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation" + } } }, "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationResults", "description": "Annotation results for a single video." }, - "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation": { - "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.", - "type": "object", - "properties": { - "frames": { - "description": "All video frames where explicit content was detected.", - "type": "array", - "items": { - "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame" - } - } - }, - "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation" - }, "GoogleCloudVideointelligenceV1beta1_LabelLocation": { - "description": "Label location.", "type": "object", "properties": { "level": { @@ -537,24 +364,39 @@ "description": "Video segment. Set to [-1, -1] for video-level labels.\nSet to [timestamp, timestamp] for frame-level labels.\nOtherwise, corresponds to one of `AnnotateSpec.segments`\n(if specified) or to shot boundaries (if requested)." } }, - "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation" + "id": "GoogleCloudVideointelligenceV1beta1_LabelLocation", + "description": "Label location." }, - "GoogleCloudVideointelligenceV1beta2_LabelFrame": { - "description": "Video frame level annotation results for label detection.", + "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation": { + "description": "Explicit content annotation (based on per-frame visual signals only).\nIf no explicit content has been detected in a frame, no annotations are\npresent for that frame.", "type": "object", "properties": { - "timeOffset": { - "type": "string", - "description": "Time-offset, relative to the beginning of the video, corresponding to the\nvideo frame for this location.", - "format": "google-duration" - }, + "frames": { + "description": "All video frames where explicit content was detected.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame" + } + } + }, + "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentAnnotation" + }, + "GoogleCloudVideointelligenceV1beta2_LabelFrame": { + "type": "object", + "properties": { "confidence": { "description": "Confidence that the label is accurate. Range: [0, 1].", "format": "float", "type": "number" + }, + "timeOffset": { + "description": "Time-offset, relative to the beginning of the video, corresponding to the\nvideo frame for this location.", + "format": "google-duration", + "type": "string" } }, - "id": "GoogleCloudVideointelligenceV1beta2_LabelFrame" + "id": "GoogleCloudVideointelligenceV1beta2_LabelFrame", + "description": "Video frame level annotation results for label detection." }, "GoogleCloudVideointelligenceV1_ExplicitContentFrame": { "id": "GoogleCloudVideointelligenceV1_ExplicitContentFrame", @@ -617,10 +459,17 @@ "id": "GoogleCloudVideointelligenceV1beta2_AnnotateVideoProgress" }, "GoogleCloudVideointelligenceV1_VideoAnnotationProgress": { + "description": "Annotation progress for a single video.", + "type": "object", "properties": { + "startTime": { + "description": "Time when the request was received.", + "format": "google-datetime", + "type": "string" + }, "inputUri": { - "type": "string", - "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/)." + "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).", + "type": "string" }, "progressPercent": { "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.", @@ -628,22 +477,14 @@ "type": "integer" }, "updateTime": { - "type": "string", "description": "Time of the most recent update.", - "format": "google-datetime" - }, - "startTime": { - "description": "Time when the request was received.", "format": "google-datetime", "type": "string" } }, - "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress", - "description": "Annotation progress for a single video.", - "type": "object" + "id": "GoogleCloudVideointelligenceV1_VideoAnnotationProgress" }, "GoogleCloudVideointelligenceV1_AnnotateVideoProgress": { - "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.", "type": "object", "properties": { "annotationProgress": { @@ -654,14 +495,14 @@ } } }, - "id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress" + "id": "GoogleCloudVideointelligenceV1_AnnotateVideoProgress", + "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service." }, "GoogleLongrunning_Operation": { + "id": "GoogleLongrunning_Operation", + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "type": "object", "properties": { - "error": { - "description": "The error result of the operation in case of failure or cancellation.", - "$ref": "GoogleRpc_Status" - }, "metadata": { "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", "type": "object", @@ -685,11 +526,12 @@ "name": { "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", "type": "string" + }, + "error": { + "$ref": "GoogleRpc_Status", + "description": "The error result of the operation in case of failure or cancellation." } - }, - "id": "GoogleLongrunning_Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", - "type": "object" + } }, "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress": { "description": "Annotation progress for a single video.", @@ -705,9 +547,9 @@ "type": "integer" }, "updateTime": { + "type": "string", "description": "Time of the most recent update.", - "format": "google-datetime", - "type": "string" + "format": "google-datetime" }, "startTime": { "description": "Time when the request was received.", @@ -718,7 +560,6 @@ "id": "GoogleCloudVideointelligenceV1beta2_VideoAnnotationProgress" }, "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults": { - "type": "object", "properties": { "shotAnnotations": { "description": "Shot annotations. Each shot is represented as a video segment.", @@ -751,24 +592,40 @@ } }, "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationResults", - "description": "Annotation results for a single video." + "description": "Annotation results for a single video.", + "type": "object" }, "GoogleCloudVideointelligenceV1_AnnotateVideoResponse": { + "id": "GoogleCloudVideointelligenceV1_AnnotateVideoResponse", "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.", "type": "object", "properties": { "annotationResults": { + "description": "Annotation results for all videos specified in `AnnotateVideoRequest`.", "type": "array", "items": { "$ref": "GoogleCloudVideointelligenceV1_VideoAnnotationResults" - }, - "description": "Annotation results for all videos specified in `AnnotateVideoRequest`." + } + } + } + }, + "GoogleCloudVideointelligenceV1_LabelSegment": { + "properties": { + "confidence": { + "description": "Confidence that the label is accurate. Range: [0, 1].", + "format": "float", + "type": "number" + }, + "segment": { + "$ref": "GoogleCloudVideointelligenceV1_VideoSegment", + "description": "Video segment where a label was detected." } }, - "id": "GoogleCloudVideointelligenceV1_AnnotateVideoResponse" + "id": "GoogleCloudVideointelligenceV1_LabelSegment", + "description": "Video segment level annotation results for label detection.", + "type": "object" }, "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse": { - "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.", "type": "object", "properties": { "annotationResults": { @@ -779,57 +636,39 @@ } } }, - "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse" - }, - "GoogleCloudVideointelligenceV1_LabelSegment": { - "id": "GoogleCloudVideointelligenceV1_LabelSegment", - "description": "Video segment level annotation results for label detection.", - "type": "object", - "properties": { - "confidence": { - "description": "Confidence that the label is accurate. Range: [0, 1].", - "format": "float", - "type": "number" - }, - "segment": { - "description": "Video segment where a label was detected.", - "$ref": "GoogleCloudVideointelligenceV1_VideoSegment" - } - } + "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoResponse", + "description": "Video annotation response. Included in the `response`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service." }, "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress": { + "description": "Annotation progress for a single video.", + "type": "object", "properties": { - "startTime": { - "description": "Time when the request was received.", - "format": "google-datetime", + "inputUri": { + "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/).", "type": "string" }, - "inputUri": { - "type": "string", - "description": "Video file location in\n[Google Cloud Storage](https://cloud.google.com/storage/)." - }, "progressPercent": { - "type": "integer", "description": "Approximate percentage processed thus far.\nGuaranteed to be 100 when fully processed.", - "format": "int32" + "format": "int32", + "type": "integer" }, "updateTime": { "description": "Time of the most recent update.", "format": "google-datetime", "type": "string" + }, + "startTime": { + "description": "Time when the request was received.", + "format": "google-datetime", + "type": "string" } }, - "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress", - "description": "Annotation progress for a single video.", - "type": "object" + "id": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress" }, "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame": { - "description": "Video frame level annotation results for explicit content.", "type": "object", "properties": { "pornographyLikelihood": { - "description": "Likelihood of the pornography content..", - "type": "string", "enumDescriptions": [ "Unspecified likelihood.", "Very unlikely.", @@ -845,18 +684,46 @@ "POSSIBLE", "LIKELY", "VERY_LIKELY" - ] + ], + "description": "Likelihood of the pornography content..", + "type": "string" }, "timeOffset": { + "type": "string", "description": "Time-offset, relative to the beginning of the video, corresponding to the\nvideo frame for this location.", - "format": "google-duration", - "type": "string" + "format": "google-duration" } }, - "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame" + "id": "GoogleCloudVideointelligenceV1beta2_ExplicitContentFrame", + "description": "Video frame level annotation results for explicit content." }, "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest": { + "description": "Video annotation request.", + "type": "object", "properties": { + "features": { + "enumDescriptions": [ + "Unspecified.", + "Label detection. Detect objects, such as dog or flower.", + "Shot change detection.", + "Safe search detection." + ], + "description": "Requested video annotation features.", + "type": "array", + "items": { + "type": "string", + "enum": [ + "FEATURE_UNSPECIFIED", + "LABEL_DETECTION", + "SHOT_CHANGE_DETECTION", + "SAFE_SEARCH_DETECTION" + ] + } + }, + "outputUri": { + "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris).", + "type": "string" + }, "videoContext": { "$ref": "GoogleCloudVideointelligenceV1beta1_VideoContext", "description": "Additional video context and/or feature-specific parameters." @@ -872,34 +739,9 @@ "inputContent": { "description": "The video data bytes. Encoding: base64. If unset, the input video(s)\nshould be specified via `input_uri`. If set, `input_uri` should be unset.", "type": "string" - }, - "features": { - "description": "Requested video annotation features.", - "type": "array", - "items": { - "type": "string", - "enum": [ - "FEATURE_UNSPECIFIED", - "LABEL_DETECTION", - "SHOT_CHANGE_DETECTION", - "SAFE_SEARCH_DETECTION" - ] - }, - "enumDescriptions": [ - "Unspecified.", - "Label detection. Detect objects, such as dog or flower.", - "Shot change detection.", - "Safe search detection." - ] - }, - "outputUri": { - "description": "Optional location where the output (in JSON format) should be stored.\nCurrently, only [Google Cloud Storage](https://cloud.google.com/storage/)\nURIs are supported, which must be specified in the following format:\n`gs://bucket-id/object-id` (other URI formats return\ngoogle.rpc.Code.INVALID_ARGUMENT). For more information, see\n[Request URIs](/storage/docs/reference-uris).", - "type": "string" } }, - "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest", - "description": "Video annotation request.", - "type": "object" + "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest" }, "GoogleCloudVideointelligenceV1beta1_VideoSegment": { "description": "Video segment.", @@ -919,6 +761,9 @@ "id": "GoogleCloudVideointelligenceV1beta1_VideoSegment" }, "GoogleCloudVideointelligenceV1beta2_LabelSegment": { + "id": "GoogleCloudVideointelligenceV1beta2_LabelSegment", + "description": "Video segment level annotation results for label detection.", + "type": "object", "properties": { "confidence": { "description": "Confidence that the label is accurate. Range: [0, 1].", @@ -926,20 +771,175 @@ "type": "number" }, "segment": { - "description": "Video segment where a label was detected.", - "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment" + "$ref": "GoogleCloudVideointelligenceV1beta2_VideoSegment", + "description": "Video segment where a label was detected." + } + } + }, + "GoogleCloudVideointelligenceV1beta2_LabelAnnotation": { + "description": "Label annotation.", + "type": "object", + "properties": { + "segments": { + "description": "All video segments where a label was detected.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_LabelSegment" + } + }, + "categoryEntities": { + "description": "Common categories for the detected entity.\nE.g. when the label is `Terrier` the category is likely `dog`. And in some\ncases there might be more than one categories e.g. `Terrier` could also be\na `pet`.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_Entity" + } + }, + "entity": { + "$ref": "GoogleCloudVideointelligenceV1beta2_Entity", + "description": "Detected entity." + }, + "frames": { + "description": "All video frames where a label was detected.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta2_LabelFrame" + } } }, - "id": "GoogleCloudVideointelligenceV1beta2_LabelSegment", - "description": "Video segment level annotation results for label detection.", - "type": "object" + "id": "GoogleCloudVideointelligenceV1beta2_LabelAnnotation" + }, + "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation": { + "description": "Safe search annotation (based on per-frame visual signals only).\nIf no unsafe content has been detected in a frame, no annotations\nare present for that frame. If only some types of unsafe content\nhave been detected in a frame, the likelihood is set to `UNKNOWN`\nfor all other types of unsafe content.", + "type": "object", + "properties": { + "timeOffset": { + "description": "Video time offset in microseconds.", + "format": "int64", + "type": "string" + }, + "spoof": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood that an obvious modification was made to the original\nversion to make it appear funny or offensive.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "Very unlikely.", + "Unlikely.", + "Possible.", + "Likely.", + "Very likely." + ] + }, + "violent": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood of violent content.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "Very unlikely.", + "Unlikely.", + "Possible.", + "Likely.", + "Very likely." + ] + }, + "medical": { + "enumDescriptions": [ + "Unknown likelihood.", + "Very unlikely.", + "Unlikely.", + "Possible.", + "Likely.", + "Very likely." + ], + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood of medical content.", + "type": "string" + }, + "adult": { + "enumDescriptions": [ + "Unknown likelihood.", + "Very unlikely.", + "Unlikely.", + "Possible.", + "Likely.", + "Very likely." + ], + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood of adult content.", + "type": "string" + }, + "racy": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood of racy content.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "Very unlikely.", + "Unlikely.", + "Possible.", + "Likely.", + "Very likely." + ] + } + }, + "id": "GoogleCloudVideointelligenceV1beta1_SafeSearchAnnotation" + }, + "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress": { + "description": "Video annotation progress. Included in the `metadata`\nfield of the `Operation` returned by the `GetOperation`\ncall of the `google::longrunning::Operations` service.", + "type": "object", + "properties": { + "annotationProgress": { + "description": "Progress metadata for all videos specified in `AnnotateVideoRequest`.", + "type": "array", + "items": { + "$ref": "GoogleCloudVideointelligenceV1beta1_VideoAnnotationProgress" + } + } + }, + "id": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoProgress" } }, - "protocol": "rest", "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, + "protocol": "rest", "canonicalName": "Cloud Video Intelligence", "auth": { "oauth2": { @@ -961,6 +961,10 @@ "videos": { "methods": { "annotate": { + "request": { + "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest" + }, + "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results).", "response": { "$ref": "GoogleLongrunning_Operation" }, @@ -972,21 +976,87 @@ ], "flatPath": "v1beta1/videos:annotate", "path": "v1beta1/videos:annotate", - "id": "videointelligence.videos.annotate", - "request": { - "$ref": "GoogleCloudVideointelligenceV1beta1_AnnotateVideoRequest" - }, - "description": "Performs asynchronous video annotation. Progress and results can be\nretrieved through the `google.longrunning.Operations` interface.\n`Operation.metadata` contains `AnnotateVideoProgress` (progress).\n`Operation.response` contains `AnnotateVideoResponse` (results)." + "id": "videointelligence.videos.annotate" } } } }, "parameters": { + "upload_protocol": { + "type": "string", + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "$.xgafv": { + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "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", + "description": "Data format for response.", + "default": "json", + "enum": [ + "json", + "media", + "proto" + ], + "type": "string" + }, + "access_token": { + "description": "OAuth access token.", + "type": "string", + "location": "query" + }, + "key": { + "location": "query", + "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.", + "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.", + "type": "string", + "location": "query" + }, "pp": { + "location": "query", "description": "Pretty-print response.", "type": "boolean", - "default": "true", - "location": "query" + "default": "true" }, "oauth_token": { "location": "query", @@ -994,79 +1064,9 @@ "type": "string" }, "bearer_token": { - "location": "query", "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "type": "string", - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "type": "string", - "location": "query", - "description": "Selector specifying which fields to include in a partial response." - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "callback": { - "description": "JSONP", "type": "string", "location": "query" - }, - "$.xgafv": { - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ] - }, - "alt": { - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response." - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "quotaUser": { - "location": "query", - "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.", - "type": "string" } }, "version": "v1beta1",
diff --git a/vision/v1/vision-api.json b/vision/v1/vision-api.json index 1ec407f..9ab03de 100644 --- a/vision/v1/vision-api.json +++ b/vision/v1/vision-api.json
@@ -1,122 +1,4 @@ { - "name": "vision", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Vision API", - "ownerName": "Google", - "resources": { - "images": { - "methods": { - "annotate": { - "description": "Run image detection and annotation for a batch of images.", - "request": { - "$ref": "BatchAnnotateImagesRequest" - }, - "response": { - "$ref": "BatchAnnotateImagesResponse" - }, - "parameterOrder": [], - "httpMethod": "POST", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-vision" - ], - "parameters": {}, - "flatPath": "v1/images:annotate", - "path": "v1/images:annotate", - "id": "vision.images.annotate" - } - } - } - }, - "parameters": { - "quotaUser": { - "location": "query", - "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.", - "type": "string" - }, - "pp": { - "location": "query", - "description": "Pretty-print response.", - "type": "boolean", - "default": "true" - }, - "oauth_token": { - "description": "OAuth 2.0 token for the current user.", - "type": "string", - "location": "query" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "location": "query", - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true" - }, - "uploadType": { - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, - "alt": { - "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", - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string" - }, - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - } - }, "version": "v1", "baseUrl": "https://vision.googleapis.com/", "servicePath": "", @@ -129,281 +11,61 @@ "discoveryVersion": "v1", "version_module": true, "schemas": { - "ImageProperties": { - "description": "Stores image properties, such as dominant colors.", - "type": "object", - "properties": { - "dominantColors": { - "description": "If present, dominant colors completed successfully.", - "$ref": "DominantColorsAnnotation" - } - }, - "id": "ImageProperties" - }, - "Feature": { - "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", - "type": "object", - "properties": { - "type": { - "enumDescriptions": [ - "Unspecified feature type.", - "Run face detection.", - "Run landmark detection.", - "Run logo detection.", - "Run label detection.", - "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", - "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", - "Run Safe Search to detect potentially unsafe\nor undesirable content.", - "Compute a set of image properties, such as the\nimage's dominant colors.", - "Run crop hints.", - "Run web detection." - ], - "enum": [ - "TYPE_UNSPECIFIED", - "FACE_DETECTION", - "LANDMARK_DETECTION", - "LOGO_DETECTION", - "LABEL_DETECTION", - "TEXT_DETECTION", - "DOCUMENT_TEXT_DETECTION", - "SAFE_SEARCH_DETECTION", - "IMAGE_PROPERTIES", - "CROP_HINTS", - "WEB_DETECTION" - ], - "description": "The feature type.", - "type": "string" - }, - "maxResults": { - "description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", - "format": "int32", - "type": "integer" - } - }, - "id": "Feature" - }, - "SafeSearchAnnotation": { - "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", - "type": "object", - "properties": { - "medical": { - "description": "Likelihood that this is a medical image.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ] - }, - "violence": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Likelihood that this image contains violent content.", - "type": "string" - }, - "adult": { - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ] - }, - "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ] - } - }, - "id": "SafeSearchAnnotation" - }, - "DominantColorsAnnotation": { - "id": "DominantColorsAnnotation", - "description": "Set of dominant colors and their corresponding scores.", - "type": "object", - "properties": { - "colors": { - "description": "RGB color values with their score and pixel fraction.", - "type": "array", - "items": { - "$ref": "ColorInfo" - } - } - } - }, - "TextAnnotation": { - "id": "TextAnnotation", - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", - "type": "object", - "properties": { - "pages": { - "description": "List of pages detected by OCR.", - "type": "array", - "items": { - "$ref": "Page" - } - }, - "text": { - "description": "UTF-8 text detected on the pages.", - "type": "string" - } - } - }, - "DetectedLanguage": { - "id": "DetectedLanguage", - "description": "Detected language for a structural component.", - "type": "object", - "properties": { - "languageCode": { - "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", - "type": "string" - }, - "confidence": { - "description": "Confidence of detected language. Range [0, 1].", - "format": "float", - "type": "number" - } - } - }, - "Vertex": { - "id": "Vertex", - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", - "type": "object", - "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate.", - "format": "int32", - "type": "integer" - } - } - }, "TextProperty": { - "id": "TextProperty", "description": "Additional information detected on the structural component.", "type": "object", "properties": { - "detectedLanguages": { - "description": "A list of detected languages together with confidence.", - "type": "array", - "items": { - "$ref": "DetectedLanguage" - } - }, "detectedBreak": { "$ref": "DetectedBreak", "description": "Detected start or end of a text segment." + }, + "detectedLanguages": { + "type": "array", + "items": { + "$ref": "DetectedLanguage" + }, + "description": "A list of detected languages together with confidence." } - } + }, + "id": "TextProperty" }, "BoundingPoly": { - "description": "A bounding polygon for the detected image annotation.", "type": "object", "properties": { "vertices": { - "description": "The bounding polygon vertices.", "type": "array", "items": { "$ref": "Vertex" - } + }, + "description": "The bounding polygon vertices." } }, - "id": "BoundingPoly" + "id": "BoundingPoly", + "description": "A bounding polygon for the detected image annotation." }, "WebEntity": { - "description": "Entity deduced from similar images on the Internet.", "type": "object", "properties": { "entityId": { - "description": "Opaque entity ID.", - "type": "string" + "type": "string", + "description": "Opaque entity ID." }, "description": { "description": "Canonical description of the entity, in English.", "type": "string" }, "score": { + "type": "number", "description": "Overall relevancy score for the entity.\nNot normalized and not comparable across different image queries.", - "format": "float", - "type": "number" + "format": "float" } }, - "id": "WebEntity" + "id": "WebEntity", + "description": "Entity deduced from similar images on the Internet." }, "AnnotateImageResponse": { - "description": "Response to an image annotation request.", "type": "object", "properties": { - "landmarkAnnotations": { - "description": "If present, landmark detection has completed successfully.", - "type": "array", - "items": { - "$ref": "EntityAnnotation" - } - }, - "textAnnotations": { - "description": "If present, text (OCR) detection has completed successfully.", - "type": "array", - "items": { - "$ref": "EntityAnnotation" - } - }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "type": "array", @@ -412,8 +74,8 @@ } }, "imagePropertiesAnnotation": { - "description": "If present, image properties were extracted successfully.", - "$ref": "ImageProperties" + "$ref": "ImageProperties", + "description": "If present, image properties were extracted successfully." }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", @@ -423,8 +85,8 @@ } }, "cropHintsAnnotation": { - "description": "If present, crop hints have completed successfully.", - "$ref": "CropHintsAnnotation" + "$ref": "CropHintsAnnotation", + "description": "If present, crop hints have completed successfully." }, "webDetection": { "$ref": "WebDetection", @@ -438,45 +100,56 @@ } }, "safeSearchAnnotation": { - "description": "If present, safe-search annotation has completed successfully.", - "$ref": "SafeSearchAnnotation" + "$ref": "SafeSearchAnnotation", + "description": "If present, safe-search annotation has completed successfully." }, "error": { "$ref": "Status", "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." }, "fullTextAnnotation": { - "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext.", - "$ref": "TextAnnotation" + "$ref": "TextAnnotation", + "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." + }, + "landmarkAnnotations": { + "description": "If present, landmark detection has completed successfully.", + "type": "array", + "items": { + "$ref": "EntityAnnotation" + } + }, + "textAnnotations": { + "type": "array", + "items": { + "$ref": "EntityAnnotation" + }, + "description": "If present, text (OCR) detection has completed successfully." } }, - "id": "AnnotateImageResponse" + "id": "AnnotateImageResponse", + "description": "Response to an image annotation request." }, "CropHintsParams": { - "id": "CropHintsParams", "description": "Parameters for crop hints annotation request.", "type": "object", "properties": { "aspectRatios": { - "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored.", "type": "array", "items": { - "format": "float", - "type": "number" - } + "type": "number", + "format": "float" + }, + "description": "Aspect ratios in floats, representing the ratio of the width to the height\nof the image. For example, if the desired aspect ratio is 4/3, the\ncorresponding float value should be 1.33333. If not specified, the\nbest possible crop is returned. The number of provided aspect ratios is\nlimited to a maximum of 16; any aspect ratios provided after the 16th are\nignored." } - } + }, + "id": "CropHintsParams" }, "Block": { - "id": "Block", "description": "Logical element on the page.", "type": "object", "properties": { - "property": { - "description": "Additional information detected for the block.", - "$ref": "TextProperty" - }, "blockType": { + "type": "string", "enumDescriptions": [ "Unknown block type.", "Regular text block.", @@ -493,40 +166,29 @@ "RULER", "BARCODE" ], - "description": "Detected block type (text, image etc) for this block.", - "type": "string" + "description": "Detected block type (text, image etc) for this block." }, "boundingBox": { "$ref": "BoundingPoly", "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertice order will still be (0, 1, 2, 3)." }, "paragraphs": { - "description": "List of paragraphs in this block (if this blocks is of type text).", "type": "array", "items": { "$ref": "Paragraph" - } + }, + "description": "List of paragraphs in this block (if this blocks is of type text)." + }, + "property": { + "$ref": "TextProperty", + "description": "Additional information detected for the block." } - } + }, + "id": "Block" }, "WebDetection": { - "description": "Relevant information for the image from the Internet.", "type": "object", "properties": { - "webEntities": { - "description": "Deduced entities from similar images on the Internet.", - "type": "array", - "items": { - "$ref": "WebEntity" - } - }, - "pagesWithMatchingImages": { - "description": "Web pages containing the matching images from the Internet.", - "type": "array", - "items": { - "$ref": "WebPage" - } - }, "partialMatchingImages": { "description": "Partial matching images from the Internet.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its crops.", "type": "array", @@ -547,9 +209,24 @@ "items": { "$ref": "WebImage" } + }, + "webEntities": { + "description": "Deduced entities from similar images on the Internet.", + "type": "array", + "items": { + "$ref": "WebEntity" + } + }, + "pagesWithMatchingImages": { + "description": "Web pages containing the matching images from the Internet.", + "type": "array", + "items": { + "$ref": "WebPage" + } } }, - "id": "WebDetection" + "id": "WebDetection", + "description": "Relevant information for the image from the Internet." }, "BatchAnnotateImagesResponse": { "description": "Response to a batch image annotation request.", @@ -566,22 +243,21 @@ "id": "BatchAnnotateImagesResponse" }, "ImageSource": { - "id": "ImageSource", - "description": "External image source (Google Cloud Storage or web URL image location).", "type": "object", "properties": { + "imageUri": { + "type": "string", + "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence." + }, "gcsImageUri": { "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", "type": "string" - }, - "imageUri": { - "description": "The URI of the source image. Can be either:\n\n1. A Google Cloud Storage URI of the form\n `gs://bucket_name/object_name`. Object versioning is not supported. See\n [Google Cloud Storage Request\n URIs](https://cloud.google.com/storage/docs/reference-uris) for more\n info.\n\n2. A publicly-accessible image HTTP/HTTPS URL. When fetching images from\n HTTP/HTTPS URLs, Google cannot guarantee that the request will be\n completed. Your request may fail if the specified host denies the\n request (e.g. due to request throttling or DOS prevention), or if Google\n throttles requests to the site for abuse prevention. You should not\n depend on externally-hosted images for production applications.\n\nWhen both `gcs_image_uri` and `image_uri` are specified, `image_uri` takes\nprecedence.", - "type": "string" } - } + }, + "id": "ImageSource", + "description": "External image source (Google Cloud Storage or web URL image location)." }, "LocationInfo": { - "description": "Detected entity location information.", "type": "object", "properties": { "latLng": { @@ -589,17 +265,13 @@ "description": "lat/long location coordinates." } }, - "id": "LocationInfo" + "id": "LocationInfo", + "description": "Detected entity location information." }, "Property": { - "id": "Property", "description": "A `Property` consists of a user-supplied name/value pair.", "type": "object", "properties": { - "name": { - "description": "Name of the property.", - "type": "string" - }, "value": { "description": "Value of the property.", "type": "string" @@ -608,33 +280,37 @@ "description": "Value of numeric properties.", "format": "uint64", "type": "string" + }, + "name": { + "type": "string", + "description": "Name of the property." } - } + }, + "id": "Property" }, "Position": { "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", "type": "object", "properties": { + "y": { + "type": "number", + "description": "Y coordinate.", + "format": "float" + }, "x": { + "type": "number", "description": "X coordinate.", - "format": "float", - "type": "number" + "format": "float" }, "z": { "description": "Z coordinate (or depth).", "format": "float", "type": "number" - }, - "y": { - "description": "Y coordinate.", - "format": "float", - "type": "number" } }, "id": "Position" }, "WebPage": { - "id": "WebPage", "description": "Metadata for web pages.", "type": "object", "properties": { @@ -647,12 +323,18 @@ "description": "The result web page URL.", "type": "string" } - } + }, + "id": "WebPage" }, "ColorInfo": { "description": "Color information consists of RGB channels, score, and the fraction of\nthe image that the color occupies in the image.", "type": "object", "properties": { + "score": { + "description": "Image-specific score for this color. Value in range [0, 1].", + "format": "float", + "type": "number" + }, "pixelFraction": { "description": "The fraction of pixels the color occupies in the image.\nValue in range [0, 1].", "format": "float", @@ -661,34 +343,28 @@ "color": { "$ref": "Color", "description": "RGB components of the color." - }, - "score": { - "description": "Image-specific score for this color. Value in range [0, 1].", - "format": "float", - "type": "number" } }, "id": "ColorInfo" }, "EntityAnnotation": { - "description": "Set of detected entity features.", "type": "object", "properties": { "score": { + "type": "number", "description": "Overall score of the result. Range [0, 1].", - "format": "float", - "type": "number" + "format": "float" }, "locations": { - "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks.", "type": "array", "items": { "$ref": "LocationInfo" - } + }, + "description": "The location information for the detected entity. Multiple\n`LocationInfo` elements can be present because one location may\nindicate the location of the scene in the image, and another location\nmay indicate the location of the place where the image was taken.\nLocation information is usually present for landmarks." }, "mid": { - "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/).", - "type": "string" + "type": "string", + "description": "Opaque entity ID. Some IDs may be available in\n[Google Knowledge Graph Search\nAPI](https://developers.google.com/knowledge-graph/)." }, "confidence": { "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", @@ -700,17 +376,17 @@ "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." }, "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", - "type": "string" + "type": "string", + "description": "The language code for the locale in which the entity textual\n`description` is expressed." }, "topicality": { + "type": "number", "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", - "format": "float", - "type": "number" + "format": "float" }, "description": { - "description": "Entity textual description, expressed in its `locale` language.", - "type": "string" + "type": "string", + "description": "Entity textual description, expressed in its `locale` language." }, "properties": { "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", @@ -720,31 +396,31 @@ } } }, - "id": "EntityAnnotation" + "id": "EntityAnnotation", + "description": "Set of detected entity features." }, "CropHint": { - "description": "Single crop hint that is used to generate a new crop when serving an image.", "type": "object", "properties": { - "boundingPoly": { - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`.", - "$ref": "BoundingPoly" - }, "confidence": { + "type": "number", "description": "Confidence of this being a salient region. Range [0, 1].", - "format": "float", - "type": "number" + "format": "float" }, "importanceFraction": { "description": "Fraction of importance of this salient region with respect to the original\nimage.", "format": "float", "type": "number" + }, + "boundingPoly": { + "$ref": "BoundingPoly", + "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`." } }, - "id": "CropHint" + "id": "CropHint", + "description": "Single crop hint that is used to generate a new crop when serving an image." }, "Landmark": { - "description": "A face-specific landmark (for example, a face feature).", "type": "object", "properties": { "position": { @@ -752,6 +428,43 @@ "description": "Face landmark position." }, "type": { + "enum": [ + "UNKNOWN_LANDMARK", + "LEFT_EYE", + "RIGHT_EYE", + "LEFT_OF_LEFT_EYEBROW", + "RIGHT_OF_LEFT_EYEBROW", + "LEFT_OF_RIGHT_EYEBROW", + "RIGHT_OF_RIGHT_EYEBROW", + "MIDPOINT_BETWEEN_EYES", + "NOSE_TIP", + "UPPER_LIP", + "LOWER_LIP", + "MOUTH_LEFT", + "MOUTH_RIGHT", + "MOUTH_CENTER", + "NOSE_BOTTOM_RIGHT", + "NOSE_BOTTOM_LEFT", + "NOSE_BOTTOM_CENTER", + "LEFT_EYE_TOP_BOUNDARY", + "LEFT_EYE_RIGHT_CORNER", + "LEFT_EYE_BOTTOM_BOUNDARY", + "LEFT_EYE_LEFT_CORNER", + "RIGHT_EYE_TOP_BOUNDARY", + "RIGHT_EYE_RIGHT_CORNER", + "RIGHT_EYE_BOTTOM_BOUNDARY", + "RIGHT_EYE_LEFT_CORNER", + "LEFT_EYEBROW_UPPER_MIDPOINT", + "RIGHT_EYEBROW_UPPER_MIDPOINT", + "LEFT_EAR_TRAGION", + "RIGHT_EAR_TRAGION", + "LEFT_EYE_PUPIL", + "RIGHT_EYE_PUPIL", + "FOREHEAD_GLABELLA", + "CHIN_GNATHION", + "CHIN_LEFT_GONION", + "CHIN_RIGHT_GONION" + ], "description": "Face landmark type.", "type": "string", "enumDescriptions": [ @@ -790,47 +503,11 @@ "Chin gnathion.", "Chin left gonion.", "Chin right gonion." - ], - "enum": [ - "UNKNOWN_LANDMARK", - "LEFT_EYE", - "RIGHT_EYE", - "LEFT_OF_LEFT_EYEBROW", - "RIGHT_OF_LEFT_EYEBROW", - "LEFT_OF_RIGHT_EYEBROW", - "RIGHT_OF_RIGHT_EYEBROW", - "MIDPOINT_BETWEEN_EYES", - "NOSE_TIP", - "UPPER_LIP", - "LOWER_LIP", - "MOUTH_LEFT", - "MOUTH_RIGHT", - "MOUTH_CENTER", - "NOSE_BOTTOM_RIGHT", - "NOSE_BOTTOM_LEFT", - "NOSE_BOTTOM_CENTER", - "LEFT_EYE_TOP_BOUNDARY", - "LEFT_EYE_RIGHT_CORNER", - "LEFT_EYE_BOTTOM_BOUNDARY", - "LEFT_EYE_LEFT_CORNER", - "RIGHT_EYE_TOP_BOUNDARY", - "RIGHT_EYE_RIGHT_CORNER", - "RIGHT_EYE_BOTTOM_BOUNDARY", - "RIGHT_EYE_LEFT_CORNER", - "LEFT_EYEBROW_UPPER_MIDPOINT", - "RIGHT_EYEBROW_UPPER_MIDPOINT", - "LEFT_EAR_TRAGION", - "RIGHT_EAR_TRAGION", - "LEFT_EYE_PUPIL", - "RIGHT_EYE_PUPIL", - "FOREHEAD_GLABELLA", - "CHIN_GNATHION", - "CHIN_LEFT_GONION", - "CHIN_RIGHT_GONION" ] } }, - "id": "Landmark" + "id": "Landmark", + "description": "A face-specific landmark (for example, a face feature)." }, "WebImage": { "description": "Metadata for online images.", @@ -842,89 +519,77 @@ "type": "number" }, "url": { - "description": "The result image URL.", - "type": "string" + "type": "string", + "description": "The result image URL." } }, "id": "WebImage" }, "Word": { - "id": "Word", - "description": "A word representation.", "type": "object", "properties": { "property": { - "description": "Additional information detected for the word.", - "$ref": "TextProperty" + "$ref": "TextProperty", + "description": "Additional information detected for the word." }, "boundingBox": { - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).", - "$ref": "BoundingPoly" + "$ref": "BoundingPoly", + "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." }, "symbols": { - "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "Symbol" - } + }, + "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order." } - } + }, + "id": "Word", + "description": "A word representation." }, "Image": { - "id": "Image", - "description": "Client image to perform Google Cloud Vision API tasks over.", "type": "object", "properties": { "content": { + "type": "string", "description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.", - "format": "byte", - "type": "string" + "format": "byte" }, "source": { - "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request.", - "$ref": "ImageSource" + "$ref": "ImageSource", + "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request." } - } + }, + "id": "Image", + "description": "Client image to perform Google Cloud Vision API tasks over." }, "Paragraph": { - "id": "Paragraph", "description": "Structural unit of text representing a number of words in certain order.", "type": "object", "properties": { - "words": { - "description": "List of words in this paragraph.", - "type": "array", - "items": { - "$ref": "Word" - } - }, "property": { - "description": "Additional information detected for the paragraph.", - "$ref": "TextProperty" + "$ref": "TextProperty", + "description": "Additional information detected for the paragraph." }, "boundingBox": { "$ref": "BoundingPoly", "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." + }, + "words": { + "type": "array", + "items": { + "$ref": "Word" + }, + "description": "List of words in this paragraph." } - } + }, + "id": "Paragraph" }, "FaceAnnotation": { "description": "A face annotation object contains the results of face detection.", "type": "object", "properties": { - "fdBoundingPoly": { - "$ref": "BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix." - }, "angerLikelihood": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -934,7 +599,15 @@ "VERY_LIKELY" ], "description": "Anger likelihood.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] }, "landmarks": { "description": "Detected face landmarks.", @@ -944,6 +617,14 @@ } }, "surpriseLikelihood": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], "description": "Surprise likelihood.", "type": "string", "enumDescriptions": [ @@ -953,14 +634,6 @@ "It is possible that the image belongs to the specified vertical.", "It is likely that the image belongs to the specified vertical.", "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" ] }, "landmarkingConfidence": { @@ -969,6 +642,7 @@ "type": "number" }, "joyLikelihood": { + "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely that the image belongs to the specified vertical.", @@ -985,18 +659,9 @@ "LIKELY", "VERY_LIKELY" ], - "description": "Joy likelihood.", - "type": "string" + "description": "Joy likelihood." }, "underExposedLikelihood": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -1006,19 +671,35 @@ "VERY_LIKELY" ], "description": "Under-exposed likelihood.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] }, "panAngle": { + "type": "number", "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", - "format": "float", - "type": "number" + "format": "float" }, "detectionConfidence": { + "type": "number", "description": "Detection confidence. Range [0, 1].", - "format": "float", - "type": "number" + "format": "float" }, "blurredLikelihood": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], "description": "Blurred likelihood.", "type": "string", "enumDescriptions": [ @@ -1028,25 +709,9 @@ "It is possible that the image belongs to the specified vertical.", "It is likely that the image belongs to the specified vertical.", "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" ] }, "headwearLikelihood": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -1056,11 +721,19 @@ "VERY_LIKELY" ], "description": "Headwear likelihood.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] }, "boundingPoly": { - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.", - "$ref": "BoundingPoly" + "$ref": "BoundingPoly", + "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." }, "rollAngle": { "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", @@ -1068,7 +741,6 @@ "type": "number" }, "sorrowLikelihood": { - "description": "Sorrow likelihood.", "type": "string", "enumDescriptions": [ "Unknown likelihood.", @@ -1085,18 +757,22 @@ "POSSIBLE", "LIKELY", "VERY_LIKELY" - ] + ], + "description": "Sorrow likelihood." }, "tiltAngle": { "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" + }, + "fdBoundingPoly": { + "$ref": "BoundingPoly", + "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix." } }, "id": "FaceAnnotation" }, "BatchAnnotateImagesRequest": { - "description": "Multiple image annotation requests are batched into a single service call.", "type": "object", "properties": { "requests": { @@ -1107,26 +783,14 @@ } } }, - "id": "BatchAnnotateImagesRequest" + "id": "BatchAnnotateImagesRequest", + "description": "Multiple image annotation requests are batched into a single service call." }, "DetectedBreak": { - "id": "DetectedBreak", "description": "Detected start or end of a structural component.", "type": "object", "properties": { - "isPrefix": { - "description": "True if break prepends the element.", - "type": "boolean" - }, "type": { - "enumDescriptions": [ - "Unknown break label type.", - "Regular space.", - "Sure space (very wide).", - "Line-wrapping break.", - "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", - "Line break that ends a paragraph." - ], "enum": [ "UNKNOWN", "SPACE", @@ -1136,126 +800,138 @@ "LINE_BREAK" ], "description": "Detected break type.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown break label type.", + "Regular space.", + "Sure space (very wide).", + "Line-wrapping break.", + "End-line hyphen that is not present in text; does not co-occur with\n`SPACE`, `LEADER_SPACE`, or `LINE_BREAK`.", + "Line break that ends a paragraph." + ] + }, + "isPrefix": { + "type": "boolean", + "description": "True if break prepends the element." } - } + }, + "id": "DetectedBreak" }, "ImageContext": { - "id": "ImageContext", - "description": "Image context and/or feature-specific parameters.", "type": "object", "properties": { + "cropHintsParams": { + "$ref": "CropHintsParams", + "description": "Parameters for crop hints annotation request." + }, "languageHints": { - "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).", "type": "array", "items": { "type": "string" - } + }, + "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages)." }, "latLongRect": { "$ref": "LatLongRect", "description": "lat/long rectangle that specifies the location of the image." - }, - "cropHintsParams": { - "description": "Parameters for crop hints annotation request.", - "$ref": "CropHintsParams" } - } + }, + "id": "ImageContext", + "description": "Image context and/or feature-specific parameters." }, "Page": { - "description": "Detected page from OCR.", "type": "object", "properties": { + "width": { + "type": "integer", + "description": "Page width in pixels.", + "format": "int32" + }, + "blocks": { + "type": "array", + "items": { + "$ref": "Block" + }, + "description": "List of blocks of text, images etc on this page." + }, + "property": { + "$ref": "TextProperty", + "description": "Additional information detected on the page." + }, "height": { "description": "Page height in pixels.", "format": "int32", "type": "integer" - }, - "width": { - "description": "Page width in pixels.", - "format": "int32", - "type": "integer" - }, - "blocks": { - "description": "List of blocks of text, images etc on this page.", - "type": "array", - "items": { - "$ref": "Block" - } - }, - "property": { - "description": "Additional information detected on the page.", - "$ref": "TextProperty" } }, - "id": "Page" + "id": "Page", + "description": "Detected page from OCR." }, "AnnotateImageRequest": { "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.", "type": "object", "properties": { - "imageContext": { - "$ref": "ImageContext", - "description": "Additional context that may accompany the image." - }, "image": { "$ref": "Image", "description": "The image to be processed." }, "features": { - "description": "Requested features.", "type": "array", "items": { "$ref": "Feature" - } + }, + "description": "Requested features." + }, + "imageContext": { + "$ref": "ImageContext", + "description": "Additional context that may accompany the image." } }, "id": "AnnotateImageRequest" }, "Status": { - "id": "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.", "type": "object", "properties": { "code": { + "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", - "format": "int32", - "type": "integer" + "format": "int32" }, "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": "string", + "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." }, "details": { - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use.", "type": "array", "items": { - "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" - } - } + }, + "type": "object" + }, + "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." } - } + }, + "id": "Status" }, "LatLongRect": { - "id": "LatLongRect", "description": "Rectangle determined by min and max `LatLng` pairs.", "type": "object", "properties": { - "minLatLng": { - "description": "Min lat/long pair.", - "$ref": "LatLng" - }, "maxLatLng": { "$ref": "LatLng", "description": "Max lat/long pair." + }, + "minLatLng": { + "$ref": "LatLng", + "description": "Min lat/long pair." } - } + }, + "id": "LatLongRect" }, "Symbol": { - "id": "Symbol", "description": "A single symbol representation.", "type": "object", "properties": { @@ -1264,48 +940,48 @@ "type": "string" }, "property": { - "description": "Additional information detected for the symbol.", - "$ref": "TextProperty" + "$ref": "TextProperty", + "description": "Additional information detected for the symbol." }, "boundingBox": { - "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).", - "$ref": "BoundingPoly" + "$ref": "BoundingPoly", + "description": "The bounding box for the symbol.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." } - } + }, + "id": "Symbol" }, "CropHintsAnnotation": { - "description": "Set of crop hints that are used to generate new crops when serving images.", "type": "object", "properties": { "cropHints": { - "description": "Crop hint results.", "type": "array", "items": { "$ref": "CropHint" - } + }, + "description": "Crop hint results." } }, - "id": "CropHintsAnnotation" + "id": "CropHintsAnnotation", + "description": "Set of crop hints that are used to generate new crops when serving images." }, "LatLng": { "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", "type": "object", "properties": { - "longitude": { - "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", - "format": "double", - "type": "number" - }, "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", "format": "double", "type": "number" + }, + "longitude": { + "type": "number", + "description": "The longitude in degrees. It must be in the range [-180.0, +180.0].", + "format": "double" } }, "id": "LatLng" }, "Color": { - "id": "Color", "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", "type": "object", "properties": { @@ -1320,22 +996,228 @@ "type": "number" }, "blue": { + "type": "number", "description": "The amount of blue in the color as a value in the interval [0, 1].", - "format": "float", - "type": "number" + "format": "float" }, "alpha": { "description": "The fraction of this color that should be applied to the pixel. That is,\nthe final pixel color is defined by the equation:\n\n pixel color = alpha * (this color) + (1.0 - alpha) * (background color)\n\nThis means that a value of 1.0 corresponds to a solid color, whereas\na value of 0.0 corresponds to a completely transparent color. This\nuses a wrapper message rather than a simple float scalar so that it is\npossible to distinguish between a default value and the value being unset.\nIf omitted, this color object is to be rendered as a solid color\n(as if the alpha value had been explicitly given with a value of 1.0).", "format": "float", "type": "number" } - } + }, + "id": "Color" + }, + "ImageProperties": { + "description": "Stores image properties, such as dominant colors.", + "type": "object", + "properties": { + "dominantColors": { + "$ref": "DominantColorsAnnotation", + "description": "If present, dominant colors completed successfully." + } + }, + "id": "ImageProperties" + }, + "Feature": { + "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", + "type": "object", + "properties": { + "type": { + "enum": [ + "TYPE_UNSPECIFIED", + "FACE_DETECTION", + "LANDMARK_DETECTION", + "LOGO_DETECTION", + "LABEL_DETECTION", + "TEXT_DETECTION", + "DOCUMENT_TEXT_DETECTION", + "SAFE_SEARCH_DETECTION", + "IMAGE_PROPERTIES", + "CROP_HINTS", + "WEB_DETECTION" + ], + "description": "The feature type.", + "type": "string", + "enumDescriptions": [ + "Unspecified feature type.", + "Run face detection.", + "Run landmark detection.", + "Run logo detection.", + "Run label detection.", + "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", + "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", + "Run Safe Search to detect potentially unsafe\nor undesirable content.", + "Compute a set of image properties, such as the\nimage's dominant colors.", + "Run crop hints.", + "Run web detection." + ] + }, + "maxResults": { + "type": "integer", + "description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", + "format": "int32" + } + }, + "id": "Feature" + }, + "SafeSearchAnnotation": { + "type": "object", + "properties": { + "adult": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] + }, + "spoof": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] + }, + "medical": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood that this is a medical image.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] + }, + "violence": { + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ], + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood that this image contains violent content." + } + }, + "id": "SafeSearchAnnotation", + "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence)." + }, + "DominantColorsAnnotation": { + "description": "Set of dominant colors and their corresponding scores.", + "type": "object", + "properties": { + "colors": { + "type": "array", + "items": { + "$ref": "ColorInfo" + }, + "description": "RGB color values with their score and pixel fraction." + } + }, + "id": "DominantColorsAnnotation" + }, + "TextAnnotation": { + "type": "object", + "properties": { + "text": { + "type": "string", + "description": "UTF-8 text detected on the pages." + }, + "pages": { + "type": "array", + "items": { + "$ref": "Page" + }, + "description": "List of pages detected by OCR." + } + }, + "id": "TextAnnotation", + "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail." + }, + "DetectedLanguage": { + "description": "Detected language for a structural component.", + "type": "object", + "properties": { + "confidence": { + "description": "Confidence of detected language. Range [0, 1].", + "format": "float", + "type": "number" + }, + "languageCode": { + "description": "The BCP-47 language code, such as \"en-US\" or \"sr-Latn\". For more\ninformation, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", + "type": "string" + } + }, + "id": "DetectedLanguage" + }, + "Vertex": { + "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "type": "object", + "properties": { + "y": { + "type": "integer", + "description": "Y coordinate.", + "format": "int32" + }, + "x": { + "type": "integer", + "description": "X coordinate.", + "format": "int32" + } + }, + "id": "Vertex" } }, "protocol": "rest", "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, "canonicalName": "Vision", "auth": { @@ -1351,5 +1233,123 @@ } }, "rootUrl": "https://vision.googleapis.com/", - "ownerDomain": "google.com" + "ownerDomain": "google.com", + "name": "vision", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Cloud Vision API", + "ownerName": "Google", + "resources": { + "images": { + "methods": { + "annotate": { + "flatPath": "v1/images:annotate", + "path": "v1/images:annotate", + "id": "vision.images.annotate", + "description": "Run image detection and annotation for a batch of images.", + "request": { + "$ref": "BatchAnnotateImagesRequest" + }, + "response": { + "$ref": "BatchAnnotateImagesResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-vision" + ], + "parameters": {} + } + } + } + }, + "parameters": { + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "$.xgafv": { + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ] + }, + "callback": { + "type": "string", + "location": "query", + "description": "JSONP" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + }, + "access_token": { + "location": "query", + "description": "OAuth access token.", + "type": "string" + }, + "key": { + "location": "query", + "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.", + "type": "string" + }, + "quotaUser": { + "type": "string", + "location": "query", + "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." + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "type": "string", + "location": "query", + "description": "OAuth 2.0 token for the current user." + }, + "bearer_token": { + "type": "string", + "location": "query", + "description": "OAuth bearer token." + } + } }
diff --git a/vision/v1p1beta1/vision-api.json b/vision/v1p1beta1/vision-api.json index 6040cc7..786ab4b 100644 --- a/vision/v1p1beta1/vision-api.json +++ b/vision/v1p1beta1/vision-api.json
@@ -1,109 +1,177 @@ { - "revision": "20180103", - "documentationLink": "https://cloud.google.com/vision/", + "canonicalName": "Vision", + "auth": { + "oauth2": { + "scopes": { + "https://www.googleapis.com/auth/cloud-vision": { + "description": "Apply machine learning models to understand and label images" + }, + "https://www.googleapis.com/auth/cloud-platform": { + "description": "View and manage your data across Google Cloud Platform services" + } + } + } + }, + "rootUrl": "https://vision.googleapis.com/", + "ownerDomain": "google.com", + "name": "vision", + "batchPath": "batch", + "fullyEncodeReservedExpansion": true, + "title": "Google Cloud Vision API", + "ownerName": "Google", + "resources": { + "images": { + "methods": { + "annotate": { + "path": "v1p1beta1/images:annotate", + "id": "vision.images.annotate", + "description": "Run image detection and annotation for a batch of images.", + "request": { + "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest" + }, + "response": { + "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse" + }, + "parameterOrder": [], + "httpMethod": "POST", + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform", + "https://www.googleapis.com/auth/cloud-vision" + ], + "parameters": {}, + "flatPath": "v1p1beta1/images:annotate" + } + } + } + }, + "parameters": { + "access_token": { + "location": "query", + "description": "OAuth access token.", + "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.", + "type": "string", + "location": "query" + }, + "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.", + "type": "string", + "location": "query" + }, + "pp": { + "location": "query", + "description": "Pretty-print response.", + "type": "boolean", + "default": "true" + }, + "oauth_token": { + "description": "OAuth 2.0 token for the current user.", + "type": "string", + "location": "query" + }, + "bearer_token": { + "description": "OAuth bearer token.", + "type": "string", + "location": "query" + }, + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, + "fields": { + "location": "query", + "description": "Selector specifying which fields to include in a partial response.", + "type": "string" + }, + "uploadType": { + "location": "query", + "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", + "type": "string" + }, + "$.xgafv": { + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query", + "enum": [ + "1", + "2" + ], + "description": "V1 error format.", + "type": "string" + }, + "callback": { + "location": "query", + "description": "JSONP", + "type": "string" + }, + "alt": { + "enum": [ + "json", + "media", + "proto" + ], + "type": "string", + "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", + "description": "Data format for response.", + "default": "json" + } + }, + "version": "v1p1beta1", + "baseUrl": "https://vision.googleapis.com/", + "servicePath": "", + "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", + "kind": "discovery#restDescription", + "basePath": "", "id": "vision:v1p1beta1", + "documentationLink": "https://cloud.google.com/vision/", + "revision": "20180103", "discoveryVersion": "v1", "version_module": true, "schemas": { - "GoogleCloudVisionV1p1beta1Vertex": { - "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", - "type": "object", + "GoogleCloudVisionV1p1beta1CropHint": { "properties": { - "x": { - "description": "X coordinate.", - "format": "int32", - "type": "integer" - }, - "y": { - "description": "Y coordinate.", - "format": "int32", - "type": "integer" - } - }, - "id": "GoogleCloudVisionV1p1beta1Vertex" - }, - "GoogleCloudVisionV1p1beta1LatLongRect": { - "description": "Rectangle determined by min and max `LatLng` pairs.", - "type": "object", - "properties": { - "minLatLng": { - "$ref": "LatLng", - "description": "Min lat/long pair." - }, - "maxLatLng": { - "$ref": "LatLng", - "description": "Max lat/long pair." - } - }, - "id": "GoogleCloudVisionV1p1beta1LatLongRect" - }, - "GoogleCloudVisionV1p1beta1DominantColorsAnnotation": { - "description": "Set of dominant colors and their corresponding scores.", - "type": "object", - "properties": { - "colors": { - "description": "RGB color values with their score and pixel fraction.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1ColorInfo" - } - } - }, - "id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation" - }, - "GoogleCloudVisionV1p1beta1WebDetectionWebPage": { - "description": "Metadata for web pages.", - "type": "object", - "properties": { - "score": { - "description": "(Deprecated) Overall relevancy score for the web page.", + "confidence": { + "description": "Confidence of this being a salient region. Range [0, 1].", "format": "float", "type": "number" }, - "partialMatchingImages": { - "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" - } + "importanceFraction": { + "description": "Fraction of importance of this salient region with respect to the original\nimage.", + "format": "float", + "type": "number" }, - "url": { - "description": "The result web page URL.", - "type": "string" - }, - "pageTitle": { - "description": "Title for the web page, may contain HTML markups.", - "type": "string" - }, - "fullMatchingImages": { - "description": "Fully matching images on the page.\nCan include resized copies of the query image.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" - } + "boundingPoly": { + "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`.", + "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" } }, - "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage" + "id": "GoogleCloudVisionV1p1beta1CropHint", + "description": "Single crop hint that is used to generate a new crop when serving an image.", + "type": "object" }, "GoogleCloudVisionV1p1beta1Feature": { - "id": "GoogleCloudVisionV1p1beta1Feature", - "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", - "type": "object", "properties": { + "model": { + "description": "Model to use for the feature.\nSupported values: \"builtin/stable\" (the default if unset) and\n\"builtin/latest\".", + "type": "string" + }, "type": { - "enumDescriptions": [ - "Unspecified feature type.", - "Run face detection.", - "Run landmark detection.", - "Run logo detection.", - "Run label detection.", - "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", - "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", - "Run Safe Search to detect potentially unsafe\nor undesirable content.", - "Compute a set of image properties, such as the\nimage's dominant colors.", - "Run crop hints.", - "Run web detection." - ], "enum": [ "TYPE_UNSPECIFIED", "FACE_DETECTION", @@ -118,43 +186,32 @@ "WEB_DETECTION" ], "description": "The feature type.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unspecified feature type.", + "Run face detection.", + "Run landmark detection.", + "Run logo detection.", + "Run label detection.", + "Run text detection / optical character recognition (OCR). Text detection\nis optimized for areas of text within a larger image; if the image is\na document, use `DOCUMENT_TEXT_DETECTION` instead.", + "Run dense text document OCR. Takes precedence when both\n`DOCUMENT_TEXT_DETECTION` and `TEXT_DETECTION` are present.", + "Run Safe Search to detect potentially unsafe\nor undesirable content.", + "Compute a set of image properties, such as the\nimage's dominant colors.", + "Run crop hints.", + "Run web detection." + ] }, "maxResults": { "description": "Maximum number of results of this type. Does not apply to\n`TEXT_DETECTION`, `DOCUMENT_TEXT_DETECTION`, or `CROP_HINTS`.", "format": "int32", "type": "integer" - }, - "model": { - "description": "Model to use for the feature.\nSupported values: \"builtin/stable\" (the default if unset) and\n\"builtin/latest\".", - "type": "string" - } - } - }, - "GoogleCloudVisionV1p1beta1CropHint": { - "description": "Single crop hint that is used to generate a new crop when serving an image.", - "type": "object", - "properties": { - "boundingPoly": { - "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon for the crop region. The coordinates of the bounding\nbox are in the original image's scale, as returned in `ImageParams`." - }, - "confidence": { - "description": "Confidence of this being a salient region. Range [0, 1].", - "format": "float", - "type": "number" - }, - "importanceFraction": { - "description": "Fraction of importance of this salient region with respect to the original\nimage.", - "format": "float", - "type": "number" } }, - "id": "GoogleCloudVisionV1p1beta1CropHint" + "id": "GoogleCloudVisionV1p1beta1Feature", + "description": "The type of Google Cloud Vision API detection to perform, and the maximum\nnumber of results to return for that type. Multiple `Feature` objects can\nbe specified in the `features` list.", + "type": "object" }, "LatLng": { - "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", - "type": "object", "properties": { "latitude": { "description": "The latitude in degrees. It must be in the range [-90.0, +90.0].", @@ -167,10 +224,11 @@ "type": "number" } }, - "id": "LatLng" + "id": "LatLng", + "description": "An object representing a latitude/longitude pair. This is expressed as a pair\nof doubles representing degrees latitude and degrees longitude. Unless\nspecified otherwise, this must conform to the\n\u003ca href=\"http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf\"\u003eWGS84\nstandard\u003c/a\u003e. Values must be within normalized ranges.", + "type": "object" }, "GoogleCloudVisionV1p1beta1Position": { - "id": "GoogleCloudVisionV1p1beta1Position", "description": "A 3D position in the image, used primarily for Face detection landmarks.\nA valid Position must have both x and y coordinates.\nThe position coordinates are in the same scale as the original image.", "type": "object", "properties": { @@ -189,12 +247,10 @@ "format": "float", "type": "number" } - } + }, + "id": "GoogleCloudVisionV1p1beta1Position" }, "Color": { - "id": "Color", - "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", - "type": "object", "properties": { "red": { "description": "The amount of red in the color as a value in the interval [0, 1].", @@ -216,7 +272,10 @@ "format": "float", "type": "number" } - } + }, + "id": "Color", + "description": "Represents a color in the RGBA color space. This representation is designed\nfor simplicity of conversion to/from color representations in various\nlanguages over compactness; for example, the fields of this representation\ncan be trivially provided to the constructor of \"java.awt.Color\" in Java; it\ncan also be trivially provided to UIColor's \"+colorWithRed:green:blue:alpha\"\nmethod in iOS; and, with just a little work, it can be easily formatted into\na CSS \"rgba()\" string in JavaScript, as well. Here are some examples:\n\nExample (Java):\n\n import com.google.type.Color;\n\n // ...\n public static java.awt.Color fromProto(Color protocolor) {\n float alpha = protocolor.hasAlpha()\n ? protocolor.getAlpha().getValue()\n : 1.0;\n\n return new java.awt.Color(\n protocolor.getRed(),\n protocolor.getGreen(),\n protocolor.getBlue(),\n alpha);\n }\n\n public static Color toProto(java.awt.Color color) {\n float red = (float) color.getRed();\n float green = (float) color.getGreen();\n float blue = (float) color.getBlue();\n float denominator = 255.0;\n Color.Builder resultBuilder =\n Color\n .newBuilder()\n .setRed(red / denominator)\n .setGreen(green / denominator)\n .setBlue(blue / denominator);\n int alpha = color.getAlpha();\n if (alpha != 255) {\n result.setAlpha(\n FloatValue\n .newBuilder()\n .setValue(((float) alpha) / denominator)\n .build());\n }\n return resultBuilder.build();\n }\n // ...\n\nExample (iOS / Obj-C):\n\n // ...\n static UIColor* fromProto(Color* protocolor) {\n float red = [protocolor red];\n float green = [protocolor green];\n float blue = [protocolor blue];\n FloatValue* alpha_wrapper = [protocolor alpha];\n float alpha = 1.0;\n if (alpha_wrapper != nil) {\n alpha = [alpha_wrapper value];\n }\n return [UIColor colorWithRed:red green:green blue:blue alpha:alpha];\n }\n\n static Color* toProto(UIColor* color) {\n CGFloat red, green, blue, alpha;\n if (![color getRed:&red green:&green blue:&blue alpha:&alpha]) {\n return nil;\n }\n Color* result = [Color alloc] init];\n [result setRed:red];\n [result setGreen:green];\n [result setBlue:blue];\n if (alpha \u003c= 0.9999) {\n [result setAlpha:floatWrapperWithValue(alpha)];\n }\n [result autorelease];\n return result;\n }\n // ...\n\n Example (JavaScript):\n\n // ...\n\n var protoToCssColor = function(rgb_color) {\n var redFrac = rgb_color.red || 0.0;\n var greenFrac = rgb_color.green || 0.0;\n var blueFrac = rgb_color.blue || 0.0;\n var red = Math.floor(redFrac * 255);\n var green = Math.floor(greenFrac * 255);\n var blue = Math.floor(blueFrac * 255);\n\n if (!('alpha' in rgb_color)) {\n return rgbToCssColor_(red, green, blue);\n }\n\n var alphaFrac = rgb_color.alpha.value || 0.0;\n var rgbParams = [red, green, blue].join(',');\n return ['rgba(', rgbParams, ',', alphaFrac, ')'].join('');\n };\n\n var rgbToCssColor_ = function(red, green, blue) {\n var rgbNumber = new Number((red \u003c\u003c 16) | (green \u003c\u003c 8) | blue);\n var hexString = rgbNumber.toString(16);\n var missingZeros = 6 - hexString.length;\n var resultBuilder = ['#'];\n for (var i = 0; i \u003c missingZeros; i++) {\n resultBuilder.push('0');\n }\n resultBuilder.push(hexString);\n return resultBuilder.join('');\n };\n\n // ...", + "type": "object" }, "GoogleCloudVisionV1p1beta1CropHintsAnnotation": { "description": "Set of crop hints that are used to generate new crops when serving images.", @@ -233,14 +292,7 @@ "id": "GoogleCloudVisionV1p1beta1CropHintsAnnotation" }, "GoogleCloudVisionV1p1beta1Property": { - "id": "GoogleCloudVisionV1p1beta1Property", - "description": "A `Property` consists of a user-supplied name/value pair.", - "type": "object", "properties": { - "name": { - "description": "Name of the property.", - "type": "string" - }, "value": { "description": "Value of the property.", "type": "string" @@ -249,13 +301,26 @@ "description": "Value of numeric properties.", "format": "uint64", "type": "string" + }, + "name": { + "description": "Name of the property.", + "type": "string" } - } + }, + "id": "GoogleCloudVisionV1p1beta1Property", + "description": "A `Property` consists of a user-supplied name/value pair.", + "type": "object" }, "GoogleCloudVisionV1p1beta1ImageContext": { - "description": "Image context and/or feature-specific parameters.", - "type": "object", "properties": { + "latLongRect": { + "$ref": "GoogleCloudVisionV1p1beta1LatLongRect", + "description": "lat/long rectangle that specifies the location of the image." + }, + "cropHintsParams": { + "description": "Parameters for crop hints annotation request.", + "$ref": "GoogleCloudVisionV1p1beta1CropHintsParams" + }, "languageHints": { "description": "List of languages to use for TEXT_DETECTION. In most cases, an empty value\nyields the best results since it enables automatic language detection. For\nlanguages based on the Latin alphabet, setting `language_hints` is not\nneeded. In rare cases, when the language of the text in the image is known,\nsetting a hint will help get better results (although it will be a\nsignificant hindrance if the hint is wrong). Text detection returns an\nerror if one or more of the specified languages is not one of the\n[supported languages](/vision/docs/languages).", "type": "array", @@ -266,21 +331,13 @@ "webDetectionParams": { "description": "Parameters for web detection.", "$ref": "GoogleCloudVisionV1p1beta1WebDetectionParams" - }, - "latLongRect": { - "description": "lat/long rectangle that specifies the location of the image.", - "$ref": "GoogleCloudVisionV1p1beta1LatLongRect" - }, - "cropHintsParams": { - "description": "Parameters for crop hints annotation request.", - "$ref": "GoogleCloudVisionV1p1beta1CropHintsParams" } }, - "id": "GoogleCloudVisionV1p1beta1ImageContext" + "id": "GoogleCloudVisionV1p1beta1ImageContext", + "description": "Image context and/or feature-specific parameters.", + "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetectionWebImage": { - "description": "Metadata for online images.", - "type": "object", "properties": { "url": { "description": "The result image URL.", @@ -292,11 +349,11 @@ "type": "number" } }, - "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" + "id": "GoogleCloudVisionV1p1beta1WebDetectionWebImage", + "description": "Metadata for online images.", + "type": "object" }, "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse": { - "description": "Response to a batch image annotation request.", - "type": "object", "properties": { "responses": { "description": "Individual responses to image annotation requests within the batch.", @@ -306,12 +363,11 @@ } } }, - "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse" + "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse", + "description": "Response to a batch image annotation request.", + "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetectionWebLabel": { - "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel", - "description": "Label to provide extra metadata for the web detection.", - "type": "object", "properties": { "label": { "description": "Label for extra metadata.", @@ -321,10 +377,12 @@ "description": "The BCP-47 language code for `label`, such as \"en-US\" or \"sr-Latn\".\nFor more information, see\nhttp://www.unicode.org/reports/tr35/#Unicode_locale_identifier.", "type": "string" } - } + }, + "id": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel", + "description": "Label to provide extra metadata for the web detection.", + "type": "object" }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage": { - "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage", "description": "Detected language for a structural component.", "type": "object", "properties": { @@ -337,15 +395,16 @@ "format": "float", "type": "number" } - } + }, + "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedLanguage" }, "GoogleCloudVisionV1p1beta1Symbol": { "description": "A single symbol representation.", "type": "object", "properties": { "property": { - "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", - "description": "Additional information detected for the symbol." + "description": "Additional information detected for the symbol.", + "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" }, "boundingBox": { "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", @@ -364,19 +423,17 @@ "id": "GoogleCloudVisionV1p1beta1Symbol" }, "GoogleCloudVisionV1p1beta1ImageProperties": { - "description": "Stores image properties, such as dominant colors.", - "type": "object", "properties": { "dominantColors": { - "description": "If present, dominant colors completed successfully.", - "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation" + "$ref": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation", + "description": "If present, dominant colors completed successfully." } }, - "id": "GoogleCloudVisionV1p1beta1ImageProperties" + "id": "GoogleCloudVisionV1p1beta1ImageProperties", + "description": "Stores image properties, such as dominant colors.", + "type": "object" }, "GoogleCloudVisionV1p1beta1Image": { - "description": "Client image to perform Google Cloud Vision API tasks over.", - "type": "object", "properties": { "content": { "description": "Image content, represented as a stream of bytes.\nNote: As with all `bytes` fields, protobuffers use a pure binary\nrepresentation, whereas JSON representations use base64.", @@ -388,7 +445,9 @@ "description": "Google Cloud Storage image location, or publicly-accessible image\nURL. If both `content` and `source` are provided for an image, `content`\ntakes precedence and is used to perform the image annotation request." } }, - "id": "GoogleCloudVisionV1p1beta1Image" + "id": "GoogleCloudVisionV1p1beta1Image", + "description": "Client image to perform Google Cloud Vision API tasks over.", + "type": "object" }, "GoogleCloudVisionV1p1beta1WebDetectionWebEntity": { "description": "Entity deduced from similar images on the Internet.", @@ -432,7 +491,6 @@ "id": "GoogleCloudVisionV1p1beta1ColorInfo" }, "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark": { - "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark", "description": "A face-specific landmark (for example, a face feature).", "type": "object", "properties": { @@ -515,15 +573,21 @@ "type": "string" }, "position": { - "description": "Face landmark position.", - "$ref": "GoogleCloudVisionV1p1beta1Position" + "$ref": "GoogleCloudVisionV1p1beta1Position", + "description": "Face landmark position." } - } + }, + "id": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark" }, "GoogleCloudVisionV1p1beta1WebDetection": { - "description": "Relevant information for the image from the Internet.", - "type": "object", "properties": { + "fullMatchingImages": { + "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" + } + }, "webEntities": { "description": "Deduced entities from similar images on the Internet.", "type": "array", @@ -558,20 +622,13 @@ "items": { "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebLabel" } - }, - "fullMatchingImages": { - "description": "Fully matching images from the Internet.\nCan include resized copies of the query image.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" - } } }, - "id": "GoogleCloudVisionV1p1beta1WebDetection" + "id": "GoogleCloudVisionV1p1beta1WebDetection", + "description": "Relevant information for the image from the Internet.", + "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateImageResponse": { - "description": "Response to an image annotation request.", - "type": "object", "properties": { "landmarkAnnotations": { "description": "If present, landmark detection has completed successfully.", @@ -587,10 +644,6 @@ "$ref": "GoogleCloudVisionV1p1beta1EntityAnnotation" } }, - "imagePropertiesAnnotation": { - "$ref": "GoogleCloudVisionV1p1beta1ImageProperties", - "description": "If present, image properties were extracted successfully." - }, "faceAnnotations": { "description": "If present, face detection has completed successfully.", "type": "array", @@ -598,6 +651,10 @@ "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotation" } }, + "imagePropertiesAnnotation": { + "$ref": "GoogleCloudVisionV1p1beta1ImageProperties", + "description": "If present, image properties were extracted successfully." + }, "logoAnnotations": { "description": "If present, logo detection has completed successfully.", "type": "array", @@ -606,12 +663,12 @@ } }, "cropHintsAnnotation": { - "description": "If present, crop hints have completed successfully.", - "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation" + "$ref": "GoogleCloudVisionV1p1beta1CropHintsAnnotation", + "description": "If present, crop hints have completed successfully." }, "webDetection": { - "description": "If present, web detection has completed successfully.", - "$ref": "GoogleCloudVisionV1p1beta1WebDetection" + "$ref": "GoogleCloudVisionV1p1beta1WebDetection", + "description": "If present, web detection has completed successfully." }, "labelAnnotations": { "description": "If present, label detection has completed successfully.", @@ -621,33 +678,90 @@ } }, "safeSearchAnnotation": { - "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", - "description": "If present, safe-search annotation has completed successfully." + "description": "If present, safe-search annotation has completed successfully.", + "$ref": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation" }, "error": { - "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set.", - "$ref": "Status" + "$ref": "Status", + "description": "If set, represents the error message for the operation.\nNote that filled-in image annotations are guaranteed to be\ncorrect, even when `error` is set." }, "fullTextAnnotation": { "$ref": "GoogleCloudVisionV1p1beta1TextAnnotation", "description": "If present, text (OCR) detection or document (OCR) text detection has\ncompleted successfully.\nThis annotation provides the structural hierarchy for the OCR detected\ntext." } }, - "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse" + "id": "GoogleCloudVisionV1p1beta1AnnotateImageResponse", + "description": "Response to an image annotation request.", + "type": "object" }, "GoogleCloudVisionV1p1beta1FaceAnnotation": { - "id": "GoogleCloudVisionV1p1beta1FaceAnnotation", "description": "A face annotation object contains the results of face detection.", "type": "object", "properties": { + "boundingPoly": { + "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated.", + "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" + }, + "rollAngle": { + "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", + "format": "float", + "type": "number" + }, + "sorrowLikelihood": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Sorrow likelihood.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] + }, "tiltAngle": { "description": "Pitch angle, which indicates the upwards/downwards angle that the face is\npointing relative to the image's horizontal plane. Range [-180,180].", "format": "float", "type": "number" }, "fdBoundingPoly": { - "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix." + "description": "The `fd_bounding_poly` bounding polygon is tighter than the\n`boundingPoly`, and encloses only the skin part of the face. Typically, it\nis used to eliminate the face from any image analysis that detects the\n\"amount of skin\" visible in an image. It is not based on the\nlandmarker results, only on the initial face detection, hence\nthe \u003ccode\u003efd\u003c/code\u003e (face detection) prefix.", + "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" + }, + "angerLikelihood": { + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ], + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Anger likelihood.", + "type": "string" + }, + "landmarks": { + "description": "Detected face landmarks.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark" + } }, "surpriseLikelihood": { "enumDescriptions": [ @@ -669,42 +783,12 @@ "description": "Surprise likelihood.", "type": "string" }, - "landmarks": { - "description": "Detected face landmarks.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1FaceAnnotationLandmark" - } - }, - "angerLikelihood": { - "description": "Anger likelihood.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ] + "landmarkingConfidence": { + "description": "Face landmarking confidence. Range [0, 1].", + "format": "float", + "type": "number" }, "joyLikelihood": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -714,26 +798,17 @@ "VERY_LIKELY" ], "description": "Joy likelihood.", - "type": "string" - }, - "landmarkingConfidence": { - "description": "Face landmarking confidence. Range [0, 1].", - "format": "float", - "type": "number" - }, - "detectionConfidence": { - "description": "Detection confidence. Range [0, 1].", - "format": "float", - "type": "number" - }, - "panAngle": { - "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", - "format": "float", - "type": "number" + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] }, "underExposedLikelihood": { - "description": "Under-exposed likelihood.", - "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely that the image belongs to the specified vertical.", @@ -749,9 +824,29 @@ "POSSIBLE", "LIKELY", "VERY_LIKELY" - ] + ], + "description": "Under-exposed likelihood.", + "type": "string" + }, + "panAngle": { + "description": "Yaw angle, which indicates the leftward/rightward angle that the face is\npointing relative to the vertical plane perpendicular to the image. Range\n[-180,180].", + "format": "float", + "type": "number" + }, + "detectionConfidence": { + "description": "Detection confidence. Range [0, 1].", + "format": "float", + "type": "number" }, "blurredLikelihood": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], "description": "Blurred likelihood.", "type": "string", "enumDescriptions": [ @@ -761,7 +856,9 @@ "It is possible that the image belongs to the specified vertical.", "It is likely that the image belongs to the specified vertical.", "It is very likely that the image belongs to the specified vertical." - ], + ] + }, + "headwearLikelihood": { "enum": [ "UNKNOWN", "VERY_UNLIKELY", @@ -769,9 +866,7 @@ "POSSIBLE", "LIKELY", "VERY_LIKELY" - ] - }, - "headwearLikelihood": { + ], "description": "Headwear likelihood.", "type": "string", "enumDescriptions": [ @@ -781,95 +876,16 @@ "It is possible that the image belongs to the specified vertical.", "It is likely that the image belongs to the specified vertical.", "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ] - }, - "boundingPoly": { - "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding polygon around the face. The coordinates of the bounding box\nare in the original image's scale, as returned in `ImageParams`.\nThe bounding box is computed to \"frame\" the face in accordance with human\nexpectations. It is based on the landmarker results.\nNote that one or more x and/or y coordinates may not be generated in the\n`BoundingPoly` (the polygon will be unbounded) if only a partial face\nappears in the image to be annotated." - }, - "rollAngle": { - "description": "Roll angle, which indicates the amount of clockwise/anti-clockwise rotation\nof the face relative to the image vertical about the axis perpendicular to\nthe face. Range [-180,180].", - "format": "float", - "type": "number" - }, - "sorrowLikelihood": { - "description": "Sorrow likelihood.", - "type": "string", - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" ] } - } + }, + "id": "GoogleCloudVisionV1p1beta1FaceAnnotation" }, "GoogleCloudVisionV1p1beta1SafeSearchAnnotation": { - "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation", "description": "Set of features pertaining to the image, computed by computer vision\nmethods over safe-search verticals (for example, adult, spoof, medical,\nviolence).", "type": "object", "properties": { - "violence": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Likelihood that this image contains violent content.", - "type": "string" - }, - "adult": { - "enumDescriptions": [ - "Unknown likelihood.", - "It is very unlikely that the image belongs to the specified vertical.", - "It is unlikely that the image belongs to the specified vertical.", - "It is possible that the image belongs to the specified vertical.", - "It is likely that the image belongs to the specified vertical.", - "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" - ], - "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", - "type": "string" - }, "spoof": { - "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", - "type": "string", "enumDescriptions": [ "Unknown likelihood.", "It is very unlikely that the image belongs to the specified vertical.", @@ -885,9 +901,19 @@ "POSSIBLE", "LIKELY", "VERY_LIKELY" - ] + ], + "description": "Spoof likelihood. The likelihood that an modification\nwas made to the image's canonical version to make it appear\nfunny or offensive.", + "type": "string" }, "medical": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], "description": "Likelihood that this is a medical image.", "type": "string", "enumDescriptions": [ @@ -897,14 +923,6 @@ "It is possible that the image belongs to the specified vertical.", "It is likely that the image belongs to the specified vertical.", "It is very likely that the image belongs to the specified vertical." - ], - "enum": [ - "UNKNOWN", - "VERY_UNLIKELY", - "UNLIKELY", - "POSSIBLE", - "LIKELY", - "VERY_LIKELY" ] }, "racy": { @@ -926,13 +944,56 @@ ], "description": "Likelihood that the request image contains racy content. Racy content may\ninclude (but is not limited to) skimpy or sheer clothing, strategically\ncovered nudity, lewd or provocative poses, or close-ups of sensitive\nbody areas.", "type": "string" + }, + "violence": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Likelihood that this image contains violent content.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] + }, + "adult": { + "enum": [ + "UNKNOWN", + "VERY_UNLIKELY", + "UNLIKELY", + "POSSIBLE", + "LIKELY", + "VERY_LIKELY" + ], + "description": "Represents the adult content likelihood for the image. Adult content may\ncontain elements such as nudity, pornographic images or cartoons, or\nsexual activities.", + "type": "string", + "enumDescriptions": [ + "Unknown likelihood.", + "It is very unlikely that the image belongs to the specified vertical.", + "It is unlikely that the image belongs to the specified vertical.", + "It is possible that the image belongs to the specified vertical.", + "It is likely that the image belongs to the specified vertical.", + "It is very likely that the image belongs to the specified vertical." + ] } - } + }, + "id": "GoogleCloudVisionV1p1beta1SafeSearchAnnotation" }, "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak": { - "description": "Detected start or end of a structural component.", - "type": "object", "properties": { + "isPrefix": { + "description": "True if break prepends the element.", + "type": "boolean" + }, "type": { "enumDescriptions": [ "Unknown break label type.", @@ -952,13 +1013,11 @@ ], "description": "Detected break type.", "type": "string" - }, - "isPrefix": { - "description": "True if break prepends the element.", - "type": "boolean" } }, - "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak" + "id": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak", + "description": "Detected start or end of a structural component.", + "type": "object" }, "GoogleCloudVisionV1p1beta1AnnotateImageRequest": { "description": "Request for performing Google Cloud Vision API tasks over a user-provided\nimage, with user-requested features.", @@ -982,6 +1041,39 @@ }, "id": "GoogleCloudVisionV1p1beta1AnnotateImageRequest" }, + "GoogleCloudVisionV1p1beta1Page": { + "properties": { + "width": { + "description": "Page width in pixels.", + "format": "int32", + "type": "integer" + }, + "blocks": { + "description": "List of blocks of text, images etc on this page.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1Block" + } + }, + "property": { + "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", + "description": "Additional information detected on the page." + }, + "confidence": { + "description": "Confidence of the OCR results on the page. Range [0, 1].", + "format": "float", + "type": "number" + }, + "height": { + "description": "Page height in pixels.", + "format": "int32", + "type": "integer" + } + }, + "id": "GoogleCloudVisionV1p1beta1Page", + "description": "Detected page from OCR.", + "type": "object" + }, "GoogleCloudVisionV1p1beta1Block": { "description": "Logical element on the page.", "type": "object", @@ -991,14 +1083,6 @@ "description": "Additional information detected for the block." }, "blockType": { - "enumDescriptions": [ - "Unknown block type.", - "Regular text block.", - "Table block.", - "Image block.", - "Horizontal/vertical line box.", - "Barcode block." - ], "enum": [ "UNKNOWN", "TEXT", @@ -1008,7 +1092,15 @@ "BARCODE" ], "description": "Detected block type (text, image etc) for this block.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "Unknown block type.", + "Regular text block.", + "Table block.", + "Image block.", + "Horizontal/vertical line box.", + "Barcode block." + ] }, "boundingBox": { "description": "The bounding box for the block.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n\n* when the text is horizontal it might look like:\n\n 0----1\n | |\n 3----2\n\n* when it's rotated 180 degrees around the top-left corner it becomes:\n\n 2----3\n | |\n 1----0\n\n and the vertice order will still be (0, 1, 2, 3).", @@ -1029,94 +1121,53 @@ }, "id": "GoogleCloudVisionV1p1beta1Block" }, - "GoogleCloudVisionV1p1beta1Page": { - "id": "GoogleCloudVisionV1p1beta1Page", - "description": "Detected page from OCR.", - "type": "object", + "GoogleCloudVisionV1p1beta1Paragraph": { "properties": { - "blocks": { - "description": "List of blocks of text, images etc on this page.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1Block" - } - }, "property": { - "description": "Additional information detected on the page.", - "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" + "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", + "description": "Additional information detected for the paragraph." + }, + "boundingBox": { + "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).", + "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" }, "confidence": { - "description": "Confidence of the OCR results on the page. Range [0, 1].", + "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", "format": "float", "type": "number" }, - "height": { - "description": "Page height in pixels.", - "format": "int32", - "type": "integer" - }, - "width": { - "description": "Page width in pixels.", - "format": "int32", - "type": "integer" - } - } - }, - "GoogleCloudVisionV1p1beta1Paragraph": { - "id": "GoogleCloudVisionV1p1beta1Paragraph", - "description": "Structural unit of text representing a number of words in certain order.", - "type": "object", - "properties": { "words": { "description": "List of words in this paragraph.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Word" } - }, - "property": { - "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", - "description": "Additional information detected for the paragraph." - }, - "boundingBox": { - "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the paragraph.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." - }, - "confidence": { - "description": "Confidence of the OCR results for the paragraph. Range [0, 1].", - "format": "float", - "type": "number" } - } + }, + "id": "GoogleCloudVisionV1p1beta1Paragraph", + "description": "Structural unit of text representing a number of words in certain order.", + "type": "object" }, - "GoogleCloudVisionV1p1beta1EntityAnnotation": { - "description": "Set of detected entity features.", + "GoogleCloudVisionV1p1beta1TextAnnotation": { + "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", "type": "object", "properties": { - "locale": { - "description": "The language code for the locale in which the entity textual\n`description` is expressed.", - "type": "string" - }, - "boundingPoly": { - "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features." - }, - "description": { - "description": "Entity textual description, expressed in its `locale` language.", - "type": "string" - }, - "topicality": { - "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", - "format": "float", - "type": "number" - }, - "properties": { - "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", + "pages": { + "description": "List of pages detected by OCR.", "type": "array", "items": { - "$ref": "GoogleCloudVisionV1p1beta1Property" + "$ref": "GoogleCloudVisionV1p1beta1Page" } }, + "text": { + "description": "UTF-8 text detected on the pages.", + "type": "string" + } + }, + "id": "GoogleCloudVisionV1p1beta1TextAnnotation" + }, + "GoogleCloudVisionV1p1beta1EntityAnnotation": { + "properties": { "score": { "description": "Overall score of the result. Range [0, 1].", "format": "float", @@ -1137,27 +1188,35 @@ "description": "**Deprecated. Use `score` instead.**\nThe accuracy of the entity detection in an image.\nFor example, for an image in which the \"Eiffel Tower\" entity is detected,\nthis field represents the confidence that there is a tower in the query\nimage. Range [0, 1].", "format": "float", "type": "number" - } - }, - "id": "GoogleCloudVisionV1p1beta1EntityAnnotation" - }, - "GoogleCloudVisionV1p1beta1TextAnnotation": { - "id": "GoogleCloudVisionV1p1beta1TextAnnotation", - "description": "TextAnnotation contains a structured representation of OCR extracted text.\nThe hierarchy of an OCR extracted text structure is like this:\n TextAnnotation -\u003e Page -\u003e Block -\u003e Paragraph -\u003e Word -\u003e Symbol\nEach structural component, starting from Page, may further have their own\nproperties. Properties describe detected languages, breaks etc.. Please refer\nto the TextAnnotation.TextProperty message definition below for more\ndetail.", - "type": "object", - "properties": { - "pages": { - "description": "List of pages detected by OCR.", + }, + "boundingPoly": { + "description": "Image region to which this entity belongs. Not produced\nfor `LABEL_DETECTION` features.", + "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" + }, + "locale": { + "description": "The language code for the locale in which the entity textual\n`description` is expressed.", + "type": "string" + }, + "topicality": { + "description": "The relevancy of the ICA (Image Content Annotation) label to the\nimage. For example, the relevancy of \"tower\" is likely higher to an image\ncontaining the detected \"Eiffel Tower\" than to an image containing a\ndetected distant towering building, even though the confidence that\nthere is a tower in each image may be the same. Range [0, 1].", + "format": "float", + "type": "number" + }, + "description": { + "description": "Entity textual description, expressed in its `locale` language.", + "type": "string" + }, + "properties": { + "description": "Some entities may have optional user-supplied `Property` (name/value)\nfields, such a score or string that qualifies the entity.", "type": "array", "items": { - "$ref": "GoogleCloudVisionV1p1beta1Page" + "$ref": "GoogleCloudVisionV1p1beta1Property" } - }, - "text": { - "description": "UTF-8 text detected on the pages.", - "type": "string" } - } + }, + "id": "GoogleCloudVisionV1p1beta1EntityAnnotation", + "description": "Set of detected entity features.", + "type": "object" }, "GoogleCloudVisionV1p1beta1BoundingPoly": { "description": "A bounding polygon for the detected image annotation.", @@ -1173,44 +1232,7 @@ }, "id": "GoogleCloudVisionV1p1beta1BoundingPoly" }, - "GoogleCloudVisionV1p1beta1WebDetectionParams": { - "description": "Parameters for web detection request.", - "type": "object", - "properties": { - "includeGeoResults": { - "description": "Whether to include results derived from the geo information in the image.", - "type": "boolean" - } - }, - "id": "GoogleCloudVisionV1p1beta1WebDetectionParams" - }, - "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest": { - "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest", - "description": "Multiple image annotation requests are batched into a single service call.", - "type": "object", - "properties": { - "requests": { - "description": "Individual image annotation requests for this batch.", - "type": "array", - "items": { - "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageRequest" - } - } - } - }, - "GoogleCloudVisionV1p1beta1LocationInfo": { - "id": "GoogleCloudVisionV1p1beta1LocationInfo", - "description": "Detected entity location information.", - "type": "object", - "properties": { - "latLng": { - "description": "lat/long location coordinates.", - "$ref": "LatLng" - } - } - }, "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty": { - "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", "description": "Additional information detected on the structural component.", "type": "object", "properties": { @@ -1222,14 +1244,49 @@ } }, "detectedBreak": { - "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak", - "description": "Detected start or end of a text segment." + "description": "Detected start or end of a text segment.", + "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationDetectedBreak" } - } + }, + "id": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" + }, + "GoogleCloudVisionV1p1beta1LocationInfo": { + "properties": { + "latLng": { + "description": "lat/long location coordinates.", + "$ref": "LatLng" + } + }, + "id": "GoogleCloudVisionV1p1beta1LocationInfo", + "description": "Detected entity location information.", + "type": "object" + }, + "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest": { + "properties": { + "requests": { + "description": "Individual image annotation requests for this batch.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1AnnotateImageRequest" + } + } + }, + "id": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest", + "description": "Multiple image annotation requests are batched into a single service call.", + "type": "object" + }, + "GoogleCloudVisionV1p1beta1WebDetectionParams": { + "properties": { + "includeGeoResults": { + "description": "Whether to include results derived from the geo information in the image.", + "type": "boolean" + } + }, + "id": "GoogleCloudVisionV1p1beta1WebDetectionParams", + "description": "Parameters for web detection request.", + "type": "object" }, "GoogleCloudVisionV1p1beta1ImageSource": { - "description": "External image source (Google Cloud Storage or web URL image location).", - "type": "object", "properties": { "gcsImageUri": { "description": "**Use `image_uri` instead.**\n\nThe Google Cloud Storage URI of the form\n`gs://bucket_name/object_name`. Object versioning is not supported. See\n[Google Cloud Storage Request\nURIs](https://cloud.google.com/storage/docs/reference-uris) for more info.", @@ -1240,10 +1297,11 @@ "type": "string" } }, - "id": "GoogleCloudVisionV1p1beta1ImageSource" + "id": "GoogleCloudVisionV1p1beta1ImageSource", + "description": "External image source (Google Cloud Storage or web URL image location).", + "type": "object" }, "GoogleCloudVisionV1p1beta1CropHintsParams": { - "id": "GoogleCloudVisionV1p1beta1CropHintsParams", "description": "Parameters for crop hints annotation request.", "type": "object", "properties": { @@ -1255,37 +1313,37 @@ "type": "number" } } - } + }, + "id": "GoogleCloudVisionV1p1beta1CropHintsParams" }, "GoogleCloudVisionV1p1beta1Word": { - "id": "GoogleCloudVisionV1p1beta1Word", - "description": "A word representation.", - "type": "object", "properties": { + "property": { + "description": "Additional information detected for the word.", + "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty" + }, + "boundingBox": { + "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3).", + "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly" + }, + "confidence": { + "description": "Confidence of the OCR results for the word. Range [0, 1].", + "format": "float", + "type": "number" + }, "symbols": { "description": "List of symbols in the word.\nThe order of the symbols follows the natural reading order.", "type": "array", "items": { "$ref": "GoogleCloudVisionV1p1beta1Symbol" } - }, - "property": { - "$ref": "GoogleCloudVisionV1p1beta1TextAnnotationTextProperty", - "description": "Additional information detected for the word." - }, - "boundingBox": { - "$ref": "GoogleCloudVisionV1p1beta1BoundingPoly", - "description": "The bounding box for the word.\nThe vertices are in the order of top-left, top-right, bottom-right,\nbottom-left. When a rotation of the bounding box is detected the rotation\nis represented as around the top-left corner as defined when the text is\nread in the 'natural' orientation.\nFor example:\n * when the text is horizontal it might look like:\n 0----1\n | |\n 3----2\n * when it's rotated 180 degrees around the top-left corner it becomes:\n 2----3\n | |\n 1----0\n and the vertice order will still be (0, 1, 2, 3)." - }, - "confidence": { - "description": "Confidence of the OCR results for the word. Range [0, 1].", - "format": "float", - "type": "number" } - } + }, + "id": "GoogleCloudVisionV1p1beta1Word", + "description": "A word representation.", + "type": "object" }, "Status": { - "id": "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.", "type": "object", "properties": { @@ -1309,151 +1367,93 @@ "format": "int32", "type": "integer" } - } - } - }, - "protocol": "rest", - "icons": { - "x16": "http://www.google.com/images/icons/product/search-16.gif", - "x32": "http://www.google.com/images/icons/product/search-32.gif" - }, - "canonicalName": "Vision", - "auth": { - "oauth2": { - "scopes": { - "https://www.googleapis.com/auth/cloud-vision": { - "description": "Apply machine learning models to understand and label images" + }, + "id": "Status" + }, + "GoogleCloudVisionV1p1beta1Vertex": { + "properties": { + "y": { + "description": "Y coordinate.", + "format": "int32", + "type": "integer" }, - "https://www.googleapis.com/auth/cloud-platform": { - "description": "View and manage your data across Google Cloud Platform services" + "x": { + "description": "X coordinate.", + "format": "int32", + "type": "integer" } - } - } - }, - "rootUrl": "https://vision.googleapis.com/", - "ownerDomain": "google.com", - "name": "vision", - "batchPath": "batch", - "fullyEncodeReservedExpansion": true, - "title": "Google Cloud Vision API", - "ownerName": "Google", - "resources": { - "images": { - "methods": { - "annotate": { - "httpMethod": "POST", - "parameterOrder": [], - "response": { - "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesResponse" - }, - "parameters": {}, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform", - "https://www.googleapis.com/auth/cloud-vision" - ], - "flatPath": "v1p1beta1/images:annotate", - "id": "vision.images.annotate", - "path": "v1p1beta1/images:annotate", - "request": { - "$ref": "GoogleCloudVisionV1p1beta1BatchAnnotateImagesRequest" - }, - "description": "Run image detection and annotation for a batch of images." + }, + "id": "GoogleCloudVisionV1p1beta1Vertex", + "description": "A vertex represents a 2D point in the image.\nNOTE: the vertex coordinates are in the same scale as the original image.", + "type": "object" + }, + "GoogleCloudVisionV1p1beta1LatLongRect": { + "properties": { + "minLatLng": { + "description": "Min lat/long pair.", + "$ref": "LatLng" + }, + "maxLatLng": { + "description": "Max lat/long pair.", + "$ref": "LatLng" } - } + }, + "id": "GoogleCloudVisionV1p1beta1LatLongRect", + "description": "Rectangle determined by min and max `LatLng` pairs.", + "type": "object" + }, + "GoogleCloudVisionV1p1beta1DominantColorsAnnotation": { + "properties": { + "colors": { + "description": "RGB color values with their score and pixel fraction.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1ColorInfo" + } + } + }, + "id": "GoogleCloudVisionV1p1beta1DominantColorsAnnotation", + "description": "Set of dominant colors and their corresponding scores.", + "type": "object" + }, + "GoogleCloudVisionV1p1beta1WebDetectionWebPage": { + "properties": { + "pageTitle": { + "description": "Title for the web page, may contain HTML markups.", + "type": "string" + }, + "fullMatchingImages": { + "description": "Fully matching images on the page.\nCan include resized copies of the query image.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" + } + }, + "score": { + "description": "(Deprecated) Overall relevancy score for the web page.", + "format": "float", + "type": "number" + }, + "partialMatchingImages": { + "description": "Partial matching images on the page.\nThose images are similar enough to share some key-point features. For\nexample an original image will likely have partial matching for its\ncrops.", + "type": "array", + "items": { + "$ref": "GoogleCloudVisionV1p1beta1WebDetectionWebImage" + } + }, + "url": { + "description": "The result web page URL.", + "type": "string" + } + }, + "id": "GoogleCloudVisionV1p1beta1WebDetectionWebPage", + "description": "Metadata for web pages.", + "type": "object" } }, - "parameters": { - "access_token": { - "location": "query", - "description": "OAuth access token.", - "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.", - "type": "string", - "location": "query" - }, - "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.", - "type": "string", - "location": "query" - }, - "pp": { - "description": "Pretty-print response.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "oauth_token": { - "location": "query", - "description": "OAuth 2.0 token for the current user.", - "type": "string" - }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, - "upload_protocol": { - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", - "type": "string" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" - }, - "fields": { - "description": "Selector specifying which fields to include in a partial response.", - "type": "string", - "location": "query" - }, - "uploadType": { - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string" - }, - "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string" - }, - "callback": { - "location": "query", - "description": "JSONP", - "type": "string" - }, - "alt": { - "description": "Data format for response.", - "default": "json", - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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" - } + "icons": { + "x32": "http://www.google.com/images/icons/product/search-32.gif", + "x16": "http://www.google.com/images/icons/product/search-16.gif" }, - "version": "v1p1beta1", - "baseUrl": "https://vision.googleapis.com/", - "servicePath": "", - "description": "Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications.", - "kind": "discovery#restDescription", - "basePath": "" + "protocol": "rest" }
diff --git a/youtubereporting/v1/youtubereporting-api.json b/youtubereporting/v1/youtubereporting-api.json index 00dba46..1d5c116 100644 --- a/youtubereporting/v1/youtubereporting-api.json +++ b/youtubereporting/v1/youtubereporting-api.json
@@ -1,68 +1,37 @@ { + "rootUrl": "https://youtubereporting.googleapis.com/", "basePath": "", "ownerDomain": "google.com", "name": "youtubereporting", "batchPath": "batch", "id": "youtubereporting:v1", "documentationLink": "https://developers.google.com/youtube/reporting/v1/reports/", - "revision": "20180103", + "revision": "20180106", "title": "YouTube Reporting API", - "discoveryVersion": "v1", "ownerName": "Google", + "discoveryVersion": "v1", "resources": { - "media": { - "methods": { - "download": { - "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.", - "supportsMediaDownload": true, - "httpMethod": "GET", - "parameterOrder": [ - "resourceName" - ], - "response": { - "$ref": "GdataMedia" - }, - "parameters": { - "resourceName": { - "description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.", - "required": true, - "type": "string", - "pattern": "^.+$", - "location": "path" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", - "https://www.googleapis.com/auth/yt-analytics.readonly" - ], - "flatPath": "v1/media/{mediaId}", - "id": "youtubereporting.media.download", - "path": "v1/media/{+resourceName}" - } - } - }, "jobs": { "methods": { "delete": { - "description": "Deletes a job.", - "httpMethod": "DELETE", - "parameterOrder": [ - "jobId" - ], "response": { "$ref": "Empty" }, + "parameterOrder": [ + "jobId" + ], + "httpMethod": "DELETE", "parameters": { + "onBehalfOfContentOwner": { + "location": "query", + "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", + "type": "string" + }, "jobId": { "description": "The ID of the job to delete.", "required": true, "type": "string", "location": "path" - }, - "onBehalfOfContentOwner": { - "location": "query", - "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", - "type": "string" } }, "scopes": [ @@ -70,36 +39,36 @@ "https://www.googleapis.com/auth/yt-analytics.readonly" ], "flatPath": "v1/jobs/{jobId}", + "path": "v1/jobs/{jobId}", "id": "youtubereporting.jobs.delete", - "path": "v1/jobs/{jobId}" + "description": "Deletes a job." }, "list": { - "description": "Lists jobs.", - "httpMethod": "GET", - "parameterOrder": [], "response": { "$ref": "ListJobsResponse" }, + "parameterOrder": [], + "httpMethod": "GET", "parameters": { - "pageSize": { - "description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.", - "format": "int32", - "type": "integer", - "location": "query" - }, "onBehalfOfContentOwner": { "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", "type": "string", "location": "query" }, "pageToken": { - "location": "query", "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListJobs` method.", - "type": "string" + "type": "string", + "location": "query" }, "includeSystemManaged": { + "location": "query", "description": "If set to true, also system-managed jobs will be returned; otherwise only\nuser-created jobs will be returned. System-managed jobs can neither be\nmodified nor deleted.", - "type": "boolean", + "type": "boolean" + }, + "pageSize": { + "description": "Requested page size. Server may return fewer jobs than requested.\nIf unspecified, server will pick an appropriate default.", + "format": "int32", + "type": "integer", "location": "query" } }, @@ -108,8 +77,9 @@ "https://www.googleapis.com/auth/yt-analytics.readonly" ], "flatPath": "v1/jobs", + "path": "v1/jobs", "id": "youtubereporting.jobs.list", - "path": "v1/jobs" + "description": "Lists jobs." }, "get": { "description": "Gets a job.", @@ -126,15 +96,15 @@ ], "parameters": { "jobId": { - "location": "path", "description": "The ID of the job to retrieve.", "required": true, - "type": "string" + "type": "string", + "location": "path" }, "onBehalfOfContentOwner": { - "location": "query", "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", - "type": "string" + "type": "string", + "location": "query" } }, "flatPath": "v1/jobs/{jobId}", @@ -142,18 +112,15 @@ "id": "youtubereporting.jobs.get" }, "create": { - "flatPath": "v1/jobs", - "path": "v1/jobs", - "id": "youtubereporting.jobs.create", "request": { "$ref": "Job" }, "description": "Creates a job and returns it.", + "httpMethod": "POST", + "parameterOrder": [], "response": { "$ref": "Job" }, - "parameterOrder": [], - "httpMethod": "POST", "parameters": { "onBehalfOfContentOwner": { "location": "query", @@ -164,73 +131,75 @@ "scopes": [ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", "https://www.googleapis.com/auth/yt-analytics.readonly" - ] + ], + "flatPath": "v1/jobs", + "id": "youtubereporting.jobs.create", + "path": "v1/jobs" } }, "resources": { "reports": { "methods": { "list": { + "flatPath": "v1/jobs/{jobId}/reports", + "path": "v1/jobs/{jobId}/reports", + "id": "youtubereporting.jobs.reports.list", "description": "Lists reports created by a specific job.\nReturns NOT_FOUND if the job does not exist.", - "httpMethod": "GET", - "parameterOrder": [ - "jobId" - ], "response": { "$ref": "ListReportsResponse" }, + "parameterOrder": [ + "jobId" + ], + "httpMethod": "GET", + "scopes": [ + "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", + "https://www.googleapis.com/auth/yt-analytics.readonly" + ], "parameters": { - "startTimeBefore": { - "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.", - "format": "google-datetime", - "type": "string", - "location": "query" - }, - "jobId": { - "description": "The ID of the job.", - "required": true, - "type": "string", - "location": "path" - }, "createdAfter": { "description": "If set, only reports created after the specified date/time are returned.", "format": "google-datetime", "type": "string", "location": "query" }, - "pageToken": { - "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.", - "type": "string", - "location": "query" - }, "startTimeAtOrAfter": { "location": "query", "description": "If set, only reports whose start time is greater than or equal the\nspecified date/time are returned.", "format": "google-datetime", "type": "string" }, + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportsResponse.next_page_token\nreturned in response to the previous call to the `ListReports` method.", + "type": "string", + "location": "query" + }, "pageSize": { - "location": "query", "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.", "format": "int32", - "type": "integer" + "type": "integer", + "location": "query" }, "onBehalfOfContentOwner": { "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", "type": "string", "location": "query" + }, + "startTimeBefore": { + "location": "query", + "description": "If set, only reports whose start time is smaller than the specified\ndate/time are returned.", + "format": "google-datetime", + "type": "string" + }, + "jobId": { + "description": "The ID of the job.", + "required": true, + "type": "string", + "location": "path" } - }, - "scopes": [ - "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", - "https://www.googleapis.com/auth/yt-analytics.readonly" - ], - "flatPath": "v1/jobs/{jobId}/reports", - "id": "youtubereporting.jobs.reports.list", - "path": "v1/jobs/{jobId}/reports" + } }, "get": { - "description": "Gets the metadata of a specific report.", "response": { "$ref": "Report" }, @@ -239,32 +208,33 @@ "reportId" ], "httpMethod": "GET", - "parameters": { - "reportId": { - "description": "The ID of the report to retrieve.", - "required": true, - "type": "string", - "location": "path" - }, - "jobId": { - "location": "path", - "description": "The ID of the job.", - "required": true, - "type": "string" - }, - "onBehalfOfContentOwner": { - "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", - "type": "string", - "location": "query" - } - }, "scopes": [ "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", "https://www.googleapis.com/auth/yt-analytics.readonly" ], + "parameters": { + "reportId": { + "location": "path", + "description": "The ID of the report to retrieve.", + "required": true, + "type": "string" + }, + "jobId": { + "description": "The ID of the job.", + "required": true, + "type": "string", + "location": "path" + }, + "onBehalfOfContentOwner": { + "location": "query", + "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", + "type": "string" + } + }, "flatPath": "v1/jobs/{jobId}/reports/{reportId}", "path": "v1/jobs/{jobId}/reports/{reportId}", - "id": "youtubereporting.jobs.reports.get" + "id": "youtubereporting.jobs.reports.get", + "description": "Gets the metadata of a specific report." } } } @@ -273,17 +243,22 @@ "reportTypes": { "methods": { "list": { - "description": "Lists report types.", "response": { "$ref": "ListReportTypesResponse" }, "parameterOrder": [], "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", - "https://www.googleapis.com/auth/yt-analytics.readonly" - ], "parameters": { + "pageToken": { + "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.", + "type": "string", + "location": "query" + }, + "includeSystemManaged": { + "location": "query", + "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.", + "type": "boolean" + }, "pageSize": { "location": "query", "description": "Requested page size. Server may return fewer report types than requested.\nIf unspecified, server will pick an appropriate default.", @@ -294,60 +269,92 @@ "location": "query", "description": "The content owner's external ID on which behalf the user is acting on. If\nnot set, the user is acting for himself (his own channel).", "type": "string" - }, - "pageToken": { - "description": "A token identifying a page of results the server should return. Typically,\nthis is the value of\nListReportTypesResponse.next_page_token\nreturned in response to the previous call to the `ListReportTypes` method.", - "type": "string", - "location": "query" - }, - "includeSystemManaged": { - "location": "query", - "description": "If set to true, also system-managed report types will be returned;\notherwise only the report types that can be used to create new reporting\njobs will be returned.", - "type": "boolean" } }, + "scopes": [ + "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", + "https://www.googleapis.com/auth/yt-analytics.readonly" + ], "flatPath": "v1/reportTypes", "path": "v1/reportTypes", - "id": "youtubereporting.reportTypes.list" + "id": "youtubereporting.reportTypes.list", + "description": "Lists report types." + } + } + }, + "media": { + "methods": { + "download": { + "description": "Method for media download. Download is supported\non the URI `/v1/media/{+name}?alt=media`.", + "supportsMediaDownload": true, + "httpMethod": "GET", + "parameterOrder": [ + "resourceName" + ], + "response": { + "$ref": "GdataMedia" + }, + "parameters": { + "resourceName": { + "location": "path", + "description": "Name of the media that is being downloaded.", + "required": true, + "type": "string", + "pattern": "^.+$" + } + }, + "scopes": [ + "https://www.googleapis.com/auth/yt-analytics-monetary.readonly", + "https://www.googleapis.com/auth/yt-analytics.readonly" + ], + "flatPath": "v1/media/{mediaId}", + "id": "youtubereporting.media.download", + "path": "v1/media/{+resourceName}" } } } }, "parameters": { + "upload_protocol": { + "location": "query", + "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "type": "string" + }, + "prettyPrint": { + "location": "query", + "description": "Returns response with indentations and line breaks.", + "type": "boolean", + "default": "true" + }, "uploadType": { + "location": "query", "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", - "type": "string", - "location": "query" + "type": "string" }, "fields": { "location": "query", "description": "Selector specifying which fields to include in a partial response.", "type": "string" }, - "callback": { - "description": "JSONP", - "type": "string", - "location": "query" - }, "$.xgafv": { - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ], - "location": "query", "enum": [ "1", "2" ], "description": "V1 error format.", - "type": "string" + "type": "string", + "enumDescriptions": [ + "v1 error format", + "v2 error format" + ], + "location": "query" + }, + "callback": { + "description": "JSONP", + "type": "string", + "location": "query" }, "alt": { - "enum": [ - "json", - "media", - "proto" - ], "type": "string", "enumDescriptions": [ "Responses with Content-Type of application/json", @@ -356,7 +363,12 @@ ], "location": "query", "description": "Data format for response.", - "default": "json" + "default": "json", + "enum": [ + "json", + "media", + "proto" + ] }, "key": { "location": "query", @@ -369,9 +381,9 @@ "type": "string" }, "quotaUser": { + "location": "query", "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.", - "type": "string", - "location": "query" + "type": "string" }, "pp": { "location": "query", @@ -379,29 +391,223 @@ "type": "boolean", "default": "true" }, - "bearer_token": { - "location": "query", - "description": "OAuth bearer token.", - "type": "string" - }, "oauth_token": { "description": "OAuth 2.0 token for the current user.", "type": "string", "location": "query" }, - "upload_protocol": { - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", + "bearer_token": { + "description": "OAuth bearer token.", "type": "string", "location": "query" - }, - "prettyPrint": { - "description": "Returns response with indentations and line breaks.", - "type": "boolean", - "default": "true", - "location": "query" } }, "schemas": { + "GdataDiffUploadRequest": { + "description": "gdata", + "type": "object", + "properties": { + "objectVersion": { + "description": "gdata", + "type": "string" + }, + "objectInfo": { + "$ref": "GdataCompositeMedia", + "description": "gdata" + }, + "checksumsInfo": { + "$ref": "GdataCompositeMedia", + "description": "gdata" + } + }, + "id": "GdataDiffUploadRequest" + }, + "GdataBlobstore2Info": { + "description": "gdata", + "type": "object", + "properties": { + "uploadMetadataContainer": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "blobGeneration": { + "description": "gdata", + "format": "int64", + "type": "string" + }, + "blobId": { + "description": "gdata", + "type": "string" + }, + "downloadReadHandle": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "readToken": { + "description": "gdata", + "type": "string" + } + }, + "id": "GdataBlobstore2Info" + }, + "ListReportTypesResponse": { + "description": "Response message for ReportingService.ListReportTypes.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.", + "type": "string" + }, + "reportTypes": { + "description": "The list of report types.", + "type": "array", + "items": { + "$ref": "ReportType" + } + } + }, + "id": "ListReportTypesResponse" + }, + "ReportType": { + "properties": { + "id": { + "description": "The ID of the report type (max. 100 characters).", + "type": "string" + }, + "systemManaged": { + "description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.", + "type": "boolean" + }, + "deprecateTime": { + "description": "The date/time when this report type was/will be deprecated.", + "format": "google-datetime", + "type": "string" + }, + "name": { + "description": "The name of the report type (max. 100 characters).", + "type": "string" + } + }, + "id": "ReportType", + "description": "A report type.", + "type": "object" + }, + "Empty": { + "properties": {}, + "id": "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 `{}`.", + "type": "object" + }, + "ListJobsResponse": { + "description": "Response message for ReportingService.ListJobs.", + "type": "object", + "properties": { + "nextPageToken": { + "description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.", + "type": "string" + }, + "jobs": { + "description": "The list of jobs.", + "type": "array", + "items": { + "$ref": "Job" + } + } + }, + "id": "ListJobsResponse" + }, + "GdataCompositeMedia": { + "description": "gdata", + "type": "object", + "properties": { + "md5Hash": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "inline": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "blobstore2Info": { + "$ref": "GdataBlobstore2Info", + "description": "gdata" + }, + "blobRef": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "objectId": { + "$ref": "GdataObjectId", + "description": "gdata" + }, + "crc32cHash": { + "description": "gdata", + "format": "uint32", + "type": "integer" + }, + "sha1Hash": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "path": { + "description": "gdata", + "type": "string" + }, + "length": { + "description": "gdata", + "format": "int64", + "type": "string" + }, + "cosmoBinaryReference": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "referenceType": { + "enumDescriptions": [ + "gdata", + "gdata", + "gdata", + "gdata", + "gdata" + ], + "enum": [ + "PATH", + "BLOB_REF", + "INLINE", + "BIGSTORE_REF", + "COSMO_BINARY_REFERENCE" + ], + "description": "gdata", + "type": "string" + } + }, + "id": "GdataCompositeMedia" + }, + "ListReportsResponse": { + "properties": { + "reports": { + "description": "The list of report types.", + "type": "array", + "items": { + "$ref": "Report" + } + }, + "nextPageToken": { + "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.", + "type": "string" + } + }, + "id": "ListReportsResponse", + "description": "Response message for ReportingService.ListReports.", + "type": "object" + }, "GdataContentTypeInfo": { "description": "gdata", "type": "object", @@ -433,21 +639,48 @@ "description": "gdata", "type": "object", "properties": { + "originalObject": { + "$ref": "GdataCompositeMedia", + "description": "gdata" + }, "objectVersion": { "description": "gdata", "type": "string" - }, - "originalObject": { - "description": "gdata", - "$ref": "GdataCompositeMedia" } }, "id": "GdataDiffUploadResponse" }, - "Report": { - "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.", + "GdataDiffChecksumsResponse": { + "description": "gdata", "type": "object", "properties": { + "objectVersion": { + "description": "gdata", + "type": "string" + }, + "chunkSizeBytes": { + "description": "gdata", + "format": "int64", + "type": "string" + }, + "checksumsLocation": { + "$ref": "GdataCompositeMedia", + "description": "gdata" + }, + "objectSizeBytes": { + "description": "gdata", + "format": "int64", + "type": "string" + }, + "objectLocation": { + "$ref": "GdataCompositeMedia", + "description": "gdata" + } + }, + "id": "GdataDiffChecksumsResponse" + }, + "Report": { + "properties": { "createTime": { "description": "The date/time when this report was created.", "format": "google-datetime", @@ -481,36 +714,9 @@ "type": "string" } }, - "id": "Report" - }, - "GdataDiffChecksumsResponse": { - "description": "gdata", - "type": "object", - "properties": { - "objectVersion": { - "description": "gdata", - "type": "string" - }, - "chunkSizeBytes": { - "description": "gdata", - "format": "int64", - "type": "string" - }, - "checksumsLocation": { - "$ref": "GdataCompositeMedia", - "description": "gdata" - }, - "objectSizeBytes": { - "description": "gdata", - "format": "int64", - "type": "string" - }, - "objectLocation": { - "description": "gdata", - "$ref": "GdataCompositeMedia" - } - }, - "id": "GdataDiffChecksumsResponse" + "id": "Report", + "description": "A report's metadata including the URL from which the report itself can be\ndownloaded.", + "type": "object" }, "GdataDownloadParameters": { "description": "gdata", @@ -549,25 +755,19 @@ "description": "The name of the job (max. 100 characters).", "type": "string" }, - "systemManaged": { - "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.", - "type": "boolean" - }, "id": { "description": "The server-generated ID of the job (max. 40 characters).", "type": "string" + }, + "systemManaged": { + "description": "True if this a system-managed job that cannot be modified by the user;\notherwise false.", + "type": "boolean" } }, "id": "Job" }, "GdataObjectId": { - "description": "gdata", - "type": "object", "properties": { - "bucketName": { - "description": "gdata", - "type": "string" - }, "generation": { "description": "gdata", "format": "int64", @@ -576,139 +776,21 @@ "objectName": { "description": "gdata", "type": "string" + }, + "bucketName": { + "description": "gdata", + "type": "string" } }, - "id": "GdataObjectId" + "id": "GdataObjectId", + "description": "gdata", + "type": "object" }, "GdataMedia": { - "description": "gdata", - "type": "object", "properties": { - "blobstore2Info": { - "description": "gdata", - "$ref": "GdataBlobstore2Info" - }, - "filename": { - "description": "gdata", - "type": "string" - }, - "hashVerified": { - "description": "gdata", - "type": "boolean" - }, - "diffDownloadResponse": { - "$ref": "GdataDiffDownloadResponse", - "description": "gdata" - }, - "cosmoBinaryReference": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "isPotentialRetry": { - "description": "gdata", - "type": "boolean" - }, - "md5Hash": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "sha256Hash": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "algorithm": { - "description": "gdata", - "type": "string" - }, - "objectId": { - "$ref": "GdataObjectId", - "description": "gdata" - }, - "path": { - "description": "gdata", - "type": "string" - }, - "bigstoreObjectRef": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "referenceType": { - "enumDescriptions": [ - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata", - "gdata" - ], - "enum": [ - "PATH", - "BLOB_REF", - "INLINE", - "GET_MEDIA", - "COMPOSITE_MEDIA", - "BIGSTORE_REF", - "DIFF_VERSION_RESPONSE", - "DIFF_CHECKSUMS_RESPONSE", - "DIFF_DOWNLOAD_RESPONSE", - "DIFF_UPLOAD_REQUEST", - "DIFF_UPLOAD_RESPONSE", - "COSMO_BINARY_REFERENCE", - "ARBITRARY_BYTES" - ], - "description": "gdata", - "type": "string" - }, - "inline": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "diffUploadRequest": { - "$ref": "GdataDiffUploadRequest", - "description": "gdata" - }, - "diffChecksumsResponse": { - "description": "gdata", - "$ref": "GdataDiffChecksumsResponse" - }, - "crc32cHash": { - "description": "gdata", - "format": "uint32", - "type": "integer" - }, - "sha1Hash": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "length": { - "description": "gdata", - "format": "int64", - "type": "string" - }, - "contentTypeInfo": { - "description": "gdata", - "$ref": "GdataContentTypeInfo" - }, - "contentType": { - "description": "gdata", - "type": "string" - }, "downloadParameters": { - "description": "gdata", - "$ref": "GdataDownloadParameters" + "$ref": "GdataDownloadParameters", + "description": "gdata" }, "mediaId": { "description": "gdata", @@ -747,9 +829,133 @@ "hash": { "description": "gdata", "type": "string" + }, + "blobstore2Info": { + "$ref": "GdataBlobstore2Info", + "description": "gdata" + }, + "filename": { + "description": "gdata", + "type": "string" + }, + "hashVerified": { + "description": "gdata", + "type": "boolean" + }, + "diffDownloadResponse": { + "description": "gdata", + "$ref": "GdataDiffDownloadResponse" + }, + "cosmoBinaryReference": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "isPotentialRetry": { + "description": "gdata", + "type": "boolean" + }, + "md5Hash": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "sha256Hash": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "algorithm": { + "description": "gdata", + "type": "string" + }, + "objectId": { + "$ref": "GdataObjectId", + "description": "gdata" + }, + "path": { + "description": "gdata", + "type": "string" + }, + "bigstoreObjectRef": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "referenceType": { + "description": "gdata", + "type": "string", + "enumDescriptions": [ + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata", + "gdata" + ], + "enum": [ + "PATH", + "BLOB_REF", + "INLINE", + "GET_MEDIA", + "COMPOSITE_MEDIA", + "BIGSTORE_REF", + "DIFF_VERSION_RESPONSE", + "DIFF_CHECKSUMS_RESPONSE", + "DIFF_DOWNLOAD_RESPONSE", + "DIFF_UPLOAD_REQUEST", + "DIFF_UPLOAD_RESPONSE", + "COSMO_BINARY_REFERENCE", + "ARBITRARY_BYTES" + ] + }, + "inline": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "diffUploadRequest": { + "description": "gdata", + "$ref": "GdataDiffUploadRequest" + }, + "diffChecksumsResponse": { + "description": "gdata", + "$ref": "GdataDiffChecksumsResponse" + }, + "sha1Hash": { + "description": "gdata", + "format": "byte", + "type": "string" + }, + "crc32cHash": { + "description": "gdata", + "format": "uint32", + "type": "integer" + }, + "length": { + "description": "gdata", + "format": "int64", + "type": "string" + }, + "contentTypeInfo": { + "description": "gdata", + "$ref": "GdataContentTypeInfo" + }, + "contentType": { + "description": "gdata", + "type": "string" } }, - "id": "GdataMedia" + "id": "GdataMedia", + "description": "gdata", + "type": "object" }, "GdataDiffVersionResponse": { "description": "gdata", @@ -772,221 +978,16 @@ "type": "object", "properties": { "objectLocation": { - "$ref": "GdataCompositeMedia", - "description": "gdata" - } - }, - "id": "GdataDiffDownloadResponse" - }, - "GdataDiffUploadRequest": { - "description": "gdata", - "type": "object", - "properties": { - "checksumsInfo": { - "$ref": "GdataCompositeMedia", - "description": "gdata" - }, - "objectVersion": { - "description": "gdata", - "type": "string" - }, - "objectInfo": { "description": "gdata", "$ref": "GdataCompositeMedia" } }, - "id": "GdataDiffUploadRequest" - }, - "GdataBlobstore2Info": { - "description": "gdata", - "type": "object", - "properties": { - "downloadReadHandle": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "readToken": { - "description": "gdata", - "type": "string" - }, - "uploadMetadataContainer": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "blobGeneration": { - "description": "gdata", - "format": "int64", - "type": "string" - }, - "blobId": { - "description": "gdata", - "type": "string" - } - }, - "id": "GdataBlobstore2Info" - }, - "ListReportTypesResponse": { - "description": "Response message for ReportingService.ListReportTypes.", - "type": "object", - "properties": { - "reportTypes": { - "description": "The list of report types.", - "type": "array", - "items": { - "$ref": "ReportType" - } - }, - "nextPageToken": { - "description": "A token to retrieve next page of results.\nPass this value in the\nListReportTypesRequest.page_token\nfield in the subsequent call to `ListReportTypes` method to retrieve the next\npage of results.", - "type": "string" - } - }, - "id": "ListReportTypesResponse" - }, - "ReportType": { - "description": "A report type.", - "type": "object", - "properties": { - "deprecateTime": { - "description": "The date/time when this report type was/will be deprecated.", - "format": "google-datetime", - "type": "string" - }, - "name": { - "description": "The name of the report type (max. 100 characters).", - "type": "string" - }, - "id": { - "description": "The ID of the report type (max. 100 characters).", - "type": "string" - }, - "systemManaged": { - "description": "True if this a system-managed report type; otherwise false. Reporting jobs\nfor system-managed report types are created automatically and can thus not\nbe used in the `CreateJob` method.", - "type": "boolean" - } - }, - "id": "ReportType" - }, - "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 `{}`.", - "type": "object", - "properties": {}, - "id": "Empty" - }, - "ListJobsResponse": { - "description": "Response message for ReportingService.ListJobs.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A token to retrieve next page of results.\nPass this value in the\nListJobsRequest.page_token\nfield in the subsequent call to `ListJobs` method to retrieve the next\npage of results.", - "type": "string" - }, - "jobs": { - "description": "The list of jobs.", - "type": "array", - "items": { - "$ref": "Job" - } - } - }, - "id": "ListJobsResponse" - }, - "GdataCompositeMedia": { - "description": "gdata", - "type": "object", - "properties": { - "referenceType": { - "description": "gdata", - "type": "string", - "enumDescriptions": [ - "gdata", - "gdata", - "gdata", - "gdata", - "gdata" - ], - "enum": [ - "PATH", - "BLOB_REF", - "INLINE", - "BIGSTORE_REF", - "COSMO_BINARY_REFERENCE" - ] - }, - "md5Hash": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "inline": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "blobstore2Info": { - "description": "gdata", - "$ref": "GdataBlobstore2Info" - }, - "blobRef": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "objectId": { - "description": "gdata", - "$ref": "GdataObjectId" - }, - "crc32cHash": { - "description": "gdata", - "format": "uint32", - "type": "integer" - }, - "sha1Hash": { - "description": "gdata", - "format": "byte", - "type": "string" - }, - "path": { - "description": "gdata", - "type": "string" - }, - "length": { - "description": "gdata", - "format": "int64", - "type": "string" - }, - "cosmoBinaryReference": { - "description": "gdata", - "format": "byte", - "type": "string" - } - }, - "id": "GdataCompositeMedia" - }, - "ListReportsResponse": { - "description": "Response message for ReportingService.ListReports.", - "type": "object", - "properties": { - "nextPageToken": { - "description": "A token to retrieve next page of results.\nPass this value in the\nListReportsRequest.page_token\nfield in the subsequent call to `ListReports` method to retrieve the next\npage of results.", - "type": "string" - }, - "reports": { - "description": "The list of report types.", - "type": "array", - "items": { - "$ref": "Report" - } - } - }, - "id": "ListReportsResponse" + "id": "GdataDiffDownloadResponse" } }, "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" + "x16": "http://www.google.com/images/icons/product/search-16.gif", + "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "protocol": "rest", "version": "v1", @@ -1006,6 +1007,5 @@ }, "kind": "discovery#restDescription", "description": "Schedules reporting jobs containing your YouTube Analytics data and downloads the resulting bulk data reports in the form of CSV files.", - "servicePath": "", - "rootUrl": "https://youtubereporting.googleapis.com/" + "servicePath": "" }
diff --git a/youtubereporting/v1/youtubereporting-gen.go b/youtubereporting/v1/youtubereporting-gen.go index 5708858..bad9e98 100644 --- a/youtubereporting/v1/youtubereporting-gen.go +++ b/youtubereporting/v1/youtubereporting-gen.go
@@ -2116,7 +2116,7 @@ // ], // "parameters": { // "resourceName": { - // "description": "Name of the media that is being downloaded. See\nReadRequest.resource_name.", + // "description": "Name of the media that is being downloaded.", // "location": "path", // "pattern": "^.+$", // "required": true,